DULG

How to use the TocPlugin in the DULG web

The TocPlugin brings order into the DULG web. There are however a few things to remember:

• Each topic should start with a %SECTION0% tag. The actual placement in the hierarchy should be defined by indentation in the WebOrder topic.
• Each topic should have a unique name for referencing. Technically the name only has to be unique in a topic but in case we want to implement an export facility into a single HTML file one day, renaming should not be neccessary.
• To maintain editability of single topics they should not get too long. This consideration also helps in conforming to the next item in this list:
• Sub-topics can not span over topics right now. Let's consider an example:
  Contents of Topic1:

  %SECTION0{name=MainTopic}% Toplevel topic
  
  %SECTION1{name=SubTopic}% Subtopic in Topic1
  

  Contents of Topic2:

  %SECTION0{name=TopLevelTopic}% Toplevel in Topic2
  

  Contents of WebOrder:

     * Topic1
        * Topic2
  

  This construction will not work as expected because the Subtopic in Topic1 and the Toplevel in Topic2 are (implicitely by indentation in WebOrder) in the same topic hierarchy level and therefore this level spans across two topics.
  A possible cure for the situation is to move Subtopic in Topic1 to its own topic and include it in WebOrder at the same indentation as Topic2.
  This quirk is the reason for topics in the DULG web containing only a heading.

Whenever in doubt on how to use the %SECTION% tag, try to find a similar already existing part of the documentation and study its usage there. Remember that the TWiki search can search for tags, so searching for "%REF" finds usages of the %REF% tag. You might save some time doing this instead of going for the trial-and-error method.

-- DetlevZundel - 07 Aug 2003