Oberhalb eines oder mehrerer Dokumentationskapitel können Sie ein zusätzliche Gliederungskapitel anlegen.
Voraussetzungen
Es muss mindestens ein Kapitel einer Dokumentationsstruktur selektiert sein. Wenn mehrere Kapitel selektiert sind, müssen alle direkt unterhalb desselben Kapitels liegen.
Zusammenhang
Die Dokumentationsstruktur wird um eine zusätzliche Überschrift erweitert und/oder mit einem Sortierungstyp für unmittelbar nachfolgende Standardkapitel versorgt.
Eine Sortierung ist nach dem angezeigten Namen bzw. der Überschrift, Label oder Stereotypeigenschaft jeweils alphabetisch und für Label und Stereotypeigenschaft auch numerisch möglich. Das ausgewertete Label bzw. die Stereotypeigenschaft muss über einen entsprechenden Filtereintrag festgelegt werden. Zusätzlich ist auch die Umkehrung des Sortierungstyps möglich.
Die Sortierung wirkt sich immer nur direkt auf die nächste Ebene aus. Dabei darf diese Ebene nicht bereits über ein Modellelementaufzählungskapitel oder ein weiteres Gliederungskapitel sortiert sein.
In Tabellen kann auf diese Weise nach einer Spalte sortiert werden. Sortiert wird nur nach der ersten Spalte mit einem eingestellten Sortierungstyp. Die Aufzählungsspalte der Tabelle darf in diesem Fall nicht sortiert sein.
Tipp
Als Beispiel für den Zweck der Sortiermöglichkeit sollen ausgehend von einer Klasse die abhängigen Elemente dokumentiert werden. Das sind für die Klasse einlaufende Beziehungen und für die Beziehungen der jeweilige Besitzer.
Auf die Anzeige der Überschrift der beiden Standardkapitel und die Anzeige der Beziehungen selbst wird verzichtet. Für die genannten Kapitel ist keine Sortierung möglich.
Mit einem Gliederungskapitel oberhalb der einlaufenden Beziehungen können die Besitzer der Beziehungen sortiert werden.
So gehen Sie vor
-
Selektieren Sie im Konfigurationseditor in der Ansicht Dokumentationsstrukturen die Kapitel, für die Sie ein zusätzliches Gliederungskapitel anlegen wollen.
-
Wählen Sie Bearbeiten>Struktur>Ebene einfügen.
Das zusätzliche Gliederungskapitel wird in die Dokumentationsstruktur eingefügt. Die selektierten Kapitel werden zu Unterkapiteln dieses Kapitels.
-
Um die Eigenschaften des zusätzlichen Gliederungskapitels festzulegen, wählen Sie Bearbeiten>Eigenschaften.
Der gleichnamige Dialog erscheint.
-
Um eine Überschrift zu benennen, geben Sie im Register Lokalisierte Namen für die gewünschten Sprachen jeweils eine Überschrift im Eingabefeld Name ein.
Die Dokumentationsebene liefert diese zusätzliche Überschrift.
-
Um für unmittelbar nachfolgende Standardkapitel eine Sortierung festzulegen, wählen Sie im Register Merkmale den Sortierungstyp aus.
Die Dokumentationsstruktur wird mit einem Sortierungstyp für unmittelbar nachfolgende Standardkapitel (ohne eigene Sortierung) versorgt.
-
Bestätigen Sie Ihre Änderungen mit Anwenden.
Die Eigenschaften werden entsprechend Ihrer Vorgaben geändert.
