Verteilte Dokumente

UDO stellt Ihnen die Kommandos !include, !input, !vinclude und !rinclude zur Verfügung, mit denen Sie die Möglichkeit haben, 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, nutzen Sie das Kommando !vinclude (verbatim include).

(TIP) Das Kommando !vinclude eignet sich sehr gut, um Sourcecode oder Header-Dateien darzustellen.

Falls Sie direkte Befehle für ein Format nachladen möchten, können Sie sich des Kommandos !rinclude (raw include) bedienen.

Tipp: Dieser Befehl eignet sich im Zusammenhang mit dem !ifdest-Kommando dazu, um z.B. spezielle LaTeX-Tabellen oder HTML-Formulare einzubinden.

Dieses UDO-Handbuch macht übrigens intensiven Gebrauch von diesen Möglichkeiten. Die Hauptdatei manual.u enthält nur wichtige Einstellungen und etliche !include-Kommandos, jedoch keine einzige Zeile sichtbaren Textes.

Mögliche Anwendungsgebiete:

1. 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 Sie durch einfaches Verschieben des !include-Befehls dem Text eine neue Struktur geben können.
2. Teilen Sie 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, können Sie sofort sehen, wie UDO das zuletzt bearbeitete Kapitel umwandelt.
3. In Verbindung mit Makros können Sie sich standardisierte Texte erstellen, die Sie für mehrere Programmbeschreibungen verwenden können. Z.B. tauchen in Programmdokumentationen immer wieder die Kapitel auf, die sich mit dem Haftungsausschluss oder den Warenzeichen anderer Produkte befassen.
4. 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.
5. Mit !vinclude lassen sich in Verbindung mit !tabwidth sehr leicht Sourcecodes oder Header-Dateien darstellen, falls Sie beispielsweise eine Library oder eine Programmiersprache beschreiben möchten.

Achtung: Vermeiden Sie Konstruktionen wie diese, die zu Endlos-Schleifen führen:

oder auch

UDO kann derartige Über-Kreuz-Verweise nicht abfangen und liefert als Fehlermeldung nur memory allocation failed.