1.2.1 Der UDO-Vorspann

Im Vorspann legt man gewisse Parameter fest, die für das gesamte Dokument (auch eingebundene Texte; mehr dazu unten) gültig sind. Sehen wir uns mal einen solchen Vorspann an. Zunächst einmal komplett, dann mit entsprechenden Erklärungen:

   !code [tos]
   !docinfo [title] UDO-Testbericht
   !docinfo [version] 1.0
   !docinfo [date] (!today)
   !docinfo [author] Tobias Jung

   !parwidth 75

   !html_backpage ../start.htm

   !use_auto_toptocs [stg,html,win,wh4]
   !use_auto_subtocs [stg,html,win,wh4]
   !no_numbers [stg]

   !begin_document
   !maketitle
   !tableofcontents [all]
   !include udointro.ui
   ...
   ...
   !end_document

So, nun klären wir mal, was diese ganzen Kommandos im Einzelnen zu bedeuten haben:

!code [tos]
Der Text wird auf einem Atari-Rechner geschrieben und gesichert. Diese Angabe braucht UDO für eine korrekte Wandlung der Umlaute und anderen Sonderzeichen.

!docinfo [title] UDO-Testbericht
Unschwer zu erraten: Der Titel des Dokuments...

!docinfo [version] 1.0
... und die Version.

!docinfo [date] (!today)
Das aktuelle Datum wird eingesetzt...

!docinfo [author] Tobias Jung
... und der Autor bin ich.

!parwidth 75
Maximale Zeilenlänge: 75 Zeichen. Darauf kommen wir noch zurück.

!html_backpage ../start.htm
Ein HTML-Spezialbefehl. Mehr darüber im Kapitel UDO und HTML.

!use_auto_toptocs [stg,html,win,wh4]
Für die Exportformate ST-Guide, HTML, WinHelp und WinHelp4 wird eine Kopfzeile erzeugt, die Links auf die übergeordneten Kapitel bereitstellt.

!use_auto_subtocs [stg,html,win,wh4]
Für die gleichen Formate wird am Ende eines Kapitels eine kleines Inhaltsverzeichnis erzeugt, das die untergeordneten Kapitel aufführt.

!no_numbers [stg]
Für ST-Guide wird die automatische Kapitelnumerierung unterdrückt.

!begin_document
Jetzt geht's los: Der Vorspann ist beendet; der Hauptteil beginnt.

!maketitle
UDO soll eine Titelseite erzeugen.

!tableofcontents [all]
In allen Exportformaten wird ein Inhaltsverzeichnis angelegt.

!include udointro.ui
Die Datei udointro.ui wird eingebunden. Mehr darüber unten. Beliebig viele weitere !include-Befehle können folgen.

!end_document
Und ganz am Schluß muß man UDO auch noch mitteilen, daß das Dokument zueende ist.

Wenn man oft mit UDO arbeitet, ist es natürlich ratsam, sich einen "Standard-Vorspann" zu erstellen, den man dann in jedes neue Dokument einfügt. Damit kein Mißverständnis entsteht: Dieser Vorspann wird in jedem UDO-Dokument nur einmal benötigt; mittels "!include" eingebundene Dateien brauchen keinen eigenen Vorspann.

Damit sind wir auch schon bei einer wesentliche Funktion von UDO: Ein Gesamtdokument kann in viele Einzeldateien aufgesplittet werden. Das erspart dem Anwender nicht nur das Bearbeiten von Mammut-Dateien, sondern ermöglicht auch eine einfache Kapitelverwaltung. Wenn Ihr also in einem fertigen Dokument zwei Kapitel vertauschen möchtet, reicht es, die Reihenfolge der "!include"-Befehle zu ändern. Bei der nächsten Übersetzung kümmert sich UDO dann um die korrekte neue Numerierung und das Setzen von "Vorhergehende/Nächste Seite"- Links in HTML-Dokumenten.

Auch im Vorspann kann sich "!include" als nützlich erweisen: Wie gesagt, könnt Ihr über Definitionen eigene UDO-Befehle schreiben. Dieses werdet Ihr sicher in allen UDO-Dokumenten nutzen wollen. Also schreibt man sich eine Datei, die die notwendigen Definitionen enthält und bindet sie im Vorspann jeden neuen Dokumentes ein: Schon kann man auch hier auf die selbstgeschriebenen Befehle zurückgreifen.

Sehen wir uns mal eine solche Definition an.