Export Dokumentation
Mit dieser Funktion können alle Absätze einer Dokumentation als XML-Datei ausgegeben werden.
Drei Ausgabemöglichkeiten:
- Ausgabe zur (erneuten) Übersetzung: Mit dieser Auswahl kann eine bereits übersetzte Dokumentation ausgegeben werden, die nicht mehr im Arbeitsbereich erscheint, aber dennoch aufgrund von Änderungen an den Inhalten ohne Änderung des Gültigkeitsdatums erneut übersetzt werden muss. Die Header sind in der Zielsprache der Ausgabe verfasst, die Dokumentationsinhalte in der Originalsprache. Es werden dann die Plausiprüfungen zwischen Original- und Zielsprache durchgeführt, die Gültigkeitsprüfungen hingegen entfallen. Mit der Option "Ausgabe zur (erneuten) Übersetzung" kann also Dokumentation zur erneuten Übersetzung mit dem Übersetzungstool ausgegeben werden.
- Ausgabe zur Übersetzung: Diese Auswahl ersetzt vollständig die Planungsmaske Arbeitsbereich. Sie dient der Generierung von Dokumenten für die Übersetzung mit einem beliebigen Übersetzungstool. Die Header sind in der Zielsprache der Ausgabe verfasst, die Dokumentationsinhalte in der Originalsprache. Es werden dann die Plausiprüfungen zwischen Original- und Zielsprache sowie die Gültigkeitsprüfungen durchgeführt. Somit können mit der Option "Ausgabe zur Übersetzung" beispielsweise sämtliche freigegebenen Dokumentationen zur Übersetzung in eine bestimmte Sprache ausgegeben werden.
- Ausgabe nach Sprachen: Ausgabe sämtlicher Inhalte für eine oder mehrere Sprachen. Header und Inhalte der Dokumentation sind in der Zielsprache der Ausgabe geschrieben. Über eine Option kann die Dokumentationsauswahl auf "freigegebene", "nicht freigegebene" bzw. "alle" eingeschränkt werden. Ausgabe sämtlicher Inhalte für eine Sprachen, beispielsweise zwecks Wortzählung.
Für die Ausgabe zur Übersetzung mit Übersetzungswerkzeugen für XML-Dateien muss die Funktion Arbeitsplatz Dokumentation verwendet werden.
Die Ausgabe erfolgt standardmäßig in ein zuvor angelegtes xml-Verzeichnis. Existiert kein solches, erfolgt die Ausgabe in das Verzeichnis, das durch den Parameter DIRDOCDIRDOC bestimmt ist.
Für den umgekehrten Arbeitsgang steht die Funktion Dokumentationsimport zur Verfügung.
Vorbedingungen
Siehe Dokumentation Umsetzung
Maskenverwaltung
Erfassungsmaske
Übersicht
In der Maske werden die Auswahlkriterien für die Ausgabe erfasst. Ausgegeben werden können:
- Dokumentationen zu Funktionen, funktionellen Objekten oder (über ihren Typ definierten) Objekten.
- Feldhilfen, die entweder separat oder zusammen mit der Funktionshilfe ausgegeben werden können. Die zur Funktionshilfe gehörenden Feldhilfen werden dabei als separate Dateien ausgegeben.
- Verbundene Dateien.
Schließen
Felder
In diesem Register befinden sich die folgenden Felder :
Ausgabe
| Ausgabe zur (Neu-)Übersetzung: Ausgabe zur (Neu-)Übersetzung einer Dokumentation in eine Zielsprache nach einer Referenzsprache. In diesem Fall wird kein Gültigkeitsdatum getestet. |
| Ausgabe zur Übersetzung: Ausgabe zur Übersetzung einer Dokumentation in eine Zielsprache nach einer Referenzsprache. |
| Definiert die Zielsprache |
| Definiert den Code der Sprache, aus der übersetzt wird. |
Ausgabe
| Ausgabe pro Sprache: einfache Ausgabe nach einer oder mehreren Ausgabesprachen. |
| Bei Aktivierung dieser Option werden alle Sprachen beim Arbeitsgang berücksichtigt. |
| Zu bearbeitender Sprachcode, falls nur einer vorhanden. |
|
|
|
|
|
|
XML-Ausgabe
| Verzeichnis für den Dokumentationsimport. Die Feldhilfen werden aus dem Unterverzeichnis FLD importiert, die verbundenen Dateien aus dem Unterverzeichnis FILE, sofern ihr Dateiname den entsprechenden Sprachcode enthält. Standardmäßig wird der Benutzerparameter DIRDOC zur Initialisierung des Verzeichnisses verwendet. Für das Erfassungsformat des Ausgabeverzeichnisses gibt es 4 Formen:
|
| Gibt an, ob das Unterverzeichnis pro Dokumentationstyp zur Verknüpfung mit dem Hauptverzeichnis verwendet wird, aus dem der Dokumentationsexport stattfindet. Die verknüpften Feldhilfen werden im Unterverzeichnis pro Typ, dann FLD ausgegeben. |
| Diese Felder ermöglichen die folgende Auswahl:
|
Auswahl
| Aktivieren Sie dieses Kontrollkästchen, um alle Typen einzuschließen. Lassen Sie dieses Kontrollkästchen deaktiviert, um diese Verarbeitung für einen einzigen Typ auszuführen. |
| Zu bearbeitender Dokumentationstyp, falls nur einer vorhanden. |
|
|
| Bei Aktivierung dieser Option werden alle Codes bei dem Arbeitsgang berücksichtigt. Ist die Option nicht aktiviert, werden lediglich die Codes bearbeitet, die im erfassten Bereich liegen. |
| Hier kann der erste, vom Vorgang zu berücksichtigende Kriteriumswert eingegeben werden. |
| Hier kann der letzte, vom Arbeitsgang zu berücksichtigende Kriteriumswert eingegeben werden. |
|
|
|
|
|
|
|
|
|
|
|
|
Optionen
| Ist diese Option aktiviert, werden auch die mit den Dokumentationen verbundenen Dateien bearbeitet. Dabei handelt es sich in der Regel um Bilder. |
| Wird diese Option aktiviert, werden nur die Feldhilfen zu den anderweitig bearbeiteten Funktions- oder Ojektdokumentationen bearbeitet. Welche Feldhilfen zu bearbeiten sind, ist den zu den Dokumentationsabsätzen gehörigen Bildschirmen zu entnehmen. |
| Ist diese Option ausgewählt, wird auch die Feldhilfe verarbeitet. Spezialfall: Option 'Ausgabe zur Neuübersetzung'Um eine oder mehrere einzelne Feldhilfen auszugeben, die unabhängig von einer Funktionshilfe sind, Alle Typen abwählen, dem Feld herausgehen und einen Bereich im Typ einfügen. |
| Schränkt die Bearbeitung der Feldhilfen auf zwei Schlüsselwörter ein. |
|
|
|
|
Schließen
Anhang: Format der angelegten Dateien
Im Folgenden wird das Format der XML-Dokumentationsdateien beschrieben:
- xml-Header normalisiert
- DOC-Markierung mit den Attributen TYPE, NAME (durch die Dokumentationstyp und -code festgelegt sind).
- Innerhalb des DOC-Tags jedes Absatzes gibt es einen PAR-Tag mit den Attributen LAN, LEV, SUBLEV, PAR, MSK, STY, VLDDAT, VLDFLG, ACT und MOD (in der Reihenfolge für Sprache, Level, Sublevel, Absatzcode, Maske, Stil, Gültigkeitsdatum, Gültigkeitsindikator, Aktivitätscode und Modul).
- Innerhalb des PAR-Tags gilt ein TIT-Tag ggf. den Absatztitel an (falls vorhanden).
- Innerhalb des PAR-Tags gibt ein HTML-Tag ggf. den Absatztext an (falls vorhanden).
Die Feldhilfedateien befinden sich im FLD-Unterverzeichnis des xml-Ausgabeverzeichnisses. Für sie gilt folgendes Format:
- xml-Header normalisiert
- Ein FLD-Tag mit den Attributen NAME, LAN, MOD, GEN, LNKHLP, LNKORD, CREDAT, UPDDAT (für Name, Sprache, Modul, generisches Dokumentationsattribut, verbundene Hilfe, Anlage- und Änderungsdatum).
- Innerhalb des FLD-Tags gibt ein HTML-Tag ggf. den Absatztext in XHTML an (falls vorhanden).
Die Feldhilfedateien befinden sich im FILE-Unterverzeichnis des xml-Ausgabeverzeichnisses. Der Dateiname setzt sich wie folgt zusammen:
COD_LAN_TYP_LEV_SUBLEV_LIG_NOMFICHIER_LGCLE.EXT wobei:
- COD_LAN_TYP_LEV_SUBLEV_LIG sich aus dem Schlüssel der verbundenen Datei in Tabelle ADOCBLB zusammensetzt (um eine einheitlichere Namensgebung zu gewährleisten).
- LGCLE die vorherige Schlüssellänge enthält, um den Dokumentationscode korrekt ausgeben zu können.
- NOMFICHIER und EXT entsprechen dem Dateinamen (Name und Erweiterung), falls dieser in ADOCBLB angegeben wurde. Sonst setzt sich der Dateinamen aus IMG, einer dreistelligen Positionsnummer (falls notwendig mit führenden Nullen) sowie der Dateierweiterung ".jpg" zusammen.