Home Allgemeine Tips & Tricks Allgemeine Tips & Tricks Verwenden Sie standardisierte Quelltexte

Zerteilen Sie große Dokumentationen

Falls Sie eine Dokumentation schreiben, die einen Umfang von 30 KB oder mehr hat, so sollten Sie sie in kleine Häppchen aufteilen. Diese Dateien können dann mit dem !include an passender Stelle eingeladen werden.

Durch die Aufteilung haben Sie den Vorteil, daß Sie die Dokumentation durch einfaches Verschieben nur einer einzigen Zeile neu gliedern können. Wäre der gesamte Quelltext in einer Datei, müßten Sie mit einem Editor gleich ganze Blöcke umkopieren.

Ein weiterer Vorteil der Aufteilung ist, daß Sie bestimmte Kapitel schnell wiederfinden können, sofern Sie den Dateien sinnvolle Namen geben.

Außerdem können Sie leicht und schnell nur Teile der Dokumentation auf syntaktische Korrektheit testen. Nehmen wir an, wir haben einen Quelltext mit fünf Kapiteln. Erstellen Sie eine Datei mit den globalen Schaltern, eine Hauptdatei und fünf Dateien mit dem Kapiteltext:

[haupt.u]
!include header.ui
!begin_document
!maketitle
!tableofcontents
!include kapitel1.ui
!include kapitel2.ui
!include kapitel3.ui
!include kapitel4.ui
!include kapitel5.ui
!end_document

[header.ui]
!title ...
!program ...
!author ...

[kapitel1.ui]
!node Kapitel 1
...

[kapitel2.ui]
!node Kapitel 2
...

[usw]

Falls Sie nun einmal nur ein Kapitel umwandeln wollen, erstellen Sie ganz einfach eine zusätzliche Hauptdatei, die Sie dann umwandeln:

[kap5test.u]
!include header.ui
!begin_document
!maketitle
!tableofcontents
!include kapitel5.ui
!end_document

Gerade bei sehr umfangreichen Dokumentationen kann man die Fehlersuche und -korrektur drastisch beschleuingen.

Falls Sie sich mal ein Bild davon machen wollen, wie so eine Aufteilung aussehen kann, dann schauen Sie sich einmal die Quelltexte dieser UDO-Dokumentation an. Stünde diese Dokumentation in einer Datei, hätte ich schon längst den Überblick verloren.


Home Allgemeine Tips & Tricks Allgemeine Tips & Tricks Verwenden Sie standardisierte Quelltexte