Dokumentation

• Sprache (Feld LAN)

Dieser Bereich bezieht sich auf die Sprachentabelle und definiert die Sprache, in der die Dokumentation verfasst ist.

• Dokutyp (Feld TYP)

Dieses Feld definiert den Dokumentationstyp. Jeder Typ ist einem dokumentierten Elementtyp zugeordnet (Funktionsdokumentation, Dokumentation eines Dictionary-Datenblatts oder Dokumentation von Parameterwerten, Dokumentation der Dictionary-Struktur, sonstige).

Für Dokumentationstypen mit dem entsprechenden Objektcode wird in der Menüleiste des entsprechenden Objekts automatisch ein Eintrag Dokumentation angelegt. Über Auswahl dieses Menüpunkts können die am jeweiligen Objekt erfassten Datenblätter dokumentiert werden. Aus diesem Grund lautet der Code der Funktionshilfe AFC (Objektcode Funktionen) und der Code der Allgemeinen Parameter ADP (Objektcode Parameter).

Die Regeln zur Benennung der Dokumentationen sind in einer angehängten Dokumentation definiert.

• Code (Feld COD)

Dieses Feld definiert den Dokumentationscode. Er entspricht in der Regel dem Code des dokumentierten Datenblatts (Funktion, Parameter). Die Regeln zur Benennung der Dokumentationen sind in einer angehängten Dokumentation definiert.

• Ebene (Feld LEV)

Diese Ebene baut eine Hierarchie in den Absätzen auf. Jeder erste Absatz einer Ebene befindet sich in der Hauptmaterialtabelle (außer beim Typ MIN).

• Unterebene (Feld SUBLEV)

Diese Unterebene etabliert eine Unterhierarchie in den Absätzen. Gibt es mehr als eine Unterebene pro Dokumentationsebene, wird eine zweite Materialtabelle im ersten Unterabsatz einer Ebene aufgebaut, wodurch die Verknüpfungen zu den folgenden Unterabsätzen angezeigt werden (außer wenn der Unterabsatz vom Typ MIN ist).

• Absatz (Feld PAR)

Der Absatzcode bestimmt die Art und Weise, auf die der Absatz im finalen Dokument erzeugt wird. Dies kann eine einfache Kopie des Textes sein, oder eine komplexere Generierung abhängig vom Dictionary. Eine angehängte Dokumentation detailliert die verwendbaren Absatzcodes abhängig vom Dokumentationstyp.

• Maske (Feld MSK)

Wird ein Maskencode in diesem Feld erfasst, ermöglicht ein Piktogramm im Absatztitel der erzeugten Dokumentation die Erweiterung eines Bereichs, der die Liste der Maskenfelder und die zugewiesene Feldhilfe enthält. Es wird daher empfohlen, einen Absatzstil von 4 zu verwenden (volles Banner, auf dem das Erweiterungspiktogramm lesbar angezeigt wird).

• Bezeichnung (Feld TIT)

Dieses Feld ist der Absatztitel. Wird kein Absatztitel vorgegeben, wird in Abhängigkeit vom Absatztyp ein Standardtitel zugewiesen (dies gilt bei Anlage und Änderung).

Die Zuweisung eines Titels kann bei sonstigen, nicht in der Inhaltstabelle vorhandenen Absätzen (vom Typ MIN) durch Eingabe des Zeichens "! "unterdrückt werden.

• Aktivitätscode (Feld CODACT)

Mit dem bei der erneuten Generierung vom Dictionary geerbten Aktivitätscode, kann speziell zwischen Standard- und Sonderdatenblättern unterschieden werden, und zusätzlich können Dokumentationen zu bestimmten Ordnern generiert werden, die sich auf die im Ordner aktivierten Aktivitätscodes beschränken. Hierbei ist zu beachten, dass der Aktivitätscode FAL (immer falsch) besonders berücksichtigt wird: ein Absatz mit diesem Code wird von der Generierungsverarbeitung auch bei Generierung der kompletten Dokumentation nie berücksichtigt. Auf diese Art können generierte Absätze, die in keiner Dokumentation enthalten sein sollen, deaktiviert werden.

• Modul (Feld MODULE)

Zugehörigkeitsmodul des Dokumentationsparagraphs.

• Stil (Feld STY)

Der Stil bezieht sich auf einen numerischen Wert, der einer Markierung "H1","H2,"H3"... nach der ausgewählten Nummer entspricht. Ist das Feld leer, wird standardmäßig 3 genommen. Für die Unterabsätze sollte je nach Ebene 4, 5 oder 6 verwendet werden. Der Titel 4 ist im Banner vorhanden: ein Piktogramm, über das man zu den Feldhilfen gelangt, ist dort sichtbar, wenn dem Absatz eine Maske zugeordnet ist.

• Priorität Übersetzung (Feld PRIO)

• Gruppe Eigentümer (Feld CREGRP)

Diese Felder ermöglichen die Anzeige der Gruppe, die die betroffene Dokumentation erstellt hat.

Sie ist nur in den Umgebungen verfügbar, in denen dieser Begriff implementiert wurde. Das betrifft die Umgebungen, in denen der Benutzerparameter GRPDEV vorhanden ist.

Hinweis: Die Gruppe wird in rot angezeigt, wenn die Benutzergruppe sich von der Erstellergruppe in der Tabelle AOBJGRPDEV unterscheidet.

• Freigabe (Feld VLDDAT)

Entspricht dem Datum, an dem die Datei als gültig angesehen wurde.

• Feld VLDFLG

Dieser Indikator bedeutet, dass die Datei als gültig angesehen wurde.

• Feld TEXTE

Dieses Feld ermöglicht die Erfassung eines Absatztextes, so wie er in der finalen Dokumentation erscheint. Spezielle Fälle müssen angemerkt werden:

• bestimmte Absätze werden nicht ohne weitere Bearbeitung eingefügt. Dies gilt insbesondere für Titelabsätze, die eine Liste mit Schlüsselworten enthalten, die im HTML-Code der Dokumentation eingefügt wurden (Rubrik Keywords).
• bestimmte Absätze werden aus dem Dictionary erzeugt. Der hier erfasste Text ist also ein Zusatz (je nach dem vor oder nach dem erzeugten Text) und ist nicht generell erforderlich.
• in den Dokumentationen vom Typ APM (Zusammenfassung der den Menüebenen entsprechenden Dokumentationen) wird der erfasste Text als eine Liste von zusätzlichen Verknüpfungen zu den entsprechenden Dokumentationen angesehen (die automatischen Verknüpfungen wurden erzeugt).