In einer Dokumentationsstruktur können unterschiedliche Kapiteltypen auftreten.
Typen von Kapiteln
In einer Dokumentationsstruktur können Sie unterschiedliche Kapiteltypen verwenden:
-
Standardkapitel
-
Informationskapitel (Symbol
) -
Modellelementaufzählungskapitel (Symbol
)
-
-
zusätzliche Gliederungskapitel (für zusätzliche Überschriften und Festlegungen zur Sortierung)
-
Dokumentationsbausteine (Symbol
) und Verweise auf Dokumentationsbausteine
Der Inhalt von Modellelementaufzählungskapiteln kann auch tabellarisch ausgegeben werden.
Hinweis
Zu den zugeordneten Kapiteln wird auf der ersten Seite des Eigenschaftendialogs eine kurze Beschreibung zu dem Kapitel und den möglichen Filtern ausgegeben.
Informationskapitel
Informationskapitel sind Blattknoten der Dokumentationsstruktur. In ihnen werden Informationen zu einem Modellelement ausgegeben, wie zum Beispiel der letzte Bearbeiter. Ein solches Kapitel besteht aus Überschrift und Inhalt, wobei die Überschrift unterdrückt werden kann.
Informationskapitel werden im Konfigurationseditor nur in der Liste der zugeordneten Standardkapitel im mittleren Bereich ausgegeben. In der Liste Dokumentationsstrukturen im linken Bereich werden sie der Übersichtlichkeit halber nicht dargestellt.
Einige Informationskapitel haben eine spezielle Bedeutung:
-
Inhaltsverzeichnis, Index und Abbildungsverzeichnis
-
Prüfkapitel (Symbol
) -
Abbildungskapitel
Modellelementaufzählungskapitel
Modellelementaufzählungskapitel liefern zu einem Modellelement eine Menge von abhängigen Modellelementen, wie zum Beispiel zu einer Klasse alle Attribute. Unter einem solchen Kapitel können sich weitere Standardkapitel, zusätzliche Gliederungskapitel oder Verweise auf Bausteine befinden.
Hinweis
Die grundsätzlich rekursiven Kapitelauswertungen vermeiden die Wiederholung von Informationen, z.B. für mehrfach aufgerufene Aktivitäten. Die Rekursion einer Kapitelauswertung wird dazu abgebrochen, wenn ein Element im Auswertungspfad bereits für genau dieses Kapitel ausgewertet wird.
Ein Element, das in mehreren Teilpfaden enthalten ist, wird nur für das erste Auftreten auf der höchsten Ebene komplett ausgewertet. Bei jeder Auswertung auf einer tieferen Ebene wird nur die Überschrift des Elementkapitels ausgegeben. Alle enthaltenen Kapitel werden nicht ausgewertet.
Ein Modellelementaufzählungskapitel besteht aus einer Überschrift, unter die für jedes abhängige Modellelement eine Modellelementüberschrift generiert wird, die typischerweise den Namen dieses Elements enthält. Bei der Erstellung der Dokumentation kann man diese Modellelementüberschriften in Spiegelstrichlisteneinträge umwandeln.
Modellelementaufzählungskapitel werden im Konfigurationseditor sowohl in der Spalte Dokumentationsstrukturen als auch im mittleren Bereich dargestellt.
Zusätzliche Gliederungskapitel
Zusätzliche Gliederungskapitel sind ein Strukturierungselement, das es Ihnen erlaubt zusätzliche Überschriften in die Dokumentation einzufügen und einen Sortierungstyp für unmittelbar nachfolgende Standardkapitel festzulegen.
Dokumentationsbausteine und Verweise auf Dokumentationsbausteine
Dokumentationsbausteine dienen der Wiederverwendung von Teilbäumen einer Dokumentationsstruktur. Über Verweise können Sie an passenden Stellen in der Dokumentationsstruktur eingefügt werden.
Im Konfigurationseditor werden die Verweise im linken und mittleren Bereich dargestellt. Bei selektiertem Verweis im linken Bereich wird der Baustein im mittleren Bereich dargestellt.
In der Ansicht Dokumentation werden bei Selektion des Dokumentationsbausteins im linken Bereich die dazugehörenden Verweise im rechten Bereich ausgegeben.
Verwandte Themen
In diesem Kapitel finden Sie die Themen:
