Übersicht über Informationskapitel

Informationskapitel

Informationskapitel (Symbol ) 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 (Bild)

Häufig wiederkehrende Informationskapitel

• Ersteller, Anlegezeitpunkt, Letzter Änderer, Änderungszeitpunkt: Informationen bezüglich des Erstellers und letzten Änderers und des entsprechenden Zeitpunkts.

• Historie: Zusammengefasste Informationen bezüglich des Erstellers und letzten Änderers und der entsprechenden Zeitpunkte.

• Name des Modells: Der Name des Modells in dem das Modellelement liegt. Dies ist nicht das Innovator-Modell direkt im Repository.

• Name des Namensraums: Der Name des Vorgängers in der Modellhierarchie.

• Namensraum: Der Pfad der Vorgänger des Modellelements in der Modellhierarchie, beginnend beim Repositorynamen. Als Trennzeichen wird '::' verwendet.

• Qualifizierter Name: Der Pfad des Modellelements in der Modellhierarchie, beginnend beim Repositorynamen. Als Trennzeichen wird '::' verwendet. Dies ist der Namensraum ergänzt um den Namen des Modellelements.

• URI: URI des Modellelements. Dieses Kapitel ermöglicht die Einbindung von Sprungzielen in die Dokumentation.

• UUID: Eindeutige Kennung des Modellelements.

• Labelinformation, Stereotypeigenschaftsinformation: Alle Labelwerte bzw. Stereotypeigenschaftswerte dieses Modellelements in der Form Name: Wert. Falls kein Wert gesetzt ist, wird der Vorgabewert verwendet.

• Stereotypeigenschaftswert: Der Wert der durch das Merkmal Filter Muster dieses Kapitels angegebenen Stereotypeigenschaft. Falls kein Wert gesetzt ist, wird der Vorgabewert verwendet.

• Aufgelöste Spezifikation: Der Wert der durch das Merkmal Filter Muster dieses Kapitels angegebenen Spezifikation. Falls kein Wert gesetzt ist, wird der Vorgabewert verwendet.

• Labelwert: Der Wert des durch das Merkmal Filter Muster angegebenen Labels. Falls kein Wert gesetzt ist, wird der Vorgabewert verwendet.

• Prüfung: Prüfmeldungen bezogen auf dieses Modellelement. Die aufzurufende Prüfroutine muss im Merkmal Verifikation des Dokumentationskapitels angegeben werden.

• Symbol: Das Stereotypsymbol des Modellelements.

• Bild: Die Grafik eines Diagramms.

Kapitel auf oberster Ebene

Auf der obersten Ebene der Dokumentationsstruktur existieren einige Kapitel mit besonderer Bedeutung. Diese Kapitel können nur einmal angelegt werden und nicht in Bausteine oder unter zusätzliche Gliederungskapitel verschoben werden:

• Inhaltsverzeichnis: Kapitel mit dem Inhalt der Dokumentation. Es muss an erster oder letzter Stelle der Dokumentation stehen.

• Index: Kapitel mit dem Index der Dokumentation.

• Abbildungsverzeichnis: Verzeichnis der Abbildungen der Dokumentation.

• Tabellenverzeichnis: Verzeichnis der Tabellen der Dokumentation.