Dokumentationsimport
Mit dieser Funktion können alle zuvor ausgegebenen Absätze einer Dokumentation als XML-Datei importiert werden. Das Ziel dabei ist es, die zuvor mit XML-Übersetzungstools übersetzten Dokumentationsdateien wieder zu importieren.
Der Import erfolgt standardmäßig in ein zuvor angelegtes xml-Verzeichnis. Existiert kein solches, erfolgt die Ausgabe in das Verzeichnis, das durch den Parameter DIRDOC bestimmt ist.
Die Dateien wurden zuvor entweder mit der Funktion Arbeitsplatz Dokumentation oder mit der Funktion Ausgabe Dokumentation ausgegeben.
Vorbedingungen
Siehe Dokumentation Umsetzung
Bildschirmverwaltung
Register Erfassungsbildschirm
Übersicht
Im Bildschirm des aktuellen Verzeichnisses werden die zu importierenden Dokumentationen sowie einige Optionen erfasst. Danach werden die im Verzeichnis vorhandenen Dateien gelesen und importiert.
Schließen
Felder
In diesem Register befinden sich die folgenden Felder :
Auswahl
| Verzeichnis für den Dokumentationsimport. Die Feldhilfen werden aus dem Unterverzeichnis FLD importiert, die verbundenen Dateien aus dem Unterverzeichnis FILE, sofern ihre 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:
|
| Bei Vorgabe der Sprache wird geprüft, ob die für die gefundenen Dateien definierte Sprache der vorgegebenen Sprache entspricht. |
| 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. |
| 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. |
Import
| Autorisiert den Import von neuen Absätzen |
|
|
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.