Home Structuring Tables of contents Appendix
 The guide of UDO
 The syntax of UDO
 Structuring

Structuring Layers

UDO offers you four layers for structuring your documentation. These layers are called chapters, sections, subsections and paragraphs.

Using the command !node you tell UDO that a new chapter begins and you tell it how the chapter is named. The commands !subnode, !subsubnode and !subsubsubnode do the same for a section, subsection and paragraph. You can also use the commands !begin_node and !end_node to structure your documentation.

Da Bilder oft mehr sagen als tausend Worte, hier ein kleines Beispiel. Die (hier inhaltsleere) Befehlsfolge...

Watch this example (without text) to understand what I want to say:

!node          A chapter
!subnode       A section
!subsubnode    A subsection
!subsubsubnode A paragraph
!node          And a different chapter

The table of contents should look like this:

1  A chapter
   1.1  A section
        1.1.1  A subsection
               1.1.1.1  A Paragraph

2  And a different chapter

Windows Help and ST-Guide may display text in dialog boxes, too. These so called popup nodes can be used with the following commands:

Furthermore you can create chapters that don't appear in the table of contents. Use these commands...

Please note:

  1. Chapters that aren't listed in the table of contents aren't numbered, too. UDO will create hypertext links to them as it does for all other chapters.
     
  2. UDO enumerates the chapters automatically. If you want to display the chapter names without numbers you can use the switch !no_numbers inside the preamble.
     

Copyright © www.udo-open-source.org
Last updated on November 5, 2006

Home Structuring Tables of contents Appendix