Durch das Kommando !tableofcontents erzeugt UDO in der Ausgabedatei ein Inhaltsverzeichnis. In das Inhaltsverzeichnis gelangen alle Überschriften der Kapitel, Abschnitte und Unterabschnitte.
!tableofcontents sollte direkt nach !maketitle bzw. direkt nach !begin_document eingesetzt werden. UDO erlaubt zwar auch die Verwendung an anderer Stelle im Quelltext, jedoch ist dies nicht unproblematisch.
Der Umfang dieses Inhaltsverzeichnisses lässt sich durch den Schalter !toc beeinflussen. Wird dieser Schalter im Vorspann mit dem jeweiligen Kürzel des betroffenen Ausgabeformats angegeben, sorgt UDO dafür, dass ein entsprechend eingeschränktes Inhaltsverzeichnis ausgegeben wird.
Neben !tableofcontents gibt es die Befehle
!subtoc, !subsubtoc und
!subsubsubtoc, mit denen Sie alle einem Kapitel zugehörigen
Abschnitte bzw. alle einem Abschnitt zugehörigen Unterabschnitte usw.
in der Form eines kleinen Inhaltsverzeichnisses angeben können. Sinn
und Zweck dieser sogenannten Unterinhaltsverzeichnisse
ist es,
dem Leser eines Hypertextformates (ST-Guide, Pure-C-Hilfe, HTML,
WinHelp) das direkte Weiterlesen zu ermöglichen. Besonders beim
Einsatz von !tableofcontents !depth empfiehlt sich der Gebrauch dieser
Inhaltsverzeichnisse.
Die Ausgabe dieser Unterinhaltsverzeichnisse können Sie auch automatisieren, indem Sie im Vorspann die Schalter !use_auto_subtocs, !use_auto_subsubsubtocs und !use_auto_subsubtocs verwenden. Dann werden von UDO bei jedem Kapitel und Abschnitt automatisch Unterinhaltsverzeichnisse angelegt, in denen Sie den Inhalt eines Kapitels oder Abschnitts erkennen können.
Jedoch kann es sein, dass Sie gerne im ganzen Text genau diese Unterinhaltsverzeichnisse erzeugt haben möchten, bei einigen Kapiteln jedoch lieber darauf verzichten würden. Für diesen Zweck gibt es die Befehle !ignore_subtoc, !ignore_subsubtoc und !ignore_subsubsubtoc. Taucht in einem Kapitel !ignore_subtoc auf, wird in diesem Kapitel kein Unterinhaltsverzeichnis ausgegeben. Analog gilt dies für Abschnitte und !ignore_subsubtoc.
| !tableofcontents | Ausgabe des Inhaltsverzeichnisses auf einer eigenen Seite |
| !toc | Ausgabe des Inhaltsverzeichnisse im Text |
| !subtoc | Ausgabe aller Abschnitte eines Kapitels |
| !subsubtoc | Ausgabe aller Unterabschnitte eines Abschnitts |
| !subsubsubtoc | Ausgabe aller Paragraphen eines Unterabschnitts |
| !use_auto_subtocs | Bei jedem Kapitel automatisch alle zugehörigen Abschnitte auflisten |
| !use_auto_subsubtocs | Bei jedem Abschnitt automatisch alle zugehörigen Unterabschnitte auflisten |
| !use_auto_subsubsubtocs | Bei jedem Unterabschnitt alle zugehörigen Paragraphen auflisten |
| !ignore_subtoc | Im aktuellen Kapitel nicht die zugehörigen Abschnitte auflisten |
| !ignore_subsubtoc | Im aktuellen Abschnitt nicht die zugehörigen Unterabschnitte auflisten |
| !ignore_subsubsubtoc | Im aktuellen Unterabschnitt nicht die zugehörigen Paragraphen auflisten |
Hinweise: