Merkmale eines Dokumentationskommandos bearbeiten

Zusammenhang

Für ein Dokumentationskommando können Sie die folgenden Merkmale ändern:

• Mehrseitige Grafiken in einseitige umwandeln: Bei mehrseitigen Diagrammen wird eine Grafik pro Seite erzeugt und jeweils eine Grafik auf einer Seite der generierten Dokumentation ausgegeben, ein Diagramm erscheint also evtl. auf mehrere Seiten verteilt. Mit dieser Option kann die Generierung einer einzigen Grafik erzwungen werden, die dann – entsprechend verkleinert – auf einer Seite ausgegeben wird.

• Nachbearbeitungskommando: Für die XML- und Word-Formate kann ein Kommando angegeben werden. Dieses wird zum Abschluss der Dokumentationserstellung automatisch ausgeführt, wobei in den Aufrufargumenten der Platzhalter $(INFILE) durch den Namen der Ausgabedatei ersetzt wird. Damit lässt sich dann z.B. Word oder eine andere Anwendung für die generierte Ausgabedatei aufrufen.

• Nachbearbeitungsargumente: Aufrufargumente für das Nachbearbeitungskommando.

• Unterdrücken aller leeren Kapitel: Bei gesetzter Option werden bei der Dokumentationserstellung alle leeren Modellelementaufzählungskapitel zu Modellbestandteilen unterdrückt. Normalerweise erscheinen für solche Kapitel zumindest die Überschrift und je ein Eintrag im Inhaltsverzeichnis und im Index der Dokumentation.

• Kapitelüberschriften in Spiegelstrichlisten wandeln: Ist diese Option auf Nie gesetzt, werden Modellelementaufzählungskapitel ohne Unterkapitel als Überschriften ausgegeben.

  Ist diese Option auf Dynamisch gesetzt, wird zusätzlich zur vorigen Option dieselbe Aktion auch für die Modellelementaufzählungskapitel ausgeführt, die zwar in der Dokumentationsstruktur Unterkapitel haben, jedoch aufgrund der modellierten Sachverhalte in dem Ergebnisdokument keine hätten.

• Ergebnisdatei öffnen: Hier können Sie festlegen, ob die Ergebnisdatei immer, nie oder nach Anfrage geöffnet werden soll.

  Achtung

  Im Voranzeigemodus wird das Ergebnis immer geöffnet.

  Wenn ein Nachbearbeitungskommando angegeben ist, wird diese Option nicht ausgewertet.

• Kleinstes gemeinsames Paket als Wurzel verwenden: Wenn die Dokumentationsstruktur den Hierarchiebaum oder Namensraumbaum verwendet, werden Modellbestandteile oberhalb des ersten gemeinsamen Vorgängers nicht in der Dokumentationsstruktur ausgegeben.

• Aktive Smart-Icons in Grafik ausgeben: In den Diagrammen werden die aktiven Smart-Icons ausgegeben.

• Dokumentationsauswahl: Die verwendete Dokumentationsauswahl.

• Besitzer: Das Profil, in dem das Dokumentationskommando liegt.

• XSL-Stylesheet-Prozessor: Das Kommando, das bei der HTML-Dokumentationsgenerierung verwendet wird.

  Hinweis

  Das Kommando wird durch die Parameter für den XSL-Stylesheet-Prozessor überschrieben, die Sie im Dialog Optionen im Register Dokumentation als modellübergreifende Benutzereinstellung festlegen.

Die folgenden Merkmale dienen zur Parametrierung der Dokumentation im MS-Word-Format:

• MS-Word Feld-Anweisung für Index: Die Feldanweisung, die für das Index-Feld verwendet wird.
• MS-Word Feld-Anweisung für Inhaltsverzeichnis: Die Feldanweisung, die für das Inhaltsverzeichnis-Feld verwendet wird.
• MS-Word Feld-Anweisung für Abbildungsverzeichnis: Die Feldanweisung, die für das Abbildungsverzeichnis-Feld verwendet wird.
• MS-Word Feld-Anweisung für Tabellenverzeichnis: Die Feldanweisung, die für das Tabellenverzeichnis-Feld verwendet wird.