Beschreibung der Dokumentationsstruktur

Beschreibung der allgemeinen Struktur

Die gesamte X3-Dokumentation wird in der Datenbank gespeichert.

• Tabelle ADOCUMENT für die Absatzstruktur
• Tabelle ADOCCLB für die Texte,
• Tabelle ADOCBLB für die sonstigen Dateien,
• Tabelle ADOCFNC für die Verknüpfungen.
• Tabelle ADOCFLD für die Feldhilfen.

Wie die Daten in den Tabellen gespeichert werden, wird im nachstehenden Anhang beschrieben.

Generierung der Dokumentation

• Mit einer ersten Generierungsfunktion werden zu jedem zu dokumentierenden Eintrag mehrere normierte Absätze für die Dokumentation generiert.
• Eine zweite Generierungsfunktion setzt auf dieser Struktur und dem erfassten Text auf und generiert die endgültige Dokumentation im HTML-Format. Da die Dokumentation als Liste von Absätzen organisiert ist, entspricht jedes Datenblatt einem Absatz.

Absatzstruktur

• Sprachcode
• Dokumenttyp 
• Der Typ AFC steht für die funktionale Dokumentation (Erläuterung der Funktionsweise bei der Verwendung der betreffenden Funktion).
• Die Parametrierungsdokumentation (Parameter, Aktivitätscodes, Automatikbelege etc.) ist über den Code desjenigen Objektes charakterisiert, von dem sie verwaltet wird (in den Beispielen also ADP, ACV und GAU).
• Die sonstige Dokumentation ist über den Code DI charakterisiert (z. B. Anhänge wie der vorliegende). Die Menüs und Untermenüs sind durch den Code APM definiert.
• Code, der für den Inhalt der Dokumentation steht und anhand dessen die Dokumentation identifiziert werden kann: z. B. Funktionscode, Parametercode, Aktivitätscode, Automatik-Belegcode etc.
• Ebene und Unterebene, durch die die Verschachtelung des Absatzes abgebildet wird.
  Der Titel des ersten Absatzes in jeder Ebene wird in eine Inhaltstabelle übernommen, die direkt auf bestimmte Dokumentationsbereiche zeigen kann. Ist auf einer gegebenen Ebene mehr als ein Absatz vorhanden, so wird für die entsprechende Ebene jeweils eine Inhalts-Untertabelle angelegt.
• Durch einen Absatzcode ist festgelegt, wie HTML-Text generiert werden soll.
• Ein Maskencode, über den festgelegt ist, ob in den entsprechenden Absatz ein Symbol eingefügt werden soll, mit dem die Feldhilfe zu der entsprechenden Maske geöffnet werden kann
• Ein bei der erneuten Generierung vom Dictionary geerbter Aktivitätscode, mit dem speziell zwischen Standard- und Sonderdatenblättern unterschieden werden kann, und mit dem weiterhin zu bestimmten Ordnern Dokumentationen generiert werden können, die sich auf die im Ordner aktivierten Aktivitätscodes beschränken.

 Hierbei ist zu beachten, dass Absätze mit Aktivitätscode FAL (stets falsch) von der Generierungsverarbeitung auch bei Generierung der kompletten Dokumentation nicht berücksichtigt werden. Auf diese Art können generierte Absätze, die in keiner Dokumentation enthalten sein sollen, deaktiviert werden.

Nach Abschluss der Generierung aus dem Dictionary können die in der Tabelle ADOCUMENT angelegten Datenblätter vervollständigt oder durch weitere Datenblätter ergänzt werden (insbesondere durch Datenblätter vom Typ Sonstige). Wird ein Datenblatt aus der Tabelle ADOCUMENT gelöscht, so wird der zugehörige Absatz aus der endgültigen Dokumentation gelöscht (wird dieser Absatz jedoch aus dem Dictionary generiert, so wird er bei einer erneuten Generierung aus dem Dictionary neu angelegt).

 Wichtiger Hinweis: Die Absätze werden in der Reihenfolge ihres Erscheinens aufgelistet (z. B. Absatz TIT an erster Stelle). Außer in Ausnahmefällen und bei generierten Absätzen (insbesondere MIS und MIN) wird empfohlen, die Reihenfolge zu beachten.

Vorhandene Absätze können verschiedenen Kategorien zugeordnet werden.

Automatisch generierte Absätze

In bestimmte Aufsätze werden unter Beachtung einer gegebenen Formatierung automatisch Elemente aus dem Dictionary und aus der Beziehungstabelle übernommen.
Solche Absätze werden als generierte Absätze bezeichnet. Wenn es durch bestimmte Dictionary- oder Beziehungstabellenelemente gerechtfertigt ist, werden bei der Generierung der Tabelle ADOCUMENT zu solchen generierten Absätzen leere Absätze generiert. Ein Text muss in diesem Fall nicht gesetzt werden, denn im Absatz werden ja die entsprechenden Elemente aus dem Dictionary automatisch angezeigt. 
Wird im Datenblatt ein Text erfasst, wird er automatisch am Ende des Absatzes angehängt. In diesem Fall wird der Absatz bei einer erneuten Generierung nicht gelöscht. Dies gilt auch, wenn er aufgrund einer Weiterentwicklung des Dictionarys hinfällig geworden ist.

Leer angelegte und klassische Absätze

Bestimmte Absätze werden bei der Generierung aus dem Dictionary automatisch angelegt, enthalten jedoch keinen Text, da es sich um üblicherweise in dem gegebenen Dokumenttyp vorhandene freie Absätze handelt. In solchen Fällen wird der in der Tabelle ADOCUMENT erfasste Text ohne besondere Formatierung in das endgültige Dokument übernommen. Manche Absätze werden während der Generierung des Dictionarys nicht automatisch angelegt, können aber im Anschluss daran angelegt werden. Solche Absätze heißen freie Absätze und befinden sich am Dokumentende.

Hyperlinks

