Die Anleitung zu UDO

Die UDO-Syntax


Verschiedenes
UDO stellt Ihnen die Kommandos !include, !input,
!vinclude und !rinclude zur Verfügung, mit denen Sie
die Möglichkeit erhalten, ein großes Dokument in mehrere
kleine Dateien aufzuteilen oder identische Passagen mehrfach
einzubinden.
!include kann sowohl im Vorspann als auch im Hauptteil
benutzt werden. Dadurch besteht die Möglichkeit, sowohl Makros
und Trennvorschläge als auch Kapitel in externe Dateien
auszulagern.
Um den Inhalt von Dateien als Klartext darstellen zu können,
bedient man sich des Kommandos !vinclude ("verbatim
include"). Tip: Das Kommando !vinclude eignet sich sehr
gut, um Sourcecodes oder Headerfiles darzustellen.
Falls man direkte Befehle für ein Format nachladen
möchte, so kann man sich des Kommandos !rinclude ("raw
include") bedienen. Tip: Dieser Befehl eignet sich im
Zusammenhang mit dem !ifdest-Kommando dazu, um z.B. spezielle
LaTeX-Tabellen oder HTML-Formulare einzubinden.
Diese Dokumentation macht übrigens intensiven Gebrauch von
diesen Möglichkeiten. Die Datei `udo.u' enthält
lediglich wichtige Einstellungen und etliche
!include-Kommandos, jedoch keine einzige Zeile
"sichtbaren" Textes.
Mögliche Anwendungsgebiete:
- Bei umfangreichen Texten empfiehlt es sich, die Kapitel in
eigenen Dateien zu halten und von einer Hauptdatei mittels
!include an passender Stelle einzubinden. Dies hat den Vorteil,
dass man durch einfaches Verschieben des !include-Befehls dem
Text eine neue Struktur geben zu können.
- Teilt man Texte in mehrere Dateien auf, die von einer
Hauptdatei nachgeladen werden, kann dies die Fehlersuche erheblich
beschleunigen. Durch auskommentieren der Zeilen, die bereits korrekte
Kapitel einladen, kann man sofort sehen, wie UDO das zuletzt
bearbeitete Kapitel umwandelt.
- In Verbindung mit Makros kann man sich standardisierte Texte
erstellen, die man für mehrere Programmbeschreibungen verwenden
kann. Z.B. tauchen in Programmdokumentationen immer wieder die Kapitel
auf, die sich mit dem Haftungsausschluss oder den Warenzeichen anderer
Produkte befassen.
- Beim Schreiben eines Textes kann die Arbeit auf beliebig viele
Personen aufgeteilt werden. Jeder Autor kann dann in aller Ruhe seine
Texte bearbeiten und austesten. Erst kurz vor Vollendung des
Gesamtwerks fasst ein Projektleiter alle Texte zu einem zusammen.
UDO wird beispielsweise dazu eingesetzt, ein
Online-Computermagazin zu erstellen. Der Projektleiter gibt Vorgaben,
wie das Layout der einzelnen Artikel auszusehen hat, damit ein
einheitliches Erscheinungsbild gewährleistet wird. Jedes
Projektmitglied schreibt nun seinen Artikel. Ist ein Artikel fertig,
wird er dem Projektleiter zur Verfügung gestellt. Dieser kann nun
nach und nach das Magazin komplettieren.
- Mit !vinclude lassen sich in Verbindung mit
!tabwidth sehr leicht Sourcecodes oder Headerfiles darstellen,
falls man beispielsweise eine Library oder eine Programmiersprache
beschreiben möchte.
Achtung: Vermeiden Sie Konstruktionen wie
oder auch
die zu Endlos-Schleifen führen!
UDO kann derartige Über-Kreuz-Verweise nicht abfangen und
liefert als Fehlermeldung lediglich "memory allocation
failed".
Copyright © www.udo-open-source.org
Letzte Aktualisierung am 5. November 2006