Bevor wir ins Detail gehen, möchten wir Ihnen an dieser Stelle ein Beispiel eines kompletten Quelltextes zeigen, welches Ihnen auch dazu dienen kann, eigene Quelltexte mit UDO zu erstellen:
######################################## # @(#) UDO-Beispiel-Quelltext # @(#) Dirk Hagedorn, 08.04.1996 ######################################## !raw [stg] @subject "Dokumentation/Utilities" !docinfo [title] Ein !docinfo [program] UDO-Beispiel-Quelltext !docinfo [date] (!today) !docinfo [author] Dirk Hagedorn !use_auto_subtocs [info,html,stg,tvh,win,aqv] !use_auto_subsubtocs [info,html,stg,tvh,win,aqv] !no_effects [asc] !use_justification [asc] ######################################## !begin_document !maketitle !tableofcontents !node Automatische Formatierung UDO sorgt selber für die Formatierung des Quelltextes. Es nützt nichts, zwischen zwei Worte mehrere Leerzeichen einzufügen, da UDO selber für die richtigen Wortabstände und den Zeilenumbruch sorgt. Auch nützt es nichts, zwischen zwei Absätze mehrere Leerzeilen einzufügen. Auch hier greift UDO ein und trennt Absätze durch die ihm richtig erscheinende Anzahl von Leerzeilen. Absätze trennt man durch Leerzeilen oder UDO-Befehle. !node Ein Kapitel Dies ist der Text des Kapitels. Bei Hypertexten erfolgt aufgrund der im Vorspann gesetzten Schalter hier eine Auflistung aller diesem Kapitel zugehörigen Abschnitte und Unterabschnitte. !subnode Ein Abschnitt. Dies ist der Text des Abschnitts. Auch hier folgt ein Unterinhaltsverzeichnis. !subsubnode Ein Unterabschnitt. Dies ist der Text des Unterabschnitts. !end_document
Zu Beginn des Quelltextes ist ein Kommentar angegeben, damit Sie
später noch auf Anhieb erkennen können, womit sich der Text befasst.
Eine Zeile bewertet UDO als Kommantar, wenn das erste Zeichen der
Zeile ein #
ist.
Es folgt eine spezielle Zeile für den ST-Guide. Hier wird dem ST-Guide mitgeteilt, in welche Rubrik der Hypertext in den Katalog einzuordnen ist. Kennen Sie sich nicht mit dem ST-Guide aus, verwenden Sie einfach diese Zeile zu Beginn Ihres Quelltextes.
Nun werden die Informationen für die Titelseite und die
Kopfzeilen gesetzt, die bei einigen Formaten automatische erzeugt
werden. !docinfo [title] und !docinfo [program] bilden
eine Einheit, daher sollte beides zusammengenommen einen Sinn ergeben.
Hier würde bei einigen Formaten in den Kopfzeilen Ein
UDO-Bespiel-Quelltext
ausgegeben. Bei !docinfo [date] wird
der Platzhalter (!today) durch das aktuelle Systemdatum
expandiert. Sie können natürlich auch manuell für die Angabe des
Datums sorgen (z.B. mit !docinfo [date]
31. Dezember 1999
).
Im Vorspann werden nun noch einige Schalter gesetzt. Die ersten
beiden Schalter sorgen bei Hypertexten, deren Kürzel Sie in den
eckigen Klammern erkennen, für die Ausgabe sogenannter
Unterinhaltsverzeichnisse
. In diesen werden dann alle
Abschnitte und Unterabschnitte eines Kapitels bzw. alle
Unterabschnitte eines Abschnittes in Form eines Inhaltsverzeichnisses
aufgelistet. Dem Leser eines Hypertextes wird es dadurch ermöglicht,
direkt zu den zugehörigen Abschnitten weiterzuklicken. Theoretische
wäre es auch möglich, bei jedem Kapitel durch die Angabe des Befehls
!subtoc bzw. bei jedem Abschnitt durch die Angabe des
Befehls !subsubtoc diese Unterinhaltsverzeichnisse
einzufügen. Bei kleineren Texten empfiehlt es sich jedoch, diese
Ausgabe zu automatisieren.
Der Schalter !no_effects [asc] sorgt für die Unterdrückung der Schriftarten für das ASCII-Format. Würde dieser Schalter nicht angegeben, würde UDO beim ASCII-Format die in der DFÜ gebräuchlichen Zeichen zur Schriftartumschaltung benutzen.
Der Schalter !use_justification [asc,stg] sorgt dafür, dass UDO beim ASCII- und ST-Guide-Format Blocksatz erzeugt.
Das Kommando !begin_document teilt UDO mit, dass nun der Hauptteil des Quelltextes beginnt. Dieses Kommando darf in keinem Quelltext fehlen, da hier unverzichtbare Informationen für die Ausgabeformate ausgegeben werden!
Zu Anfang geben wir eine Titelseite aus, die aus den Informationen aus der im oberen Teil des Vorspanns gebildet wird. Das Kommando !maketitle sollte – wenn es benutzt wird – direkt hinter !begin_document angegeben werden. UDO erlaubt zwar auch den Einsatz an späterer Stelle, jedoch ist dies weder sinnvoll noch unproblematisch.
Danach möchten wir, dass UDO ein Inhaltsverzeichnis ausgibt. In diesem sind alle Kapitel, Abschnitte und Unterabschnitte des Quelltextes aufgelistet. Das oben Gesagte gilt auch hier. Wird der Befehl !tableofcontents benutzt, sollte er direkt hinter !maketitle oder (bei Verzicht auf die Ausgabe der Titelseite) hinter !begin_document angegeben werden.
Endlich! Nach dem ganzen Vorgeplänkel beginnen wir mit dem Befehl !node das erste Kapitel. Beachten Sie bitte auch den Inhalt dieses Kapitels, da er weitere Informationen enthält.
Die folgenden Zeilen demonstrieren, wie Sie Kapitel, Abschnitte und Unterabschnitte erzeugen. Auch hier sollten Sie einen Blick auf den Text werfen.
Unser Quelltext ist nun beendet. Dies zeigen wir UDO mit dem Befehl !end_document an. Auch dieser Befehl darf in keinem Quelltext fehlen!