Außer in den nachstehend aufgelisteten Ausnahmen wird beim Anlegen eines Absatzes im Text eine Markierung mit demselben Namen gesetzt. Es ist also möglich, einen Hyperlink zum betreffenden Absatz anzulegen (der Link lautet in diesem Fall Dokument.htm#Markierung und nicht Dokument.htm). Beispiel: Um direkt zur Dokumentation der 3. Registerkarte der Benutzerverwaltungsfunktion (GESAUS) zu gehen, wird der Link GESAUS.htm#ON3 verwendet.

Die Codes der Absätze können mehrfach in einer Dokumentation verwendet werden, müssen aber in jedem Absatz einen Link aufweisen. In diesem Fall wird der Link im Format PARAG_LEV_SLEV ausgedrückt, wobei PARAG der Absatzcode, LEV die Ebene und SLEV die Unterebene ist. Beispiel: Der Link zu dem Absatz vom Typ MIS auf Ebene 140, Unterebene 50 der Dokumentation ADO_VCT lautet ADO_FCT#MIS_140_40.

Dokumentationstypen

Durch das Feld Dokumentationstyp ist festgelegt, welcher Inhalt dokumentiert wird.

Die möglichen Dokumentationstypen sind der nachstehenden Tabelle zu entnehmen:

 Erläuterungen zu bestimmten Dokumentationen

Dokumentationen vom Typ AFC

Die Dokumentation vom Typ AFC ist am umfangreichsten. Die Beschreibung umfasst dabei die Funktion mit den Parametrierungsvoraussetzungen (in Form einer Reihe von automatisierten Unterabsätzen), die Benutzerschnittstelle (Registerkarten mit Feldhilfe, Buttons, Menüeinträge) sowie die Anhänger (Berichte, Fehlerlisten und verwaltete Tabellen).
Ein Teil der Absätze kann vollständig aus dem Dictionary generiert werden, die meisten Absätze müssen jedoch erfasst werden. Der dieser Dokumentation zugeordnete Code entspricht dem Funktionscode (so, wie im Funktions-Dictionary definiert). Der Name der zugehörigen HTML-Datei wird im Unterverzeichnis des Dokumentationsverzeichnisses FCT generiert.
Die Datei kann aus einer beliebigen Maske der Funktion mit der Taste F1 aufgerufen werden.

Bei der nur zu der AFC-Dokumentation generierten HTML-Dokumentationsdatei werden alle als zur Funktionsausführung gehörig betrachteten Absätze zu einer anderen HTML-Datei gruppiert. Dies dient der Trennung des funktionalen vom technischen Teil. Zu allen betroffenen Absätzen wird ein Link von der ursprünglichen HTML-Datei zur Ausführungs-HTML-Datei angelegt.
Die angegebenen Absätze sind:

• Alle Absätze auf Ebene 30 (Voraussetzungen)
• Alle Absätze auf Ebene 100 (Ausführungstabellen)

Dokumentationen vom Typ DI

Dokumentationen vom Typ DI sind keinem Dictionary-Element zugeordnet. Mit ihnen können technische Anhänge zu den allgemeinen Dokumentationen erstellt werden. Beispiel: Bei den Standarddokumentationen entspricht GESAWA.htm der Dokumentation zu den Workflow-Ereignissen. GES_AWA.htm ist eine Dokumentation vom Typ DI und entspricht dem zugehörigen technischen Anhang.
Dokumentationen vom Typ DI werden im Verzeichnis FCT generiert.
Um Namensüberschneidungen mit Funktionsdokumentationen zu vermeiden, muss mindestens das Zeichen '_' in den Funktionscode eingefügt werden.

Dokumentationen vom Typ ACV, ADM, ADP, AHI, AOE, ARP,AWA, CDA, CDE, GAU, PS1, ADC

Bei Dokumentationen vom Typ ACV, ADM, ADP, AHI, AOE, ARP, AWA, CDA, CDE, GAU, PS1, ADC handelt es sich um Dokumentationen vom Typ Objekt, die aus der entsprechenden Parametrierungsfunktion mit der Tastenkombination Alt + F1 erreichbar sind. In ihnen ist das aktuelle Datenblatt aus Sicht der Parametrierungslogik beschrieben. Im Allgemeinen wird in diesem Dokumentationstyp nur wenig Text erfasst (lediglich die Verwendung oder Beschreibung des fraglichen Codes sowie eventuell einige Bemerkungen). 
Manche Absatzcodes sind ganz speziell diesem Dokumentationstyp gewidmet. Die Codes dieser Dokumentationen entsprechen den jeweiligen Datenblattcodes. Das Dokumentationsdatenblatt wird im Unterverzeichnis OBJ generiert. Es setzt sich aus dem Objektcode und dem Datenblattschlüssel zusammen.

Beispiele
- Der Aktivitätscode BPA wird unter dem Namen ACV_BPA.htm generiert
- Das Import- / Exportmodell BPR wird unter dem Namen AOE_BPR.htm generiert. 

 Hinweis: Der Parameterschlüssel entspricht den beiden Schlüsselkomponenten des entsprechenden Kapitels. Beispielsweise wird die Hilfe zum Parameter ADMUSR (Kapitel SUP) unter dem Namen ADP_SUP_ADMUSR.htm generiert.

Dokumentation vom Typ AML, ATB, ATY

In der Dokumentation vom Typ AML, ATB und ATY wird die Datenstruktur beschrieben.
Auf diese Dokumentation kann von der Übersicht der Hilfe aus zugegriffen werden.
In diesem Dokumentationstyp ist nur ein einziger Absatz vorhanden (der Titelabsatz, in dem der an anderer Stelle generierten Dokumentation ein Kommentar vorangestellt werden kann). Diese Dokumentation wird im Verzeichnis MCD generiert und übernimmt den Code der Tabelle (ohne Präfix), den Code des Datentyps mit Präfix ATY_ sowie die Nummer des Lokalen Menüs im Format MEN####.htm (wobei #### für die vierstellige, von links mit Nullen aufgefüllte Menünummer steht).

Dokumentation vom Typ APM

Bei der Dokumentation vom Typ APM handelt es sich um die Hilfemenüs.
Diese Dokumentation wird aus dem Dictionary generiert und besteht aus einem einzigen Absatz. Es können weitere Absätze erstellt werden, wenn zusätzliche Menüs zur Organisation der Dokumentation beschrieben werden müssen (in diesem Fall enthält der generierte Absatz die Liste der aufgerufenen Dokumentationen). Die generierten Dokumentationen dieses Typs können auch um zusätzliche Dokumentationslinks erweitert werden.

Dokumentationen vom Typ FI

Die Dokumentationen vom Typ FI dienen lediglich der Ausgabe von Dokumentationen. Der Ort, an dem diese Dateien erstellt werden, ist durch die Benennungsnorm für diese Art von Dokumentation festgelegt. Weitere Erläuterungen sind dem betreffenden Absatz zu entnehmen.

Dokumentationsmenüs

Jede Funktion verwaltet Datenblätter, die unter folgenden Bedingungen mit der Verwaltungsfunktionen für Dokumentationen dokumentiert werden können:

• In der Sonstigen Tabelle 910 muss ein Dokumentationscode definiert sein, der dem Objektcode der zu verwaltenden Datenblattdokumentation entspricht.
• Der Dokumentationstyp muss dem Objekttyp entsprechen, der Schlüssel dem Primärschlüssel des dokumentierten Datenblattes (bei Schlüsseln mit mehreren Komponenten sind die einzelnen Komponenten durch das Zeichen "_" zu trennen).
• Die Dokumentationen müssen im HTML-Format generiert werden (standardmäßig werden sie im Verzeichnis OBJ der Objekthilfen erstellt).
• Die Hilfe zu einem Datenblatt wird mit der Tastenkombination Alt + F1 aufgerufen.

Beispiele
AFC (Funktionshilfe) entspricht der Hilfe zu den Funktionen, also werden die Funktion vom Objekt AFC verwaltet. Dasselbe gilt für die Dokumentationen ADP (Paramter), ACT (Aktionen), ACF (Aktivitätscodes) etc.

Wird ein Objektcode in der Sonstigen Tabelle 910 gefunden, wird in der Menüleiste des betreffenden Objektes automatisch ein Menü namens Dokumentation angezeigt.
Im Folgenden werden die im Menü verfügbaren Funktionen beschrieben.

Dokumentation / Absätze

Mit dieser Funktion kann auf die Dokumentationsverwaltung und auf den ersten Absatz der Dokumentation (sofern vorhanden) zum aktuellen Datenblatt zugegriffen werden.

Dokumentation / Verknüpfungen

Mit dieser Funktion kann auf die Linkverwaltung zugegriffen werden. Die Funktion definiert Links zwischen dem aktuellen Datenblatt und anderen Datenblättern (z. B. Links zwischen Funktionen und Parametern). Diese Links dienen lediglich Dokumentationszwecken: Aus ihnen wird der Generierungsprozess der Dokumentationsgliederungen gespeist.

Dokumentation / Generierung

Über dieses Menü wird die Dokumentationsgenerierung angestoßen. Die Generierung kann auch per Klick auf den Button [Generieren] im unteren Fensterbereich gestartet werden.

Es gibt drei Generierungstypen, die einzeln oder gleichzeitig verwendet werden können:

• Generierung der Dokumentationsgliederung aus dem Dictionary (Tabellen ADOCUMENT, ADOCBLB, ADOCCLB)
• Generierung der Dokumentation aus obigen Tabellen
• Generierung der Felddokumentation

In den standardmäßig vorgeschlagenen Bereichen ist das aktuelle Datenblatt berücksichtigt. Die Bereiche können jedoch beim Aufruf der Funktion geändert werden.

Vorangestellte Absätze

In vorangestellten Absätze wird in die Funktionsdefinition eingeführt.

Code TIT (Titel)

Durch dieses Kapitel ist der im Dokumentationsnamen enthaltene Titel festgelegt.

Bei Funktionsdokumentation, die aus dem Dictionary generiert wird, wird dieses Kapitel automatisch auf Ebene (10,10) angelegt.

Bei nur aus diesem Absatz bestehenden Dictionary-Dokumentationen (Tabellen, Lokale Menüs, Datentypen) handelt es sich bei dem erfassten Text um einen vorangestellten Text, der vor den Tabellen eingefügt wird, die die technische Struktur des Dictionarys beschreiben.

In Dokumentationen, die ein Menü beschreiben (Typ APM), können Links zu anderen Hilfetexten eingefügt werden, wobei diese über ihren Code identifiziert sind. Zeilenkodifizierung:

• entweder über den Funktionscode (Funktionsdokumentation). Beispiel: GESAUS
• oder über den Code des Hilfetextes, wobei als Präfix dessen Typ und als Trennzeichen ein Slash ("/") verwendet wird. Beispiel: DI/ADO_FCT
• oder über eine der obigen Syntaxen, wobei als Präfix das Zeichen "#" sowie ein Markierungsname verwendet werden, um sich direkt in der Mitte des Dokumentes zu positionieren. Beispiel: GESAUS#ON3

Bei allen anderen Dokumentationstypen können lediglich per Komma getrennte einzelne Wörter in den Text eingefügt werden. Diese werden in die Rubrik Schlüsselwort (Schlüsselwörter für die Suche, die ansonsten nicht im Text erscheinen) in die HTML-Datei eingefügt. In diesem Fall ist im erstellten HTML-Dokument kein echter Absatz (und auch keine echte Markierung) enthalten.

Dieser Absatztyp wird für alle Dokumentationstypen verwaltet. Umfasst der Absatz einen Aktivitätscode und wird Dokumentation für einen Ordner generiert, in dem dieser Aktivitätscode nicht aktiviert ist, so kann die entsprechende Dokumentation nicht generiert werden.

Für Absätze mit Aktivitätscode FAL gilt insbesondere:

• Die endgültige Dokumentation wird niemals generiert
• Durch die erneute Generierung einer Dokumentationsgliederung wird ebenfalls keine Generierung angestoßen (die Generierung wird abgebrochen, wenn der Absatz TIT mit Aktivitätscode FAL vorhanden ist)

Wenn der Name des Titels nicht im Datenblatt angegeben ist, wird er je nach Kontext in Dictionary der Funktion gesucht. Dadurch können Sonderfälle wie Hilfstexte zu den Funktionen RPT* verwaltet werden, wobei der Gruppenname dem Namen des Dictionarys entsprechen muss.

Code PRE (Zusammenfassung)

In diesem Fall wird die Zusammenfassung des dokumentierten Elementes definiert (Funktion, Aktivitätscode, Dimensionierungsparameter, Parameter etc. – es sind sämtliche Dokumentationen betroffen). Dieser Absatz wird automatisch leer auf Ebene (10,20) erstellt.

Es ist der erste Absatz, der in der endgültigen Funktionsdokumentation erscheint.

 Um Aktivitätscodes zu präsentieren, die von einem anderen Code abhängen, muss kein Text gesetzt werden (wenn der Text der ist, wird ein automatischer Text verwendet).

Absätze zu funktionalen Voraussetzungen

In diesen Absätzen werden die für die Ausführung der beschriebenen Funktion notwendigen Voraussetzungen erläutert. Solche Absätze können also in jeder Funktionsdokumentation vorhanden sein. Dies gilt auch dann, wenn bestimmte Voraussetzungen auch in anderen Dokumentationen vorhanden sind (Dokumentationen von Aktivitätscodes, Berichten, Workflow-Ereignissen etc.).

HINWEIS für Dokumentation vom Typ AFC (und nur AFC): In der generierten HTML-Dokumentationsdatei werden alle diese "Voraussetzungsabsätze" ab sofort in eine zusätzliche HTML-Ausführungsdatei geschrieben. Dies dient der Trennung des funktionalen vom technischen Teil. Es wird ein Link von der ursprünglichen HTML-Datei zur Ausführungs-HTML-Datei angelegt.

Absatzverzeichnis:

Code PRQ (Voraussetzung)

In diesem Absatz sind die Voraussetzungen definiert. Der Absatz ist in Dokumentationen zu Funktionen, Berichten und Import- / Exportmodellen vorhanden.

Der Absatz dient als Einleitung und wird auf Ebene (30,10) leer erstellt. Bei Funktionsdokumentationen wird er lediglich angelegt, wenn außerdem ein anderer Absatz über Voraussetzungen erstellt wird; bei Dokumentationen zu Berichten und zu Import- / Exportmodellen wird dieser Absatz hingegen immer angelegt.

Es muss nicht unbedingt Text eingefügt werden (wenn kein Text vorhanden ist, fungiert der Absatz als Zwischentitel).

Code ACV (Aktivitätscodes)

Dieser Absatz ist in Funktionsdokumentationen und in Dokumentationen zu Parametern und Aktivitätscodes vorhanden. Es handelt sich um einen auf Ebene (30,20) mit Stil 4 generierten Absatz:

• In Funktionsdokumentationen wird er aus dem Dictionary generiert, wenn mindestens ein Aktivitätscode gefunden wurde (nach den Aktivitätscodes wird in der Funktion, im Funktionsfenster, im Objekt, in der Anzeige und in den zugehörigen Tabellen gesucht). Einer Funktion kann auch in der Beziehungstabelle ADOCFNC ein Aktivitätscode zugeordnet werden. Es handelt sich dann um einen Unterabsatz zum Absatz PRQ.
• In der Parameterdokumentation wird der Absatz auf Basis einer Dictionary-Suche und über die Beziehungen zwischen Parameter und Aktivitätscode generiert.
• In den Dokumentationen, die einen Aktivitätscode beschreiben, wird der Absatz unter Berücksichtigung der vom dokumentierten Aktivitätscode abhängigen Aktivitätscodes generiert (die entsprechenden Abhängigkeiten sind den Dictionary zu entnehmen).

Während der Generierung der endgültigen Dokumentation werden die Aktivitätscodes mit demselben Algorithmus im Dictionary gesucht und tabellenförmig mit den Links zu der Dokumentation, in der der Aktivitätscode beschrieben wird, präsentiert.

Hinweis: Die systematische Suche im gesamten Dictionary kann dazu führen, dass zahlreiche nicht gewünschte Aktivitätscodes in der Liste angezeigt werden. Es steht eine spezielle Funktionalität zur Verfügung, um diesen Effekt zu vermeiden: Wenn in den Dokumentationslinks der Aktivitätscode FAL (stets falsch) vorhanden ist, wird nicht in Dictionary nach Aktivitätscodes gesucht. In bleibender lediglich die in den Links gefundenen Aktivitätscodes (außer FAL).

Code ADP (Parameter)

Dieser Absatz ist in Funktionsdokumentationen und in Dokumentationen zu Parametern und Import- / Exportmodellen vorhanden. Es handelt sich um einen auf Ebene (30,30) mit Stil 4 generierten Absatz:

• Bei Funktionsdokumentationen ist in ihm die Liste der der Funktion zugeordneten Parameter definiert, und der Absatz wird auf Basis der Beziehungen zwischen Funktion und Parameter oder zwischen Parameter und Funktion generiert (die Beziehungen in umgekehrter Richtung werden ebenfalls analysiert). Es handelt sich dann um einen Unterabsatz zum Absatz PRQ.
• Bei Parameterdokumentationen wird der Absatz auf Basis einer Suche in Dictionary generiert (und umfasst Parameter derselben Gruppe und desselben Kapitels). Auch die Verbindungen zwischen Parameter und Parameter in der Beziehungstabelle fließen mit ein.
• In den Dokumentationen, die ein Import- / Exportmodell beschreiben, werden in diesem Absatz die verbundenen Parameter erläutert (Suche über Analyse der Beziehungen zwischen Modellen und Parametern oder umgekehrt in der Beziehungstabelle).

Bei Generierung der endgültigen Dokumentation werden die Parameter nach Gruppen geordnet und in Listen mit Links zu der Dokumentation, in der der allgemeine Parameter beschrieben wird, organisiert.

Code ANM (Nummernkreise)

Dieser Absatz ist in den Funktionsdokumentationen vorhanden und wird auf Ebene (30,40) mit Stil 4 generiert. In ihm werden die von der Funktion verwendeten Nummernkreise aufgelistet. Der Absatz wird generiert, wenn in der Beziehungstabelle mindestens ein Nummernkreis gefunden wurde (wenn also der Funktion ein Nummernkreis zugeordnet werden kann). Es handelt sich um einen Unterabsatz zum Absatz PRQ.

Bei Generierung der endgültigen Dokumentation werden die Nummernkreise listenförmig angezeigt.

Code GAU (Automatik-Belege)

Dieser Absatz ist in den Funktionsdokumentationen vorhanden und wird auf Ebene (30,50) mit Stil 5 generiert. In ihm werden die von der Funktion verwendeten Automatik-Belege aufgelistet. Der Absatz wird generiert, wenn in der Beziehungstabelle mindestens ein Automatik-Beleg gefunden wurde (wenn also der Funktion ein Automatik-Beleg zugeordnet werden kann). Es handelt sich um einen Unterabsatz zum Absatz PRQ, dem der zusätzliche Zwischentitel Buchhaltungsschnittstelle vorangestellt wird. Der Stil ist um eine Stufe niedriger als der Absatzstil (standardmäßig 4). Der Unterabsatz führt in die Absätze GAU und CDE ein.

Bei Generierung der endgültigen Dokumentation werden die Automatik-Belege tabellenförmig mit einem Link zu der Dokumentation präsentiert, in der sie beschrieben sind.

Code CDE (Sektoren / Standard)

Dieser Absatz ist in den Funktionsdokumentationen vorhanden und wird auf Ebene (30,60) mit Stil 5 generiert. In ihm werden die von der Funktion verwendeten Sektorcodes aufgelistet. Der Absatz wird generiert, wenn in der Beziehungstabelle mindestens ein Sektorcode gefunden wurde (wenn also der Funktion ein Sektorcode zugeordnet werden kann). Es handelt sich um einen Unterabsatz zum Absatz PRQ, dem der zusätzliche Zwischentitel Buchhaltungsschnittstelle vorangestellt wird. Der Stil ist um eine Stufe niedriger als der Absatzstil (standardmäßig 4). Der Unterabsatz führt in die Absätze GAU und CDE ein.

Bei Generierung der endgültigen Dokumentation werden die Automatik-Belege tabellenförmig mit einem Link zu der Dokumentation präsentiert, in der sie beschrieben sind. 

Code HAB (Berechtigungen)

In der Funktionsdokumentation ist dieser fakultative Absatz meist ein Unterabsatz des Absatzes PRQ.

Er wird standardmäßig auf Ebene (30, 70) mit Stil 4 generiert, wenn eine der folgenden Bedingungen erfüllt ist:

• Die Zugriffsrechte auf die Funktion werden standortabhängig verwaltet
• Im Dictionary der Funktion sind Berechtigungsoptionen enthalten
• Die Funktion ist vom Typ Objekt (d. h. standardmäßig sind Optionen für Anlage / Löschen / Änderung vorhanden)
• Auf Objektebene ist ein Zugriffscode deklariert, wenn es sich um eine Funktion von diesem Typ handelt

Bei Generierung der endgültigen Dokumentation wird eine Reihe von kontextabhängigen Automatik-Texten generiert (Kontext: Verwaltung nach Zugriffscodes, nach im Dictionary vorhandenen Berechtigungsoptionen etc.)

Code TRS (Transaktionen)

In der Funktionsdokumentation ist dieser fakultative Absatz meist ein Unterabsatz des Absatzes PRQ. Die Generierung stützt sich auf die Beziehungen zwischen Funktionen und Transaktionen (über Beziehungen vom Typ TRS wird eine Verbindung zwischen einer Funktion und der entsprechenden Transaktionsparametrierungsfunktion hergestellt). Der Absatz wird auf Ebene (30, 80) mit Stil 4 generiert.

Bei Generierung der endgültigen Dokumentation werden diese Transaktionen formatiert, und es werden Links zu der entsprechenden Funktionsdokumentation eingefügt.

Code ECC (Anzeigemasken)

In der Funktionsdokumentation ist dieser fakultative Absatz meist ein Unterabsatz des Absatzes PRQ. Der wird aus dem Dictionary generiert, indem die Liste der im Generierungsordner gefundenen Anzeigecodes durchsucht wird.

Hinweis: Dieser Absatz wird mit demselben Rang generiert wie der Absatz TRS. Dies erklärt sich dadurch, dass nicht beide Absätze gleichzeitig vorhanden sein können (da der eine die Anzeige, der andere die Objekte betrifft) und dass außerdem beide bestimmten Maskenarten entsprechen. Der Absatz wird auf Ebene (30, 80) mit Stil 4 generiert.

Bei Generierung der endgültigen Dokumentation werden die entsprechenden Maskencodes tabellarisch dargestellt.

Code PRD (sonstige Voraussetzungen)

Dieser Absatz wird auf Ebene (30,90) mit Stil 4 bei Funktionsdokumentationen generiert. Der Absatz umfasst eine Reihe sonstiger Voraussetzungen, die in Unterabsätzen mit Zwischentiteln in Stil 5 dargestellt sind.

• Dem ersten dieser Unterabsätze ist die Liste der zu aktualisierenden sonstigen Tabellen zu entnehmen. Dieser Unterabsatz wird aus den Beziehungen zwischen der Funktion und den sonstigen Tabellen gespeist.
• Dem zweiten Unterabsatz ist die Liste der zu aktualisierenden Datenbanktabellen zu entnehmen. Dieser Unterabsatz wird aus den Beziehungen zwischen der Funktion und den Tabellen gespeist (über den Code AT2; mit dem Code ATB werden die aktualisierten Tabellen belegt).
• Dem dritten Unterabsatz ist die Liste der zu belegenden Lokalen Menüs zu entnehmen. Dieser Unterabsatz wird aus den Beziehungen zwischen der Funktion und den Lokalen Menüs gespeist.
• Der letzte Unterabsatz heißt Sonstige Voraussetzungen und ist vorhanden, wenn in die Dokumentation ein Text eingefügt wurde. Beginnt der Text mit einem Titel (mit einer Markierung vom Typ Hn, wobei n für eine Zahl steht), wird der Zwischentitel Sonstige Voraussetzungen nicht eingefügt.

Schnittstellenbeschreibung

In diesen generierten Absätzen wird die Struktur des der Funktion zugeordneten Erfassungsfensters beschrieben. Diese Absätze werden nur dann automatisch generiert, wenn der Funktion tatsächlich ein Fenster zugeordnet ist. Bei der Generierung der endgültigen Dokumentation wird auch die Funktionshilfe eingefügt, wenn das Feld Maske im Datenblatt belegt ist.

Es handelt sich um folgende Absätze:

ECR-Code (Maskenbeschreibung)

Dieser Absatz umfasst eine Einleitung, die insbesondere der Definition der Anzahl von Registerkarten sowie der Beschreibung der Auswahlliste links (sofern vorhanden) dient.

Bei Funktionsdokumentation, die aus dem Dictionary generiert wird, wird dieses Kapitel automatisch auf Ebene (40,50) mit Stil 3 angelegt.

ENT-Code (Maskenkopf)

In diesem Absatz werden die Felder der Maskenkopfzeile beschrieben (sofern vorhanden). Der hier erfasste Text wird unverändert in die endgültige Dokumentation übernommen. Wenn als Parameter ein Maskencode übergeben wird, enthält die Titelleiste ein kleines Symbol (Pfeil nach unten), mit dem automatisch die Liste der Kopfzeilenfelder der Maske und die entsprechenden Hilfetexte erweitert werden können. Der Text dient im Allgemeinen dafür, die Felder des Objektschlüssels und die Anzeigekriterien zu beschreiben.

Wenn die Funktionsdokumentation aus dem Dictionary generiert wird, wird dieses Kapitel automatisch auf Ebene (40,100) mit Stil 3 erstellt, wenn im zu der Funktion gehörenden Fenster tatsächlich eine Kopfzeilenmaske verwendet wird.

Codes ON1 bis ONF (Register)

In diesen Absätzen sind alle Register des der Funktion zugeordneten Fensters beschrieben. Die Titelleiste umfasst ein kleines Symbol (Pfeil nach unten), mit dem automatisch die Liste der Registerfelder und die zugehörigen Hilfetexte erweitert werden können. Voraussetzung hierfür ist, dass das Maskenfeld im Datenblatt angegeben ist, was bei automatischer Generierung stets der Fall ist.

Dieser Text sollte in der Regel Angaben zu den Registerfeldern enthalten (eine ausführliche Feldhilfe ist nicht unbedingt notwendig, denn die Onlinefeldhilfe kann ebenfalls per Klick auf den Pfeil erweitert werden). Wenn kein Text erfasst ist, wird der Benutzer mit einem generierten Text dazu aufgefordert, die Feldhilfe zu erweitern.

Wird die Funktionsdokumentation aus dem Dictionary generiert, wird dieser Kapiteltyp automatisch auf Ebene 40 erstellt und aus der Beschreibung des der Funktion zugeordneten Fensters belegt. Die Unterebenen für die Generierung werden ab dem Rang des Registers kalkuliert (Feld ROWMSK). Auf diese Art kann die Anzeigereihenfolge der Register der Funktion auch dann eingehalten werden, wenn spezifische Register zwischen zwei vorhandene Register eingefügt werden müssen. Die Unterebene entspricht dem Rang, multipliziert mit 200. Wenn die Ränge in Zehnerschritten nummeriert sind, ergeben sich also die Rangnummern 2.000, 4.000, 6.000. Der größtmögliche Rang ist 19.800, der kleinste 200.

Bei Generierung der Dokumentation werden die Absätze zu den Aktionen Button in Tabelle (Rechtsklick) automatisch an den Absatz zum jeweiligen Register angehängt und in Fünferschritten nummeriert (um Raum für eventuelle sonstige Absätze zu lassen).

Codes BOT (Klicks in Tabellen)

In diesen Absätzen werden alle per Rechtsklick in eine Tabelle verfügbaren Funktionen beschrieben. Es können mehrere Absätze mit demselben Code existieren: In diesem Fall lautet der Link BOT_LEV_SLEV, wobei LEV die Ebene und SLEV die Unterebene ist. Jeder dieser Buttons muss in der Reihenfolge der Absätze genau hinter denjenigen Absatz eingefügt werden, in dem das Register beschrieben wird, welches den Button umfasst.

Wird die Funktionsdokumentation aus dem Dictionary generiert, werden diese Absätze automatisch auf Ebene 40 mit einer Nummerierungsschrittweite von 5 ab der Registernummer erstellt (z. B. 2005, 2010, 2015 hinter dem Register auf Rang 10). Standardmäßig wird Stil 6 verwendet und ein Zwischentitel namens Per Rechtsklick in die Tabelle verfügbare Funktionen in Stil 5 über die nächsten Absätze gesetzt.

Codes BOU (Buttons)

In diesen Absätzen sind die im unteren Maskenbereich zur Verfügung stehenden Buttons beschrieben. Es können mehrere Absätze mit demselben Code existieren: In diesem Fall lautet der Link BOU_LEV_SLEV, wobei LEV die Ebene und SLEV die Unterebene ist. Diese Absätze sind in der Regel hinter den Registerabsätzen platziert. Der erste dieser Absätze umfasst eine Einleitung, für deren Titel ein Standardstil (standardmäßig Stil 3) verwendet wird. Der Titel der aufeinanderfolgenden BOU-Kapitel ist eingerahmt (um zu signalisieren, dass der Text dem Buttontext entsprechen muss). Der entsprechende Text befindet sich rechts von den Buttons.

Bei Generierung der Funktionsdokumentation aus dem Dictionary werden diese Absätze automatisch auf Ebene 70 erstellt, wobei die Unterebenen mit 10 beginnen (Titel des Kapitels zu den Buttons) und in Zehnerschritten (20 = 1. Button, 30 = 2. Button usw.) nummeriert werden.

Codes BME (Menüleiste)

In diesen Absätzen werden alle in der Menüleiste verfügbaren Funktionen beschrieben. Es können mehrere Absätze mit demselben Code existieren: In diesem Fall lautet der Link BME_LEV_SLEV, wobei LEV die Ebene und SLEV die Unterebene ist. Diese Absätze sind nach den Absätzen platziert. Der erste dieser Absätze umfasst eine Einleitung, für deren Titel ein Standardstil (standardmäßig Stil 3) verwendet wird. Die Titel der nachfolgenden Kapitel werden im Standardstil 4 dargestellt.

Bei Generierung der Funktionsdokumentation aus dem Dictionary werden diese Absätze automatisch auf Ebene 80 erstellt, wobei die Unterebenen mit 10 beginnen (Titel des Kapitels zu den Menüs) und in Zehnerschritten (20 = 1. Button, 30 = 2. Button usw.) nummeriert werden.

Anhangabsätze

In diesen abschließenden Absätzen sind Zusatzinformationen enthalten (Fehlerliste, Berichtsliste, Liste der Batchaufgaben etc.). Absätze:

Code RPT (Berichte)

Dieser Absatz ist in den Funktionsdokumentationen vorhanden und wird auf Ebene (50,10) mit Stil 4 generiert. In ihm werden die von der Funktion verwendeten Berichte aufgelistet. Der Absatz wird aus dem Dictionary generiert (Suche in den im Funktions-Dictionary für Druck und Liste definierten Druckcodes wobei geprüft wird, ob diesen in der Tabelle der Druckcodes Berichte zugeordnet sind). Die Liste dieser Berichte wird um die eventuell beim Durchsuchen der Beziehungstabelle nach Beziehungen zwischen der Funktion und den Berichten gefundenen Berichte ergänzt.

Bei Generierung der endgültigen Dokumentation wird eine Tabelle generiert, die sämtliche aus der Funktion heraus aufrufbare Berichte mit Hyperlinks zu den entsprechenden Dokumentationen umfasst.

Code ABT (Batchaufgaben)

Dieser Absatz ist in den Funktionsdokumentationen vorhanden und wird auf Ebene (60,10) mit Stil 4 generiert. In ihm werden die Batchaufgaben aufgelistet, die zum Aufruf der Funktion im Hintergrund verwendet werden können. Der Absatz wird aus dem Dictionary generiert (Suche in der Tabelle der Batchaufgaben). Die Liste dieser Aufgaben wird um die eventuell beim Durchsuchen der Beziehungstabelle nach Beziehungen zwischen der Funktion und den Berichten gefundenen Batchaufgaben ergänzt.

Bei Generierung der endgültigen Dokumentation wird eine Tabelle generiert, die eine Liste der vorhandenen Aufgaben umfasst.

Code ERR (Fehler)

Der in diesem Absatz erfasste Text wird direkt in das Dokument eingefügt und bietet eine Liste der Fehler, die während der Ausführung der Funktion möglicherweise angezeigt werden. Hier sollten lediglich Fehler aufgeführt werden, die speziell in der beschriebenen Funktion auftreten. Die generischen Fehler werden in einem speziellen Dokument aufgelistet, und in diesen Absatz wird automatisch ein Link zu diesem Dokument eingefügt. Der Absatz wird leer erstellt.

Dieser Absatztyp kann mit denselben Eigenschaften ebenfalls in der Dokumentation zu Import- / Exportmodellen verwendet werden.

Bei Funktionsdokumentation, die aus dem Dictionary generiert wird, wird dieses Kapitel automatisch auf Ebene (80,10) mit Stil 3 angelegt. Ist dem Absatz kein Text zugeordnet, so gibt es einen Verweis darauf, dass es sich bei den einzigen bekannten Fehlern um generische handelt (Zugriff über den Link). Andernfalls sind im Text die Fehler mit den entsprechenden erläuternden Texten aufgeführt. Für den Fehlertext sollte der Stil H5 verwendet werden, für die Erläuterung der Standardabsatzstil. Damit ergibt sich:

 Für den Fehlertext kann die 4GL-Syntax mess() verwendet werden. Damit bleibt der Fehlertext konsistent und wird auch konsistent übersetzt.

Beispiel:

Bei der Generierung:

Code ATB (verwaltete Tabellen)

Dieser Absatz ist in Funktionsdokumentationen, in Dokumentationen zu Dimensionierungsparametern, Import- / Exportmodellen, Berichten, Workflow-Ereignissen und Statistik-Triggern vorhanden. Es handelt sich um einen auf Ebene (100,10) mit Stil 3 generierten Absatz:

• In der Funktionsdokumentation wird der Absatz aus dem Dictionary generiert, wenn dort mindestens eine Tabelle gefunden wird (die Suche umfasst das Objekt und die Anzeige). Eine Funktion kann auch in der Beziehungstabelle eine Tabelle zugeordnet werden.
  HINWEIS für diese Dokumentation vom Typ AFC (und nur AFC): In der generierten HTML-Dokumentationsdatei werden alle diese "Ausführungsabsätze" ab sofort in eine zusätzliche HTML-Ausführungsdatei geschrieben. Dies dient der Trennung des funktionalen vom technischen Teil. Es wird ein Link von der ursprünglichen HTML-Datei zur Ausführungs-HTML-Datei angelegt.
• In den anderen Dokumentationen ist das Prinzip dasselbe: Der Absatz wird generiert, wenn im Dictionary Tabellen gefunden werden oder wenn Beziehungen gefunden werden.
• Bei der Dokumentation von Dimensionierungsparametern werden diejenigen Tabellen aufgelistet, deren Dimensionierung vom Parameter abhängig ist.

Bei Generierung der endgültigen Dokumentation werden die Tabellen tabellarisch dargestellt. Dabei wird auch ein Link zum Tabellen-Dictionary und (sofern vorhanden) zu demjenigen Objekt gegeben, mit dem die betreffende Tabelle verwaltet werden kann. Wenn Tabellen vorhanden sind, die von allen Ordnern gemeinsam verwendet werden, so werden diese in einem eigenen Absatz behandelt.

Spezieller Absätze

In der gesamten Dokumentation können zur Verwaltung von Ausnahmen und zur Verwaltung von nicht vorgesehenen Zusatzabsätzen spezielle Absätze eingefügt werden. Mit diesen können weiterhin zu lange Absätze aufgeteilt werden (die Länge von außerhalb von einem Absatz erfassten Texten ist begrenzt). Da der für diese Absätze verwendete Code wiederholt werden kann, wird ihnen keine Markierung mit demselben Namen vorangestellt (es werden jedoch dennoch technische Markierungen erstellt, die mit dem Absatzcode, gefolgt von Ebene und Unterebene, getrennt durch das Zeichen "_" nummeriert werden). Es handelt sich um folgende Felder:

Codes MIS (Sonstige)

Dabei handelt es sich um einen in der Inhaltstabelle der aktuellen Ebene befindlichen sonstigen Absatz. Es werden ein Titel, ein Stil sowie ein einzufügender Text angegeben.

Es können in einer Dokumentation mehrere Absätze von diesem Typ existieren. Der Link lautet dann entsprechend MIS_LEV_SLEV, wobei LEV die Ebene und SLEV die Unterebene ist.

Codes MIN (Sonstige)

Dabei handelt es sich um einen in der Inhaltstabelle der aktuellen Ebene nicht befindlichen sonstigen Absatz. Es werden ein Titel, ein Stil sowie ein einzufügender Text angegeben.

Es können in einer Dokumentation mehrere Absätze von diesem Typ existieren. Der Link lautet dann entsprechend MIN_LEV_SLEV, wobei LEV die Ebene und SLEV die Unterebene ist.

Codes LNK (Links)

In diesen Absatztyp können Inhaltsverzeichnisse in folgendem Format eingefügt werden:

• als Liste von Kopfzeilenlinks (in der Titelleiste der Dokumentation). Dies setzt voraus, dass sich auf der Ebene des Absatz TIT der entsprechenden Dokumentation auch ein Absatz vom Typ LNK befindet. Dem Absatztitel ist dann der Titel des aktuellen Dokumentes zu entnehmen, wie er in der Liste der Links definiert ist.
• als Liste von Links (wie ein Inhaltsverzeichnis) im allgemeinen Fall. In diesen Absatztyp können Links zu Dokumentationen eingefügt werden, die aus der Hierarchie des Dokumentes heraus nicht direkt zugänglich sind.

Wenn durch den Link ein einzelner Absatz definiert ist, werden Titel und Stil ignoriert, und im Inhaltsverzeichnis gibt es keinen Eintrag. Soll jedoch diesem Link-Absatz ein Titel hinzugefügt werden, so muss ihm lediglich ein Absatz vom Typ MIS oder MIN vorangestellt werden.

Die Links sind im Absatztext in einem der folgenden Formate definiert:

• CODE_FUNKTION
• CODE_FUNKTION#Link
• TYP/CODE
• TYP/CODE#Link

Erläuterung:

• CODE_FONCTION steht für den Code einer Funktionsdokumentation (vom Typ AFC oder DI): Der Link führt in das Unterverzeichnis FCT, in dem dieser Dokumentationstyp liegt.
• TYPE steht für die verschiedenen Dokumentationstypen: ADC, AD, ACV etc. Der dann folgende Code steht für den Dokumentationscode.
• Link entspricht einer Absatzmarkierung zur direkten Positionierung auf einem gegebenen Absatz. Bei Kopfzeilenlinks wird die Markierung ignoriert.

Bei der Generierung werden alle Links geprüft: Die entsprechende Dokumentation wird in der Tabelle ADOCUMENT gesucht (falls diese nicht vorhanden ist, wird der Link nicht eingefügt). Der Dokumentationstitel wird in den Link-Text eingefügt.

Codes INC (Einfügen)

In einen solchen Absatz können Absätze eingefügt werden, die bereits für eine andere Dokumentation erstellt wurden.

Mit Ausnahme von Absätzen vom Typ TIT können alle Absatztypen eingefügt werden. Soll ein Absatz aus einer anderen Dokumentation übernommen werden, so muss der ersetzende Absatz INC an erster Stelle in diesem Dokumentationstyp stehen und von einem Absatz vom Typ PRE gefolgt werden.

Es können in einer Dokumentation mehrere INC-Absätze existieren. Der Link lautet dann entsprechend INC_LEV_SLEV, wobei LEV die Ebene und SLEV die Unterebene ist.

Der zu übernehmende Absatz muss im Text des eingefügten Absatzes in einer der folgenden Formen gekennzeichnet sein:

• TYP/CODE
• TYPE/CODE/EBENE/UNTEREBENE

NIVEAU und SOUS-NIVEAU (Ebene und Unterebene) sind nicht obligatorisch (der auf derselben Ebene und Unterebene befindliche Absatz wird standardmäßig in die verbundene Dokumentation übernommen).

Beispiel: Zum Einfügen des Absatzes zum ersten Register des Benutzerdatenblattes, welcher auf Ebene 40, Unterebene 200 definiert ist, würde folgender Text in den eingefügten Absatz übernommen:

AFC/GESAUS/40/200

Hinweis: Es werden sämtliche Daten aus dem ursprünglichen Absatz übernommen (Titel, Stil, Text, Formatierung, Feldhilfen). Nur die Ebene und die Unterebenen bleiben unverändert (Berücksichtigung von Inhaltsverzeichnisumbrüchen). Der Titel des Inhaltsverzeichnisses entspricht dem Titel des ursprünglichen Absatzes INC. Die erstellte und für die Links verwendbare Markierung entspricht der generischen Markierung INC_rang_sous-rang.

Für andere Dokumentationen reservierte Absätze

Diese Absätze werden speziell für andere Dokumentationstypen als Funktionsdokumentationen verwendet. Absätze:

Code LEV (Ebene)

Dieser Absatz wird speziell für Parameterdokumentationen verwendet. Er wird auf Ebene (30,10) aus dem Dictionary generiert.

Bei der endgültigen Generierung wird ein Text generiert, dem die Definitionsebene des Parameters und der Name der zugehörigen globalen Variable (sofern vorhanden) zu entnehmen sind. Wird keine globale Variable gefunden, so wird ein Text eingefügt, dem dies zu entnehmen ist. Ausnahme: Der Datenblatttext ist belegt (in diesem Fall wird davon ausgegangen, dass eine nicht im Dictionary deklarierte Variable zitiert werden kann).

Code REM (Hinweise)

Dieser Absatz ist Parameterdokumentationen, Dokumentationen zu Automatik-Belegen und Dokumentationen zu Standardsektoren vorbehalten. Er wird auf Ebene (70,10) aus dem Dictionary leer erstellt.

Der im Datenblatt erfasste Text soll es ermöglichen, bestimmte Hinweise auszugeben.

Code PAR (Aktionsparameter)

Dieser Absatz wird speziell für Aktionsdokumentationen verwendet. Er wird auf Ebene (30,10) aus den Dictionary generiert und umfasst eine Liste der Aktionsparameter.

Bei der endgültigen Dokumentationsgenerierung wird ein einleitender Satz erstellt, dem eine Parametertabelle mit den Parametertiteln und den Datentyp folgt. Sind keine Parameter vorhanden, wird ein entsprechender Satz eingefügt.

Code UTI (Verwendungsarten der Aktion)

Dieser Absatz wird speziell für Aktionsdokumentationen verwendet. Er wird auf Ebene (40,10) aus dem Dictionary leer erstellt.

Der im Datenblatt erfasste Text soll es ermöglichen, die Verbindungsarten der Aktionen zu beschreiben.

Wenn dieser Absatz zum Generierungszeitpunkt der endgültigen Dokumentation leer ist, wird er nicht generiert.

Code ACT (zugeordnete Aktionen)

Dieser Absatz wird speziell für Aktionsdokumentationen verwendet. Er wird auf Ebene (50,10) generiert und umfasst eine Liste derjeniger Aktionen, die der dokumentierten Aktion zugeordnet sind. Die Generierung wird aus den Links (in beide Richtungen) gespeist, die zwischen den Aktionen gefunden werden.

Bei der endgültigen Dokumentationsgenerierung wird ein einleitender Satz erstellt, dem eine Aktionstabelle mit einen Link zu der entsprechenden Dokumentation folgt.

Code REC (empfohlene Werte)

Dieser Absatz wird speziell in Parameterdokumentationen und in Dimensionierungsparameterdokumentationen verwendet. Bei Parametern wird er leer angelegt, bei Dimensionierungsvariablen wird er generiert (bei leeren Absätzen wird standardmäßig eine Zeile erstellt, die den im Referenzordner gefunden Wert aufweist). Der Absatz wird auf Ebene (30, 10) angelegt.

Der im Datenblatt erfasste Text soll die für den entsprechenden Parameter empfohlenen Werte beschreiben.

Code AFC (betroffene Funktionen)

Dieser Absatz wird speziell in Dokumentationen zu Aktivitätscodes, allgemeinen Parametern und Berichten verwendet. Bei Aktivitätscodes und Berichten wird er auf Ebene (40, 10) generiert, bei allgemeinen Parameter auf Ebene (50, 10). Dadurch können folgende Daten ermittelt werden:

• Liste der vom Aktivitätscode betroffenen Funktionen. Die Generierung basiert auf den Links zwischen Funktionen und Aktivitätscodes (in beide Richtungen) sowie auf den Aktivitätscodes, die bei der Kurzanalyse des Dictionarys gefunden wurden (es werden lediglich diejenigen Funktionen übernommen, die direkt vom Aktivitätscode abhängen). Bei der endgültigen Dokumentationsgenerierung wird ein einleitender Satz erstellt, dem eine Funktionsliste mit einen Link zu der entsprechenden Dokumentation folgt.
• Zugriffsmethode auf die Berichte (Druckgruppen sowie Liste der Funktionen, von denen der Bericht aufgerufen werden kann). Die Generierung basiert auf der Analyse des Dictionarys und auf den Links zwischen Funktionen und Berichten (in beide Richtungen). Bei der endgültigen Dokumentationsgenerierung wird ein einleitender Satz erstellt, dem ein Automatik-Text und eine Liste von Funktionen nachgestellt werden. Der Text enthält Informationen darüber, ob der Bericht direkt ausgeführt werden kann und zu welcher Druckgruppe er gehört. Die Funktionsliste umfasst alle Funktionen, von denen der Bericht gestartet werden kann, sowie einen Link zu der entsprechenden Dokumentation.
• vom Parameter betroffene Sonderfunktionen

Code AT2 (zu belegende Tabellen)

Dieser Absatz wird speziell für Import- / Exportmodelldokumentationen verwendet. Bei dem Absatz handelt es sich um einen Unterabsatz zum Kapitel PRQ. Damit die Liste von Tabellen angegeben werden kann, die für die Verwendung des betreffenden Modells belegt sein müssen, wird der Absatz auf Ebene (30, 30) mit Stil 4 generiert. Die Generierung speist sich aus den Links zwischen den Import- / Exportmodellen und der Tabelle (vom Typ AT2).

Bei Generierung der endgültigen Dokumentation werden die Tabellen nach einem einleitenden Satz tabellarisch dargestellt. Dabei wird auch ein Link zum Tabellen-Dictionary und (sofern vorhanden) zu demjenigen Objekt gegeben, mit dem die betreffende Tabelle verwaltet werden kann. Wenn Tabellen vorhanden sind, die von allen Ordnern gemeinsam verwendet werden, so werden diese in einem eigenen Absatz behandelt.

Code CHO (obligatorische Felder)

Dieser Absatz wird speziell für Import- / Exportmodelldokumentationen verwendet. Er wird auf Ebene (40, 10) leer erstellt, damit die Liste der im entsprechenden Modell obligatorischen Felder gegeben werden kann.

Code CRI (Aufrufkriterien)

Dieser Absatz wird speziell in Berichts- und Unterprogrammdokumentationen verwendet.

Bei Berichten wird der Absatz standardmäßig auf Ebene (30, 30) in Stil 4 generiert, wobei die Daten aus dem Berichtsdictionary stammen und die folgenden Automatiktexte generiert werden:

• ein einleitende Satz, gefolgt von der Liste der Berichtsparameter (ein negativer Satz, wenn keine Parameter vorhanden sind)
• ein Satz für die Beschreibung des speziellen Verhaltens der Beginn- / Endeparameter, sofern vorhanden
• ein Satz, dem ggf. zu entnehmen ist, dass zu einem Parameter mehrere Werte erfasst werden können ((Segmentierung des Berichts)
• ein Satz, der ggf. darauf hinweist, dass abhängig vom Standort und von den Benutzerberechtigungen eine Datenfilterung ausgeführt wird
• ein Satz, dem ggf. zu entnehmen ist, dass der Bericht nur auf einem ganz bestimmten Druckertyp ausgedruckt werden kann

Bei Unterprogrammen wird der Absatz standardmäßig auf Ebene (20, 30) in Stil 4 generiert, wobei die Daten aus dem Unterprogrammdictionary stammen, damit die dem Unterprogramm zu übergebenden Paramter aufgelistet werden können.

Code DES (Berichtsbeschreibung)

Dieser Absatz wird speziell für Berichtsdokumentationen verwendet. Er wird leer auf Ebene (40, 10) erstellt und umfasst die Beschreibung des Berichtsinhalts.

Code CTX (Kontext)

Dieser Absatz wird speziell in Workflow-Dokumentationen zur Beschreibung der Trigger der Statistikereignisse und zur Beschreibung der Eingabepunkte verwendet.

Bei Triggern von Statistikereignissen und von Workflow-Ereignissen wird der Absatz auf Ebene (30, 10) leer angelegt, damit der Triggerkontext beschrieben werden kann.

Für Eingabepunkte kann es mehrere Absätze für diesen Typ geben. Dokumentationen von Eingabepunkten können mehrere Eingabepunkte umfassen. Für jeden wird auf Ebene 20, Unterebenen 10 und mit einer Ebenenschrittweite von 10 ein APE-Absatz erstellt. Auf der Ebene des APE-Absatzes wird auf Unterebene 20 ein zugehöriger CTX-Absatz erstellt. In diesem Fall lautet der Link CTX_LEV_SLEV, wobei LEV die Ebene und SLEV die Unterebene ist.

Bei Generierung der endgültigen Dokumentation werden in diesen Absatz folgende Automatiktexte eingetragen:

• laufende Transaktion vorhanden oder nicht vorhanden (Link vom Typ TRS im Verarbeitungsdictionary, Wert 1 steht für keine Transaktion, Wert 2 steht für Transaktion vorhanden)
• laufende Protokolldatei vorhanden oder nicht vorhanden (Link vom Typ TRA im Verarbeitungsdictionary, Wert 1 steht für keine Protokolldatei, Wert 2 steht für Protokolldatei geöffnet)

Dieser Absatz umfasst auch eine tabellarische Liste der Onlinetabellen. Diese Liste wird über Links vom Verarbeitungs-Dictionary zu bestimmten Tabellen generiert. Hierbei bedeutet ein Link vom Typ ATB, dass die Tabelle geöffnet und in diesem Kontext belegt ist. Ein Link vom Typ AT2 bedeutet nur, dass die Tabelle geöffnet ist. Hinweis: Diese Links können im Format TABELLENCODE [ABKÜRZUNG] erfasst werden, sofern die Tabelle nicht unter ihrer Hauptabkürzung geöffnet ist.

Code APE (Eingabepunkt)

Dieser Absatz wird speziell für Eingabepunkte verwendet.

Für Eingabepunkte kann es mehrere Absätze für diesen Typ geben. Dokumentationen von Eingabepunkten können mehrere Eingabepunkte umfassen. Für jeden wird auf Ebene 20, Unterebenen 10 und mit einer Ebenenschrittweite von 10 ein APE-Absatz erstellt. In diesem Fall lautet der Link APE_LEV_SLEV, wobei LEV die Ebene und SLEV die Unterebene ist. Auf der Ebene des APE-Absatzes wird auf Unterebene 20 ein zugehöriger CTX-Absatz erstellt.

Bei Funktionsdokumentation, die aus dem Dictionary generiert wird, wird der erste dieser Absätze automatisch auf Ebene (20), Unterebene 3 angelegt. Für die nächsten Absätze wird eine Ebenenschrittweite von 10 verwendet. Der Code der Eingabepunkte wird über einen Link vom Typ APE ermittelt, wobei sich der Code des Eingabepunktes aus der zugehörigen Bezeichnung ergibt. Diesem Link werden eventuell Links vom Typ ATB, AT2, TRA, TRS nachgestellt, wobei es hierbei auf die Deklarierungsreihenfolge ankommt (da es mehrere APE-Links geben kann, müssen die anderen Links auf den jeweils letzten deklarierten Link referenzieren).

Der Eingabepunkt ist dann dem Absatztitel zu entnehmen. Dieser Code muss zwingend vor dem Titel stehen (er kann durch eine Erläuterung oder einen Einführungstext ergänzt werden, wobei als Trennzeichen ein Leerzeichen oder eine öffnende Klammer zu verwenden ist). Bei Abweichungen von dieser Vorgehensweise kann die endgültige Dokumentation nicht mehr korrekt generiert werden.

Bei Generierung der endgültigen Dokumentation werden in diesen Absätzen folgende Automatiktexte eingetragen:

• laufende Transaktion vorhanden oder nicht vorhanden (Link vom Typ TRS im Verarbeitungsdictionary, Wert 1 steht für keine Transaktion, Wert 2 steht für Transaktion vorhanden)
• laufende Protokolldatei vorhanden oder nicht vorhanden (Link vom Typ TRA im Verarbeitungsdictionary, Wert 1 steht für keine Protokolldatei, Wert 2 steht für Protokolldatei geöffnet)

Diese Absätze umfassen auch eine tabellarische Liste der Onlinetabellen. Diese Liste wird über Links vom Verarbeitungs-Dictionary zu bestimmten Tabellen generiert. Hierbei bedeutet ein Link vom Typ ATB, dass die Tabelle geöffnet und in diesem Kontext belegt ist. Ein Link vom Typ AT2 bedeutet nur, dass die Tabelle geöffnet ist. Hinweis: Diese Links können im Format TABELLENCODE [ABKÜRZUNG] erfasst werden, sofern die Tabelle nicht unter ihrer Hauptabkürzung geöffnet ist.

Code OPM (Verwendungsmodus)

Dieser Absatz ist Dokumentationen zu Automatik-Belegen und Dokumentationen zu Standardsektoren vorbehalten. Er wird leer auf Ebene (30, 10) erstellt und umfasst die Beschreibung des Verwendungsmodus.

Code FLW (Flussbeschreibung)

Dieser Absatz wird speziell für Workflow-Dokumentationen verwendet. Er wird niemals automatisch erstellt. Es wird empfohlen, ihn auf Ebene (40, 10) zu erstellen. Dieser Absatz umfasst die Beschreibung des Workflows, zu dem das Ereignis gehört.

Zusammenfassung der Absatzstruktur

Nachstehend werden für jeden Dokumentationstyp die generierten Absätze und ihre Standardstruktur angegeben (die Absätze INC, LNK, MIS und MIN können frei eingefügt werden).

AFC (Funktionsdokumentation)

Diese im Verzeichnis FCT angelegte Dokumentation kann folgende Absätze umfassen:

ADP (Parameterdokumentation)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

ACT (Aktionsdokumentation)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

Hinweis zum Absatz PRE:

• Der Inhalt dieses Absatzes wird direkt im Aktionsdictionary angezeigt und kann auch direkt in diesem Dictionary geändert werden
• Wenn der Absatz leer ist, wird ein Standardtext generiert (diesem ist zu entnehmen, ob es sich um eine interne, für individuelle Entwicklungen nicht verwendbare Aktion handelt)

ACV (Dokumentation zu Aktionscodes)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

ADM (Dokumentation zu Dimensionierungsvariablen)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

AOE (Dokumentation zu Import- / Exportmodellen)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

ARP (Berichtsdokumentationen)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

AWA (Workflow-Dokumentationen)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

CDE (Dokumentationen zu Sektorcodes)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

CDA (Druckerdokumentation)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

GAU (Dokumentation zu Automatik-Belegen)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

PS1 (Dokumentation zu Statistik-Triggern)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

ATB (Tabellendictionary)

Dieser Dokumentationstyp wird im Verzeichnis mcd angelegt und umfasst lediglich einen Absatz:

AML (Dictionary der Lokalen Menüs)

Dieser Dokumentationstyp wird im Verzeichnis mcd angelegt und umfasst lediglich einen Absatz:

ATY (Dictionary der Datentypen)

Dieser Dokumentationstyp wird im Verzeichnis mcd angelegt und umfasst lediglich einen Absatz:

ADC (Dictionary der Eingabepunkte)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

ASU (Unterprogrammdokumentation)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

Hinweis zum Absatz PRE:

• Der Inhalt dieses Absatzes wird direkt im Unterprogrammdictionary angezeigt und kann auch direkt in diesem Dictionary geändert werden
• Wenn der Absatz leer ist, wird ein Standardtext generiert (diesem ist zu entnehmen, ob es sich um ein internes, für individuelle Entwicklungen nicht verwendbares Unterprogramm handelt)

AGB (Variablendokumentation)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

Hinweis zum Absatz PRE:

• Der Inhalt dieses Absatzes wird direkt im Variablendictionary angezeigt und kann auch direkt in diesem Dictionary geändert werden
• Wenn der Absatz leer ist, wird ein Standardtext generiert (diesem ist zu entnehmen, ob es sich um eine interne, für individuelle Entwicklungen nicht verwendbare Variable handelt)

AHI (Dok. zu Bereinigungsregeln)

Diese im Verzeichnis OBJ angelegte Dokumentation kann folgende Absätze umfassen:

APM (Zwischenmenüs)

Dieser Dokumentationstyp wird in zwei Fällen verwendet:

• Wenn eine Funktion vom Typ Menü vorhanden ist, wird eine Dokumentation vom Typ APM mit einem einzigen Absatz vom Typ TIT generiert. Während der endgültigen Generierung wird die Liste der dem Menü zugeordneten Funktionen gesucht, um diese auflisten zu können.. In diesem besonderen Fall können Links direkt in den Absatz eingefügt werden (hierfür wird dieselbe Syntax verwendet wie in den LNK-Absätzen). Damit ist es möglich, den im Dictionary gefundenen Menüzeilen weitere hinzuzufügen.
• Sämtliche in den sonstigen Dokumentationen (Aktivitätscodes, Workflow-Ereignisse etc.) vorhandene Zwischenmenüs sind vom Typ APM. Ihr Name beginnt mit dem dem Dokumentationstyp zugeordneten Code, gefolgt vom Zeichen "_" und einer Id (Modul, Gruppe), sofern dies für die Verwendung der Zwischenmenüs notwendig ist. Das Hauptmenü weist den Code TYPE_0 auf. Beispiel:
• Die den Aktivitätscodes zugeordneten Zwischenmenüs lauten: ACV_0 Wurzel), ACV_1 (Aktivitätscodes des Moduls 1, ACV_2 etc.)
• Die den Parametern zugeordneten Zwischenmenüs lauten: ADP_0 (Wurzel), ADP_TC (Parameter der Kategorie TC), ADP_SUP (Parameter der Kategorie SUP) etc.

Hinweis: Sonstige Dokumentationen zur Ausführung von Zwischenmenüs müssen im Format des Typs DI mit folgenden Absätzen erstellt werden: Absatz TIT in (10, 10), Absatz PRE in (10, 20), ein möglicherweise leerer Absatz, eventuell ein erster LNK-Absatz mit Rang (10, 30) zur Belegung der Titelleiste mit den Navigationslinks, ein Absatz LNK mit Rang >= 20 zur Aufstellung der Liste der Linkeinträge des eigentlichen Menüs.

AD (Onlinehilfe der Sprache)

Dieser Dokumentationstyp wird im Verzeichnis 4GL erstellt. Die Struktur dieses Dokumentes ist frei wählbar. Der einzige obligatorische Absatz ist:

Ist dieser Absatz vorhanden, wird zu dem Datenblatt keine Datei generiert. Die zugehörige Datei wird lediglich unter dem Dokumentationsnamen ausgegeben, sofern sie vorhanden ist. Diese Funktionalität wurde geschaffen, um eine analoge Vorgehensweise zur vorhandenen 4GL-Dokumentation zu ermöglichen, in der jedes Dokument als Datenbankdatei behandelt wird.

Ist mehr als ein Absatz vorhanden (insbesondere, wenn Absätze vom Typ in MIS oder MIN hinzugefügt wurden), so wird die Dokumentation nach den üblichen Regeln erstellt.

Hinweis: Dokumentationen, deren Code auf _D endet, werden zusammen mit einer Datei erstellt, deren Namen auf $ endet. Diese Umbenennungsregel wird verwendet, um die Erstellung von Schlüsseln zu vermeiden, die Sonderzeichen beinhalten. Den Funktionen seg$, chr$ und getenv$ sind also die Datenblätter SEG_D, CHR_D und GETENV_D zugeordnet.

FI (Ausgabedateien)

Dabei handelt es sich um einen speziellen Typ, nämlich um lediglich eine Markierung für Ausgabedateien. Benennungsregeln:

• Dokumentationen vom Typ FI mit Code XXXXX_nnn sind Markierungen für Dateien, die in das Verzeichnis XXXXX auszugeben sind (dabei kann es sich um ein beliebiges Standardverzeichnis handeln). Es können so viele Absätze erstellt werden, wie z. B. verschiedene Dateigruppen definiert werden sollen.
• Dokumentationen vom Typ _nnn sind Markierungen für Dateien, die in alle XXXXX-Verzeichnisse auszugeben sind, für die eine Dokumentation vom Typ FI mit Code XXXXX_nnn vorhanden ist. Konkret wird bei Generierung der Dokumentation vom Typ FI mit Code XXXXX_nnn geprüft, auch Absätze derselben Ebene und Unterebene in der Dokumentation vom Typ FI mit entsprechendem Code _nnn vorhanden sind (die Nummer muss identisch sein). Sind solche Absätze waren, werden diese Dateien vorrangig ausgegeben. Erst danach werden die Dateien ausgegeben, die mit der Dokumentation mit Code XXXXX_nnn verbunden sind. In einer solchen Dokumentation kann also ein gemeinsamer Dateistamm definiert werden. Manche dieser Dateien können bei Ausgabe der Dokumentation mit dem entsprechenden Code XXXXX_nnn wieder überschrieben werden.
• Dokumentationen vom Typ FI mit Code _ (Zeichen Unterstrich) markieren Dateien, deren Generierung die Erstellung von speziellen Dateien im Wurzelverzeichnis der Hilfe nach sich zieht. Bei der Generierung dieser Dokumentation werden zunächst sämtliche mit den Dokumentationen vom Typ FI mit Code _nnn verbundenen Dateien in das Wurzelverzeichnis ausgegeben, deren erste Ziffer 0 lautet (und die auf der entsprechenden Ebene und Unterebene liegen).

Sonstige Dokumentationstypen

Bei den anderen Dokumentationstypen (DI, IN, CS, DL, AM) handelt es sich um Dokumentation ohne feste Struktur, bei der lediglich für jeden Typ das Generierungsverzeichnis definiert ist). Der einzige obligatorische Absatz ist TIT.

