Die Dokumentationsgenerierung erfolgt durch Aufruf eines Dokumentationskommandos, das Informationen über das Ausgabeformat, die Struktur der Dokumentation sowie weitere Layoutelemente enthält.
Die wichtigsten Bestandteile der Dokumentationsgenerierung sind Dokumentationsstrukturen, Dokumentationsauswahlen und Dokumentationskommandos. Dabei kann eine Dokumentationsstruktur von mehreren Dokumentationsauswahlen benutzt werden, die jeweils von mehreren Dokumentationskommandos verwendet werden können. Durch diese Trennung ist es möglich, quasi identische Dokumentationen in unterschiedlichen Ausgabeformaten zu erstellen oder eine Dokumentationsstruktur einmal mit englischer und dann mit deutscher Titelseite zu erstellen.
Weiterhin wird der Inhalt der Dokumentation durch die Selektion im Modell beim Start der Dokumentationsgenerierung bestimmt.
Sie können eine Dokumentation unter Verwendung eines Assistenten erstellen.
Dokumentationsstrukturen
In einer Dokumentationsstruktur legen Sie fest, welche Informationen an welcher Stelle der Dokumentation ausgegeben werden.
Um eine Dokumentationsstruktur nutzen zu können, müssen Sie dieser eine Dokumentationsauswahl und ein Dokumentationskommando zuordnen.
Dokumentationsauswahl
In der Dokumentationsauswahl sind Informationen zum Layout der Dokumentation hinterlegt. Im Einzelnen handelt es sich um die folgenden Informationen:
- verwendete Dokumentationsstruktur
- Titelseite der Dokumentation
- Kopf- und Fußzeilen
Dokumentationskommandos
Dokumentationskommandos sind die Schnittstelle zum Anwender, die Sie aufrufen, um eine Dokumentation zu generieren. Beim Konfigurieren eines Dokumentationskommandos legen Sie u.a. das Ausgabe- und Grafikformat, den Namen der Ausgabedatei und verschiedene Generierungsoptionen fest.
Verwandte Themen
