Translating an external workbench/de

In den folgenden Hinweisen sollte der Name Deiner Erweiterung oder Deines Arbeitsbereichs sein, z.B.  oder, oder was auch immer. Groß- und Kleinschreibung wird hier unterschieden: So ist z.B. ist nicht dasselbe wie. Dieser Zusammenhang sorgt dafür, dass die gesamte Übersetzung des Codes unter demselben Namen zusammengefasst wird, um von den Übersetzern leichter erkannt werden zu können. Das heißt, sie wissen genau, zu welcher Erweiterung oder welchem Arbeitsbereich eine bestimmte Zeichenkette gehört.

Hinweis: Hier ist ein Multifunktionsskript, das den kompletten unten beschriebenen Ablauf automatisiert (Es wird trotzdem empfohlen, die Beschreibung zu lesen, um zu wissen, was das Skript erledigen soll): https://github.com/yorikvanhavre/BIM_Workbench/blob/master/utils/updateTranslations.py

Allgemeines

 * Einen Ordner hinzufügen. Dieser kann auch gänzlich anders benannt werden, aber so ist es einfacher, da er in allen Bereichen von FreeCAD gleich ist. In diesem Ordner werden die -Dateien (die "Quell-"Übersetzungsdateien) und -Dateien (kompilierte Übersetzungsdateien) abgelegt.
 * Es sollte nur der Text übersetzt werden, der dem Benutzer in der FreeCAD-Benutzeroberfläche angezeigt wird. Text, der nur in der Python-Konsole angezeigt wird, sollte nicht übersetzt werden.
 * Text, der über ausgegeben wird, wird im "Ausgabefenster" angezeigt und sollte daher übersetzt werden. Das "Ausgabefenster" unterscheidet sich von der Python-Konsole.

In jeder Python .py-Datei

 * In jeder Datei, in der Text übersetzt werden soll, braucht man eine definierte -Funktion. Sie muss exakt benannt werden: Der Zeichenkettenausleser hängt von der exakten Benennung ab. Man kann den vollständigen Namen von Qt verwenden, aber die Verwendung des Folgenden ist etwas sauberer:




 * Alle Texte, die übersetzt werden sollen, müssen durch die Funktion übergeben werden:




 * wird zu:




 * Man darf nicht vergessen, dass nicht nur eine normale Funktion ist, sondern auch als "Tag" für das  Textverabeitungs-Dienstprogramm dient und deshalb exakt "translate" heißen muss. Das Programm  ist eine einfache Textverarbeitung; es führt keinen Code aus. Zeichenketteninhalte müssen direkt an die Funktion  übergeben werden: Es können keine Variablen, Konstanten usw. übergeben werden. Ein Beispiel:




 * Dies kann überall verwendet werden: In, in , in Qt-Dialogen, etc. Die -Funktionen fügen das Zeichen für den Zeilenumbruch nicht automatisch hinzu, so dass dieses bei Bedarf am Ende hinzugefügt werden muss. Dieses Zeichen benötigt auch keine Übersetzung, so dass es außerhalb der Übersetzungsfunktion liegen kann:




 * Werden -Dateien verwendet, die mit dem QtDesigner erstellt wurden, muss nichts Besonderes mit ihnen gemacht werden.
 * Beim Erstellen neuer Objekte darf der "Name" des Objekts nicht übersetzt werden. Übersetzt wird vielmehr die "Benennung" (das Label) des Objekts. Der Unterschied besteht darin, dass ein "Name" einzigartig ist; er bleibt über die gesamte Lebensdauer des Objekts derselbe; andererseits kann eine "Benennung" vom Benutzer beliebig geändert werden.
 * Wenn man Eigenschaften für eigene Objekte erstellt, werden die Namen der Eigenschaften nicht übersetzt. Aber die Beschreibung wird in eingebettet:




 * Man verwendet in diesem speziellen Fall keinen eigenen, sondern behält bei.

In InitGui.py

 * Die folgende Zeile im oberen Bereich der Datei hinzufügen:




 * Das Makro macht nichts außer, dass es Texte markiert, die später vom Dienstprogramm  aufgesammelt werden. Es wird nur in Sonderfällen verwendet, in denen sich FreeCAD selbst um alles kümmert.


 * Um Namen von Menüs und Symboleisten zu übersetzen, verwendet man das Wort als Kontext:




 * Den Pfad zum eigenen Ordner in der Initialisierten Funktion hinzufügen:



Die Datei hat kein Attribut file, so dass es nicht einfach ist, die relative Position des Übersetzungsordners zu finden. Eine einfache Möglichkeit, dies zu umgehen, besteht darin, eine andere Datei aus demselben Ordner zu importieren und in dieser Datei Folgendes zu tun:



Innerhalb jeder FreeCAD-Befehlsklasse

 * Folgende Zeile am Anfang der Datei hinzufügen:




 * und des Befehls übersetzt man wie folgt:




 * wobei der Name des Befehls ist, definiert durch:



Alle Zeichenketten des eigenen Moduls sammeln

 * Die Werkzeuge, , und  müssen auf dem eigenen System installiert sein.  In Linux-Distributionen sind sie in der Regel in Paketen mit den Namen  oder  enthalten. Auf einigen Systemen wird  auch , , oder ähnlich genannt. Das Gleiche gilt für die anderen Werkzeuge. Die Versionen Qt4 oder Qt5 können nach Wahl verwendet werden. In Qt6 gibt es kein eigenständiges Übersetzungssystem für Python-Dateien,  wird zum Extrahieren der Zeichenketten aus allen Arten von Quelldateien verwendet.
 * Sind -Dateien vorhanden, muss zuerst ausgeführt werden:




 * Dies ist rekursiv und findet -Dateien in der gesamten Verzeichnisstruktur.


 * Sind -Dateien vorhanden, muss auch ausgeführt werden:




 * Wurden beide Operationen ausgeführt, müssen nun die beiden Dateien zu einer einzigen zusammengefeasst werden:




 * Die Inhalte der drei -Dateien überprüfen, um sicherzustellen, dass sie die Zeichenketten enthalten, danach können und  gelöscht werden.
 * Das alles kann auch mit einem Bash-Skript wie diesem ausgeführt werden:



