FAQ zur Dokumentation

Mit dem Anlegen eines Dokumentationskommandos ist die Konfiguration noch nicht abgeschlossen.

Folgende Schritte sind noch durchzuführen:

• Für das Dokumentationskommando müssen Ausführungsrechte für die einzelnen Benutzerrollen des Modells vergeben werden, andernfalls kann dieses Kommando nur vom Administrator ausgeführt werden

• Das Dokumentationskommando ist ins Menü von Innovator-Modelleditor einzuhängen

• Im Innovator-Modelleditor ist ggf. noch der Menübefehl Ansicht>Synchronisieren>Inhalt neu laden (F5) auszuführen, um das Menü neu aufzubauen

Die Kapitelstruktur einer Dokumentation ergibt sich immer aus der Selektion im Modell beim Aufruf des Dokumentationskommandos und der verwendeten Dokumentationsstruktur. Es kommen also zwei Fehlerquellen in Frage: Selektion und Struktur.

• Die Selektion ergibt sich aus der ursprünglich vom Benutzer im Modelleditor getroffenen Auswahl. Diese erste Auswahl wird evtl. vom Dokumentationskommando als Eingabemenge für eine Suche zur Selektionsbestimmung verwendet, welches dann die tatsächlich verwendete Selektion für das Dokumentationskommando liefert. Ob eine Suche verwendet wird (und wenn ja, welche), ist als eine Eigenschaft des Dokumentationskommandos hinterlegt. Es könnte also sein, dass eine solche Suche ganz andere Elemente findet als ursprünglich vom Benutzer selektiert wurden, und dass dann eben diese Elemente im Dokument auftauchen.
• Welche Dokumentationsstruktur für das ausgeführte Dokumentationskommando verwendet wurde, ist eine Eigenschaft der zum Kommando gehörenden Dokumentationsauswahl. Im Einzelfall ist es notwendig, das Ergebnis kapitelweise darauf zu untersuchen, ob der Inhalt eines Kapitels mit dem gewünschten Inhalt übereinstimmt. Die Stelle der Dokumentationsstruktur, welche dieses Kapitel generiert hat, ist mit Hilfe der Kapitelnummerierung in aller Regel schnell zu finden. An dieser Stelle sind dann ggf. weitere Einstellungen zu überprüfen:
  • Liefert der Kindknoten den erwarteten Elementtyp?
  • Sind Filter auf diesem Knoten eingestellt, und das erwartete Element entspricht nicht diesem Filter?
  • Ist das Kapitel zwar Teil der Dokumentationsstruktur, aber vom Konfigurator unterdrückt worden?

Für diese Fälle kann eine Prüfung der Dokumentationsstruktur wichtige Erkenntnisse liefern. Siehe dazu auch die Beschreibung der Prüfmeldungen "Kapitel 'Name' ist mit aktueller Konfiguration nicht erreichbar" und "Kapitel 'Name' ist mit aktueller Konfiguration und Filter 'Name' nicht erreichbar".

Diese Informationen sind als Eigenschaften der zum Kommando gehörenden Dokumentationsauswahl hinterlegt. Um die gewünschten Kopf/Fußzeilen o.ä. zu erhalten, ist also entweder die Dokumentationsauswahl anzupassen oder aber die Eigenschaften der dort referenzierten Einträge.

Um ein bestimmtes Element anspringen zu können, muss die Beschreibung in einem nummerierten Kapitel stehen. Ein nummeriertes Kapitel wird immer dann erzeugt, wenn an dem Kindknoten, der diese Beschreibung enthält, in der Dokumentationsstruktur die Nummerierung eingeschaltet wird. Nur für diese Kapitel wird beim Generieren der Dokumentation eine Sprungmarke erzeugt.

Wie oben ist auch hier Voraussetzung, dass es zu einem solchen Element ein nummeriertes Kapitel gibt.