Arbeitsplatz Dokumentation
Mit dieser Funktion kann der Fortschritt einer Übersetzung angezeigt werden. In den Parametern LANTRA und LANREF können die Ausgangs- und die Zielsprache festgelegt werden.
Weiterhin können mit der Funktion Dokumentationen und Feldhilfen zur Übersetzung ausgegeben werden. Für die Übersetzung werden Werkzeuge verwendet, mit denen sich XML-Dateien übersetzen lassen. Die Ausgabe 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.
Vorbedingungen
Siehe Dokumentation Umsetzung
Bildschirmverwaltung
Mit dieser Funktion kann der Fortschritt einer Übersetzung im Vergleich zu einer Ausgabesprache angezeigt werden.
Weiterhin können mit dieser Funktion zu übersetzende Dokumentationen und Feldhilfen im XML-Format ausgegeben werden.
Die Funktion durchläuft drei Register:
- Im ersten Register wird der Übersetzungsfortschritt angezeigt. Das Register wird bei Klick auf folgenden Button geladen:
- Im zweiten Register kann mit folgendem Button eine Suche nach noch nicht übersetzten Dokumentationen durchgeführt werden:. Die Suche kann auf einen Typ, einen Code oder einen Codebereich eingegrenzt werden. Danach können die Dokumentationen einzeln per Rechtsklick oder gruppenweise bearbeitet werden.
- Im dritten Register wird nach noch nicht übersetzten Feldhilfen gesucht. Hierzu müssen Kriterien angegeben werden. Die Suche wird über folgenden Button ausgelöst:. Die Suche kann auf einen Code oder einen Codebereich eingegrenzt werden. Danach können die Feldhilfen einzeln per Rechtsklick oder gruppenweise bearbeitet werden.
Kopfzeile
Übersicht
Hier werden Ausgangs- und Zielsprache festgelegt.
Schließen
Felder
In diesem Register befinden sich die folgenden Felder :
| Definiert die Zielsprache |
|
|
| Definiert die Ausgangssprache des zu übersetzenden Textes. |
Schließen
Register Fortschritt
Übersicht
Anzeige der bereits übersetzten und noch zu übersetzenden Dokumentationen und Feldhilfen insgesamt, sowie aufgeschlüsselt nach Dokumentationstyp.
Hinweis: Nur in der Referenzsprache bereits vollständig freigegebene Dokumentationen sind potenziell zu übersetzen. Eine Dokumentation ist genau dann zu übersetzen, wenn ihr Gültigkeitsdatum nicht dem Gültigkeitsdatum der Referenzsprache entspricht.
Eine Feldhilfe ist genau dann zu übersetzen, wenn ihr Anlagedatum nicht dem letzten Änderungsdatum der Referenzsprache entspricht.
Dieser über die oben beschriebenen Daten definierte Mechanismus wird über die Ausgabe und den Import der Dokumentation gesteuert, durch die der Übergang zur Zielsprache definiert ist.
Schließen
Felder
In diesem Register befinden sich die folgenden Felder :
Tabelle Umlage
| Zeigt die Anzahl der übersetzten und noch zu übersetzenden Dokumentationen und Feldhilfen an. |
|
|
|
|
| Zeigt die Anzahl der übersetzten und noch zu übersetzenden Dokumentationen und Feldhilfen an. |
|
|
|
|
Zusammenfassung
| Gesamtanzahl von vollständig freigegebenen Dokumentationen und Gesamtanzahl von Dokumentationen in Original- und Zielsprache. |
|
|
|
|
|
|
| Gesamtanzahl von Feldhilfen in Original- und Zielsprache. |
|
|
|
|
|
|
Tabelle Detail nach Typ
| Die Tabelle zeigt nach Dokumentationstyp an:
|
|
|
|
|
|
|
|
|
|
|
Schließen
Symbol Aktionen
Register Dokumentation
Übersicht
Nach der Suche der zu übersetzenden Dokumentationen mithilfe von Kriterien stehen folgende Bearbeitungsmöglichkeiten zur Verfügung:
- Einzelne Dokumentation über Rechtsklick,
- Alle oder ein Teil der Dokumentationen über Auswahl der gewünschten Positionen und Klick auf den Button im unteren Bildschirmbereich: .
Nähere Informationen über die Aktion Bearbeiten finden sich im Anhang Dokumentationsübersetzungsprozess.
Schließen
Felder
In diesem Register befinden sich die folgenden Felder :
Kriterien
| Vorgabe des Suchkriteriums Dokumentationstyp oder Suche in allen Dokumentationen. |
|
|
| Vorgabe des Suchkriteriums Suche in einem Modul oder Suche in allen Modulen. |
|
|
|
|
|
|
|
|
|
| Unter Verwendung der Codebereichsgrenzen oder aller Codes kann hier als Suchkriterium ein Codebereich angegeben werden. |
|
|
|
|
Tabelle Suche
| Bei Bearbeitungsaufruf über den Button im unteren Bildschirmbereich wird hier festgelegt, ob die Position zu bearbeiten ist. |
| 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. |
| 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. |
| 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. |
| Gibt das Freigabe- bzw. letzte Änderungsdatum des Objekts in der Originalsprache an. |
| Gibt das Freigabe- bzw. letzte Änderungsdatum des Objekts in der gewählten Zielsprache an. |
| Gibt an, ob das Objekt in der gewählten Sprache bereits vorhanden ist. |
|
|
|
|
|
|
Schließen
Symbol Aktionen
STANDARD-Kursänderungsaktion
In Erfassungstabellen mit einer Auswahlmöglichkeit Ja / Nein pro Position können mit der Antwort Alle anderen: ja alle Positionen ab der aktuellen Position auf Ja gesetzt werden.
STANDARD-Kursänderungsaktion
In Erfassungstabellen mit einer Auswahlmöglichkeit Ja / Nein pro Position können mit der Antwort Alle anderen: nein alle Positionen ab der aktuellen Position auf Nein gesetzt werden.
Die Dokumentation bearbeiten
Stößt die Bearbeitung für die aktuelle Tabellenzeile an. Ausgabe der zu übersetzenden XML-Datei.
Es muss ein Ausgabeverzeichnis für die XML-Dateien definiert werden. Standardmäßig entspricht dieses Verzeichnis dem XML-Unterverzeichnis des Ausgabeverzeichnisses der HTML-Dokumentationsdateien. Die Dokumentationsdateien werden direkt ins angegebene Verzeichnis ausgegeben, und die zu einer Dokumentation gehörenden Dateien werden im Unterverzeichnis FILE des XML-Ausgabeverzeichnisses gespeichert.
Nähere Informationen über die Aktion Bearbeiten finden sich im Anhang Dokumentationsübersetzungsprozess.
Schließen
Register Feldhilfen
Übersicht
Nach der Suche der zu übersetzenden Feldhilfen mithilfe von Kriterien stehen folgende Bearbeitungsmöglichkeiten zur Verfügung:
- Einzelne Feldhilfe über Rechtsklick,
- Alle oder ein Teil der Feldhilfen über Auswahl der gewünschten Positionen und Klick auf den Button im unteren Bildschirmbereich: .
Nähere Informationen über die Aktion Bearbeiten finden sich im Anhang Dokumentationsübersetzungsprozess.
Schließen
Felder
In diesem Register befinden sich die folgenden Felder :
Kriterien
| Vorgabe des Suchkriteriums Suche in einem Modul oder Suche in allen Modulen. |
|
|
|
|
|
|
|
|
|
| Unter Verwendung der Codebereichsgrenzen oder aller Codes kann hier als Suchkriterium ein Codebereich angegeben werden. |
|
|
|
|
Tabelle Suche
| Bei Bearbeitungsaufruf über den Button im unteren Bildschirmbereich wird hier festgelegt, ob die Position zu bearbeiten ist. |
| Schlüsselwort der Feldhilfereferenz |
| Gibt das Freigabe- bzw. letzte Änderungsdatum des Objekts in der Originalsprache an. |
| Gibt das Freigabe- bzw. letzte Änderungsdatum des Objekts in der gewählten Zielsprache an. |
| Gibt an, ob das Objekt in der gewählten Sprache bereits vorhanden ist. |
|
|
|
|
Schließen
Symbol Aktionen
STANDARD-Kursänderungsaktion
In Erfassungstabellen mit einer Auswahlmöglichkeit Ja / Nein pro Position können mit der Antwort Alle anderen: ja alle Positionen ab der aktuellen Position auf Ja gesetzt werden.
STANDARD-Kursänderungsaktion
In Erfassungstabellen mit einer Auswahlmöglichkeit Ja / Nein pro Position können mit der Antwort Alle anderen: nein alle Positionen ab der aktuellen Position auf Nein gesetzt werden.
Feldhilfe bearbeiten
Stößt die Bearbeitung für die aktuelle Tabellenzeile an. Ausgabe der zu übersetzenden XML-Datei.
Es muss ein Ausgabeverzeichnis für die XML-Dateien definiert werden. Standardmäßig entspricht dieses Verzeichnis dem XML-Unterverzeichnis des Ausgabeverzeichnisses der HTML-Dokumentationsdateien.Die Feldhilfedateien befinden sich im FLD-Unterverzeichnis des xml-Ausgabeverzeichnisses.
Nähere Informationen über die Aktion Bearbeiten finden sich im Anhang Dokumentationsübersetzungsprozess.
Schließen
Spezielle Buttons
Dieser auch über die Funktionstasteerreichbare Button aktualisiert die Anzeige im ersten Register. |
Laden der Tabellen des Dokumentationsregisters. Stößt die Suche nach den gemäß den erfassten Kriterien zu übersetzenden Dokumentation an. |
Laden der Tabellen des Feldhilferegisters. Stößt die Suche nach den gemäß den erfassten Kriterien zu übersetzenden Feldhilfen an. |
Anhang: Prozess Dokumentationsübersetzung
Vorbedingungen
Derzeit verfügen nur die Funktionsdokumentationen über eine Option Freigegeben und über ein Freigabedatum. Eine Dokumentation kann nur dann Freigegeben sein, wenn sie und die zugehörigen Feldhilfen als abgeschlossen betrachten werden. Lediglich vollständig freigegebene Dokumentationen werden zur Übersetzung angeboten.
In einem stetigen Übersetzungsfluss können jedoch ständig Änderungen gemacht werden, die eine erneute Übersetzung erfordern. In diesem Fall muss die Dokumentation erneut freigegeben und mit einem Freigabedatum versehen werden. Sie wird dann erneut zur Übersetzung angeboten.
Gehören zur entsprechenden Funktion auch Feldhilfen, so müssen auch diese erneut übersetzt werden.
Aktion Bearbeiten
Bevor eine Dokumentation oder eine Feldhilfe zur Übersetzung ausgegeben werden kann, muss die Dokumentationsstruktur in der Zielsprache vorhanden sein und mindestens der Struktur in der Ausgangsdokumentation entsprechen.
Mit der Aktion Bearbeiten können alle vor der Ausgabe notwendigen Etappen ausgeführt werden.
- Generierung: Mit dieser Operation werden in der Zielsprache die Absätze der Dokumentation angelegt. Hierbei werden die Registertitel und der Funktionstitel übernommen und die (zu übersetzenden) erklärenden Absätze leer gelassen. Dabei ist es wichtig, dass alle zur entsprechenden Funktion gehörenden Texte zuvor übersetzt wurden (dies betrifft ATEXTE und APLSTD), da sonst nicht die gesamte übersetzte Terminologie verwendet wird.
- Kopie: Die Dokumentation in der Ausgangsprache, die für den oben beschriebenen Prozess generiert wurde, wurde geändert. Zunächst wurden in den Absätzen Texte erfasst (diese zählen zu den zu übersetzenden Elementen); und auch die Absatzstruktur kann sich geändert haben. Um diese Änderungen zu berücksichtigen, muss die Funktion Dokumentationskopie aufgerufen werden. Hinweis: Von dieser Funktion werde nicht die Absatztexte kopiert, sondern lediglich die Anhänge, die zusätzlichen Absätze (jedoch ohne den entsprechenden Text), die Absatzänderungen in INC, die Titel der neuen Absätze (MIS) sowie ihre Zuordnung zum Aktivitätscodes FAL.
Darüber hinaus werden die Feldhilfen angelegt und ihre Eigenschaften auf diese Etappe kopiert.
- Ausgabe: Alle Dokumentationen und Feldhilfen werden dann in Form von XML-Dateien ausgegeben und können mit einem geeigneten Übersetzungswerkzeug bearbeitet werden. Es muss ein Ausgabeverzeichnis für die XML-Dateien definiert werden. Standardmäßig entspricht dieses Verzeichnis dem XML-Unterverzeichnis des Ausgabeverzeichnisses der HTML-Dokumentationsdateien.Die Dokumentationsdateien werden direkt ins angegebene Verzeichnis ausgegeben, und die zu einer Dokumentation gehörenden Dateien werden im Unterverzeichnis FILE des XML-Ausgabeverzeichnisses gespeichert. Die Feldhilfedateien befinden sich im FLD-Unterverzeichnis des xml-Ausgabeverzeichnisses.
Import der übersetzten Dateien
Nach Übersetzung der Dateien mit einem externen Werkzeug werden sie mithilfe der Funktion Dokumentationsimport importiert. Außerdem werden ihnen Gültigkeitsdaten und Indikatoren zugewiesenen, mit denen sich die Gültigkeit der Übersetzung feststellen lässt.
Wichtiger Hinweis:
Die gemäß diesem Prozess übersetzten Dokumentationen müsse nicht manuell mit einem neuen Datum versehen werden.
Anders ausgedrückt: Auch, wenn die Dokumentation geändert wird, muss ihr kein neues Gültigkeitsdatum zugewiesen werden. Das vom Export- / Importprozess vergebene Datum bleibt gültig.
Hinzufügen eines Absatzes (Beispiel: MIS-Absatz in der Zielsprache) in die übersetzte Dokumentation: Diese übersetzte Dokumentation muss mit dem vom Übersetzungsprozess zugewiesenen Datum erneut freigegeben werden.
Wird ein anderes Gültigkeitsdatum zugewiesen, würde bei der Prüfung der Gültigkeit der Übersetzung anhand der Ausgangsprache diese Übersetzung immer als nicht gültig angezeigt und für eine Übersetzung vorgeschlagen.
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.