Hinzufügen von Abschnitten

Dieses Thema beschreibt, wie Sie Ihre Themen in logische Abschnitte wie zB Beispiele, Listen von weiterführenden Themen und Anmerkungen unterteilen können.

In Doc-O-Matic werden diese Teile Abschnitte genannt. Jeder Abschnitt hat eine bestimmte Bedeutung in Ihrem Text (zum Beispiel eine Zusammenfassung, Bemerkungen, Notizen, Parameter-Beschreibungen oder die Version des Programmes, das Sie dokumentieren). Abschnitte bestehen üblicherweise aus einer Überschrift und Text.

Wenn Sie im Editor Text schreiben ohne einen bestimmten Abschnitt zu wählen, schreiben Sie Text für den Standardabschnitt. In der Standardeinstellung ist der Abschnitt description der Standardabschnitt.

Doc-O-Matic stellt 22 vordefinierte Abschnitte und 12 verschiedene Abschnittstypen und 16 Abschnittstypen, die für verschieden Funktionen zur automatischen Dokumentation (AutoDoc) zur Verfügung.

Um einen Abschnitt hinzuzufügen

Es gibt zwei Möglichkeiten, wie Sie Abschnitte zu einem Thema hinzufügen können. Sie können:
- im Menüband in der Gruppe Sections auf Append Section klicken oder im kontextbezogenen Menü auf Append Section klicken, um den Abschnitt am Ende des aktuellen Themas hinzufügen.
- im Menüband in der Gruppe Sections auf Insert Section oder im kontextbezogenen Menü auf Insert Section klicken, um den Abschnitt im aktuellen Absatz hinzufügen.
Wählen Sie aus dem Menü den Abschnitt den Sie hinzufügen möchten. Abschnitte, die Sie im aktuellen Thema schon verwendet haben, werden als letzte Einträge im Menü angezeigt.
Fügen Sie Text zu dem Abschnitt, den Sie hinzugefügt haben.

Hinweise

Ein Abschnitt in einem bestimmten Thema wird immer als ein Textblock wiedergegeben. Wenn Sie einen Abschnitt in einem Thema zweimal verwenden, werden die zwei Teile zusammengefasst. Einzige Ausnahme von dieser Regel sind Abschnitte vom Typ Additional Information (zum Beispiel der Abschnitt Beispiel). Diese Abschnitte können mehrmals in jedem Thema verwendet werden.

Reihung und Formatierung der Abschnitte im Editor und in der Ausgabe

Abschnitte, die Sie im Editor eingeben werden auf eine spezifische Weise angezeigt, in der Ausgabe werden Sie jedoch in anderer Art und Weise dargestellt. Sie können alle Abschnitte getrennt in allen Ausgabeformaten an Ihre Bedürfnisse anpassen.

	Im Editor	In der Ausgabe	Zusätzliche Funktionen in HTML
Überschriften	Name des Abschnittes wird als Überschrift angezeigt.	Name des Abschnittes wird als Überschrift angezeigt. Abschnittsnamen werden weggelassen. Abschnittsnamen werden als Überschrift angezeigt, es sei denn der Abschnitt ist der erste Abschnitt des Themas. Die erste Überschrift in einem Abschnitt vom Typ Zusätzliche Information oder Benannter Abschnitt wird als Überschrift angezeigt. Grafiken werden zusätzlich oder als einzige Überschrift angezeigt.	Abschnitte können aufgeklappt werden. Hyperlinks zu Überschriften werden unter dem Titel angezeigt. Registerbezeichnungen werden als Überschrift vor den Registerabschnitten angezeigt.
Reihung der Abschnitte	Standardeinstellung: Abschnitte werden in der Reihenfolge, in der Sie eingegeben werden angezeigt. Option Definition in der Application Option Editor: Abschnitte werden in der Reihenfolge, in der Sie auf der Seite Sections auftauchen, angezeigt.	Abschnitte werden in der Reihenfolge, die auf der Seite Section Appearance bestimmt wird, angezeigt.	Abschnitte vom Typ Zusätzliche Information Navigation, Klassenhierarchie und Body- Source werden auf einer eigenen Seite angezeigt. Abschnitte können in einem Popup-Fenster angezeigt werden.

Für fortgeschrittene Benutzer

Doc-O-Matic kann automatisch Zusammenfassungen erstellen. Diese Option kann auf der Seite Automatischer Abschnitt aktiviert werden. Abschnitte können als Bedingungstext verwendet werden. Wenn Sie verschiedene Arten von Dokumentation von nur einem Projekt erzeugen möchten können Sie spezielle Abschnitte (zum Beispiel "Firmenversion") erstellen und die Ausgabe dieses Abschnittes in der jeweils anderen Dokumentation verhindern. Weitere Informationen finden Sie in Wie kann ich unterschiedliche Dokumentationen aus einer Quelle erzeugen?.

Siehe auch

Vordefinierte Abschnitte und Abschnittstypen, Erstellen und Bearbeiten von Abschnitten, Umbenennen von Abschnitten, Wie sehen Abschnitte aus?