Sende die .ts Datei an eine Übersetzungsplattform
Es ist an der Zeit, die -Datei übersetzen zu lassen. Dafür kann man ein Konto auf einer öffentlichen Übersetzungsplattform wie Crowdin oder Transifex einrichten, oder unser bestehendes FreeCAD-Addons-Konto bei Crowdin nutzen, das bereits viele Benutzer hat und somit eine größere Chance, die Datei schnell übersetzen zu lassen, von Leuten, die FreeCAD kennen.

Soll die Datei auf dem FreeCAD-Crowdin-Konto untergebracht werden, hilft Yorik im FreeCAD-Forum gerne weiter.

Einige Plattformen wie Crowdin können sich in GitHub integrieren und den gesamten Prozess von Punkt 2, 3 und 4 automatisch durchführen. Dafür kann das FreeCAD-Crowdin-Konto nicht verwendet werden; Man muss sein eigenes Konto einrichten.

Übersetzungen zusammenführen
Sobald deine Datei übersetzt wurde, wenn auch nur teilweise, kannst du die Übersetzungen von der Internetseite herunterladen:


 * Du wirst normalerweise eine Datei herunterladen, die eine  pro Sprache enthält.
 * Platziere alle übersetzten Dateien zusammen mit Deiner Basisdatei  im  Ordner.

Kompiliere die Übersetzungen
Nun wird das Programm auf jede vorhandene Datei angewendet:

Der Prozess lässt sich automatisieren:

Es sollte jetzt eine -Datei für jede übersetzte -Datei vorhanden sein. Die -Dateien sind die, die von Qt und FreeCAD zur Laufzeit verwendet werden.

Das ist alles, was gebraucht wird. Man beachte, dass bestimmte Teile des eigenen Arbeitsbereichs nicht sofort übersetzt werden können, wenn man sich für einen Wechsel der Sprache entscheidet. In diesem Fall muss FreeCAD neu gestartet werden, damit die neue Sprache verwendet wird.

Übersetzungen testen

 * 1) In FreeCAD zu einer Sprache wechseln, die man übersetzt hat (z.B. Deutsch)
 * 2) Die Übersetzung in FreeCAD laden, z.B.
 * 3) Eine Zeichenkette testen, z.B.

Ergebnis: Dies sollte die deutsche Übersetzung liefern. Wenn das funktioniert, ist die Basiseinstellung OK. Dann können wir uns etwas anderes ansehen. Beispielsweise sollten Befehlsnamen einen speziellen Kontext benutzen, das ist der in FreeCAD eingetragene Befehlsname.

Wichtige Hinweise

 * Stelle sicher, dass du einen *context* und *string* verwendest, der tatsächlich in der ts/qm-Datei vorhanden ist.

Convenience script
Yorik maintains a convenience script for the BIM workbench, that can gather, upload and download ts files. You can just copy and adapt that script for your workbench:

https://github.com/yorikvanhavre/BIM_Workbench/blob/master/utils/updateTranslations.py

Technical details and advanced usage
In the above examples there are two separate functions being used: and. You may also run across and, which automatically provide the "context" argument based on their calling location. These two pairs of functions are fundamentally different.

and accomplish two separate tasks: at runtime they perform the actual translation from the string passed into them to the final translated string. This is true whether they are provided a literal string, or a variable, or a constant: the lookup is dynamic and real-time during the run of the code. However, they provide an additional non-runtime function: they are recognized by the utility. If (and only if) they contain a string literal, that literal is extracted by the utility. ONLY string literals are extracted by -- if a variable is passed it is ignored by the  utility. Qt will attempt to provide a translation at runtime, but this will only work if some other piece of code called one of the translation functions with the literal string that needs to be translated, so that can extract it. Note that the code with the string literal need not actually ever execute, it must simply exist as a line of code in a file somewhere: performs no analysis or code execution, it is simply performing a string search and extraction.

In contrast, and  do nothing at all at runtime: they are literal "no-ops", and are completely ignored by running code. Their only use is to mark a literal string for extraction by : it never makes sense to place a variable within a call to one of these functions, it will have no effect. They are used in circumstances where or  will be called with a variable containing the text to translate. For example, any code that is used to create a Command or a Property will use a NOOP-type function around the command menu text or tooltip, or the property docstring: at runtime when FreeCAD displays these items to the user it calls : the literal strings must have been extracted by at the point of creation, for example:

In this usage, at runtime the dictionary returned by this function is literally:

There is no reference to any type of translation information. When FreeCAD actually displays this information to the user, the pseudo-code is:

In this case, cannot extract any string from the call to  because it refers to a variable. So ignores that call, but at runtime Qt searches for the string that's passed to it. As long as someplace in the code there is a call to one of the translation functions with a matching literal string (in this case, in the function), this translation call will succeed.

To verify that the expected strings are being extracted, you can manually run the command:

The file will contain the set of strings that are uploaded to CrowdIn for translation.

Wichtige Verweise

 * Warum und wie man Funktionen übersetzen sollte (forum thread)

Verwandte Seiten

 * Externe Arbeitsbereiche
 * Lokalisierung
 * Eigene Anfragen nach weitere Informationen können hier gestellt werden:Translating external workbenches (engl.).