Ist dieser Absatz vorhanden, wird zu dem Datenblatt keine Datei generiert. Die zugehörige Datei wird lediglich unter dem Dokumentationsnamen ausgegeben, sofern sie vorhanden ist.

Ist mehr als ein Absatz vorhanden (insbesondere, wenn Absätze vom Typ in MIS oder MIN hinzugefügt wurden), so wird die Dokumentation nach den üblichen Regeln erstellt.

In der folgenden Tabelle sind die Generierungsverzeichnisse jeweils identisch:

Inhaltsverzeichnisse der Dokumentation

Die Inhaltsverzeichnisse der Dokumentation sind mit dem Dokumentationstyp APM verbunden. In der Regel ist hierfür nur ein Absatz vorhanden:

Dieser Absatz kann in Textform eine Liste von Dokumentationscodes umfassen. In diesem Fall wird jeder Listeneintrag behandelt wie ein Link zu der entsprechenden Dokumentation (der Dokumentationstitel wird in die entsprechende Dokumentation übernommen). Dadurch ist es möglich, Inhaltsverzeichnisse sowohl manuell anzulegen als auch einem vorhandenen Inhaltsverzeichnis weitere Links hinzuzufügen.

Bei der Generierung der Dokumentation aus dem Dictionary werden automatisch Dokumentationen vom Typ APM mit TIT als einzigem Absatz generiert. Nachstehender Tabelle sind die Codes der angelegten Dokumentation sowie die während der endgültigen Generierung erstellten Inhaltsverzeichnisse der Dokumentation zu entnehmen:

