1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
|
############################################################
# @(#) Verteilte Dokumente, Dirk Hagedorn, 25.10.1995
# 22.01.1996: !rinclude
############################################################
!subsubnode Verteilte Dokumente
!index !/include
!index !/vinclude
!index !/rinclude
UDO stellt Ihnen die Kommandos (!I)!/include(!i), (!I)!/vinclude(!i) und
(!I)!/rinclude(!i)
zur Verfgung, mit denen Sie die Mglichkeit erhalten, ein groes Dokument in
mehrere kleine Dateien aufzuteilen oder identische Passagen mehrfach
einzubinden.
(!I)!/include(!i) kann sowohl im Vorspann als auch im Hauptteil benutzt
werden. Dadurch besteht die Mglichkeit sowohl, Makros und
Trennvorschlge als auch Kapitel in externe Dateien auszulagern.
Um den Inhalt von Dateien als Klartext darstellen zu knnen, bedient man
sich des Kommandos (!I)!/vinclude(!i) (""verbatim include""). Tip: Das
Kommando (!I)!/vinclude(!i) eignet sich sehr gut, um Sourcecodes oder
Headerfiles darzustellen.
Falls man direkte Befehle fr ein Format nachladen mchte, so kann man sich
des Kommandos (!I)!/rinclude(!i) (""raw include"") bedienen. Tip: Dieser
Befehl eignet sich im Zusammenhang mit dem (!I)!/ifdest(!i)-Kommando dazu,
um z.B. spezielle (!LaTeX)-Tabellen oder HTML-Formulare einzubinden.
Diese Dokumentation macht brigens intensiven Gebrauch von diesen Mglichkeiten.
Die Datei ''(!V)udo.u(!v)'' enthlt lediglich wichtige Einstellungen und
etliche (!I)!/include(!i)-Kommandos, jedoch keine einzige Zeile
""sichtbaren"" Textes.
(!B)Mgliche Anwendungsgebiete:(!b)
!begin_enumerate
!item Bei umfangreichen Texten empfiehlt es sich, die Kapitel in
eigenen Dateien zu halten und von einer Hauptdatei mittels
(!I)!/include(!i) an passender Stelle einzubinden. Dies hat den
Vorteil, da man durch einfaches Verschieben des
(!I)!/include(!i)-Befehls dem Text eine neue Struktur geben zu knnen.
!item 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.
!item In Verbindung mit Makros kann man sich standardisierte Texte
erstellen, die man fr mehrere Programmbeschreibungen verwenden kann.
Z.B. tauchen in Programmdokumentationen immer wieder die Kapitel auf,
die sich mit dem Haftungsausschlu oder den Warenzeichen anderer
Produkte befassen.
!item 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 fat 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 gewhrleistet wird. Jedes Projektmitglied schreibt nun
seinen Artikel. Ist ein Artikel fertig, wird er dem Projektleiter zur
Verfgung gestellt. Dieser kann nun nach und nach das Magazin
komplettieren.
!index !/tabwidth
!item Mit (!I)!/vinclude(!i) lassen sich in Verbindung mit
(!I)!/tabwidth(!i) sehr leicht Sourcecodes oder Headerfiles darstellen,
falls man beispielsweise eine Library oder eine Programmiersprache
beschreiben mchte.
!end_enumerate
|