Für die nicht aufgelisteten Dokumentationstypen kann eine Dokumentation mit Code INDEX erstellt werden. Sind solche Dokumentationen vorhanden wird jeweils in die Titelleiste ein Link aufgenommen. Ein Index dieses Typs wird z. B. von den Dokumentationen vom Typ IN und DL verwendet.

Verwaltung der Dokumentationstabellen

Die Struktur der Dokumentation wird in der Tabelle ADOCUMENT gespeichert. In dieser Tabelle werden die Eigenschaften der einzelnen Absätze und Unterabsätze geführt (Ebene, Unterebene, Titel, Aktivitätscode etc.).

Der Absatztext hingegen wird hiervon getrennt in der Tabelle ADOCCLB gespeichert. In dieser Tabelle finden sich lediglich die Schlüsselelemente des Absatzes und der eigentliche Absatztext.

Vorteil:

• Sämtliche Standardabsätze der Dokumentation werden im Superivsor-Wurzelverzeichnis gespeichert.
• Bei der Erstellung eines Ordners wird die Tabelle ADOCUMENT dupliziert, jedoch nicht die Texte der eigentlichen Dokumente.
• Individuelle Absätze werden stets in einen untergeordneten Ordner hinzugefügt, die zugehörigen Texte werden in demselben Ordner gespeichert.
• Bei Änderungen an Standardabsätzen wird der betreffende Datensatz von der Tabelle ADOCCLB des Wurzelordners in den untergeordneten Ordner kopiert.

Auf diese Weise werden lediglich individuelle Texte im untergeordneten Ordner gespeichert.

Dasselbe gilt für die mit der Feldhilfe verbundenen Texte: Die Standardtexte werden in der Tabelle ADOCFD des Wurzelordners gespeichert, die individuellen Texte werden im eigentlichen Ordner gespeichert.

Bei Generierung der Dokumentation wird die im lokalen Ordner gehaltene Struktur durchlaufen. Zu jedem Absatz wird vorrangig der im lokalen Ordner vorhandene Text übernommen. Existiert kein solcher, wird der Text aus dem Wurzelordner berücksichtigt.