Referenz Handbuch

Dieses Dokument ist geschützt © 2010-2015 durch deren Beitragende welche nachfolgend aufgeführt sind. Sie können es nach den Bedingungen der GNU General Public License (https://www.gnu.org/licenses/gpl.html), Version 3 oder später, oder der Creative Commons Attribution License (https://creativecommons.org/licenses/by/3.0/), Version 3.0 oder später verteilen oder verändern .

Alle Markenrechtsnamen in diesem Guide gehören den rechtmäßigen Eigentümern.

Beitragende

Jean-Pierre Charras, Fabrizio Tappero, Wayne Stambaugh.

Übersetzung

Carsten Schönert <c.schoenert@t-online.de>, 2016.

Feedback

Bitte alle Bug Reports, Vorschläge oder neue Versionen an folgende Adressen richten:

Datum der Veröffenlichung und Software-Version

Veröffentlicht am 15. October 2015.

1. Benötigte Dateien und Tools

Zum Erstellen und/oder Bearbeiten der Übersetzungen werden keine C++ Programmierfähigkeiten benötigt: Es sind keine Veränderungen in den KiCad Quelltextdateien nötig.

Übersetzungen können mit dem Tool PoEdit einfach bearbeitet werden. Dieses Tool sucht (im KiCad Quelltext) nach Abschnitten die übersetzt werden können und erstellt daraus einen Katalog mit den original Zeichenketten und den zugehörigen Übersetzungen. Für eine Mitarbeit an den Übersetzungen benötigen Sie PoEdit, den aktuellen KiCad Quelltext, und für die existierenden Übersetzungen den aktuellen Stand der Übersetzungen. Übersetzungen können unter Windows, Linux oder auch MacOS bearbeitet werden.

1.1. PoEdit herunterladen

Besuchen Sie die Webseite: https://www.poedit.net/

1.2. KiCad Quellen herunterladen

Die KiCad Quellen sind aktuell auf Launchpad gehostet:

Die Dateien können von Launchpad unter Verwendung des Tools "Bazaar" herunter geladen werden:

  • Sofern nicht schon erfolgt laden und installieren Sie das Tool Bazaar, dieses ist für Windows, Linux und MacOS erhältlich. Siehe https://bazaar.canonical.com/

  • Herunterladen der KiCad Quellen mit dem Kommando bzr branch lp:kicad <Verzeichnis wo die Dateien abgelegt werden sollen>

  • Sie finden dieses Dokument über Übersetzungen und PoEdit Konfiguration auf der Webseite http://docs.kicad-pcb.org/de/gui_translation_howto.html

1.3. Existierenden Übersetzungen und Dokumente herunterladen

KiCad Übersetzungen und Dokumentationen sind ebenso auf GitHub abgelegt: https://github.com/KiCad/kicad-i18n/

Herunterladen der Übersetzungen mit dem folgenden Kommando:

git clone https://github.com/KiCad/kicad-i18n.git

2. Auffinden von zu übersetzenden Abschnitten

Die verschiedenen Menüs und Tooltipps sind internationalisiert und können einfach ohne Quelltextveränderungen in eine lokale Sprache übersetzt werden.

Es gelten folgende Regeln:

  • Die Originalzeichenkette ist in Englisch verfasst.

  • Alle Zeichenketten die übersetzt werden können sind in der Art _("hello world") erstellt, diese werden dann als "hello world" angezeigt. Wird ein zugehöriger Wörterbucheintrag gefunden wird dieser anstatt der Originalzeichenkette verwendet.

  • Es wird ein Wörterbuch Englisch - lokale Sprache für die Übersetzungen verwendet (ein Wörterbuch pro Sprache).

Ein einfacher Weg um das Wörterbuch Englisch - lokale Sprache zu bearbeiten ist das Tool PoEdit. PoEdit durchsucht die KiCad Quellen und erlaubt es Ihnen die Übersetzungen einzutragen. Die KiCad Quellen müssen vorhanden sein, ebenso muss PoEdit eingerichtet sein um die Übersetzungen bearbeiteten zu können.

3. KiCad Verzeichnisbaum für Übersetzungen

3.1. Wörterbuch Baum

Das Wörterbuch wird von KiCad nur gefunden wenn es in einem geeigneten Ordner abgelegt ist:

images/i18n-tree.png

Der zugehörige Ordner ist kicad/internat/xx,

oder kicad/internat/xx_yy

mit: xx = normalisierter LANG Indikator (Kurzform) wie z.B.:

  • fr = französisch

  • en = englisch

  • es = spanisch

  • pt = portugiesisch

oder: xx_yy = normalisierter LANG_COUNTRY Indikator (Langform) wie z.B.:

  • fr_FR = französisch Frankreich

  • en_GB = englisch Großbritannien

  • en_US = englisch USA

  • de_CH = deutsch Schweiz

3.2. Suchpfad

Wörterbücher und OnLine Hilfedateien werden in dieser Reihenfolge gesucht:

  • Im Ordner mit normalisierter locale Indikation (Langform) (kicad/internat/xx_yy)

  • Im Ordner mit normalisierter locale Indikation (Kurzform) (kicad/internat/xx)

Für die OnLine Hilfe Dateien wird in folgenden Ordner gesucht:

  • Im Ordner mit normalisierter locale Indikation (Langform) (kicad/help/xx_yy)

  • Im Ordner mit normalisierter locale Indikation (Kurzform) (kicad/help/xx)

  • kicad/help/en

  • kicad/help/fr

Anmerkung

Der KiCad Hauptordner für Übersetzungen wird aus dem Ordner in dem das KiCad Programm liegt gebildet, oder (wenn nicht gefunden):

in Windows:
  • c:\kicad

  • d:\kicad

  • c:\Program Files\kicad

in Linux
  • /usr/share/kicad

  • /usr/local/share/kicad

  • /usr/local/kicad/share/kicad

  • /usr/local/kicad

3.3. Dateien

In jedem Ordner kicad/internat/xx sind zwei Dateien vorhanden :

  • internat.po, dies ist die Wörterbuchdatei die PoEdit zum Bearbeiten benutzt

  • internat.mo, dies ist die kompilierte *.po Arbeitsdatei welche von KiCad Programm später verwendet wird

4. PoEdit benutzen

4.1. Installation

Herunterladen und Installieren von PoEdit (https://www.poedit.net). PoEdit ist erhältlich für Windows, Linux und Mac OS X.

Herunterladen und entpacken der KiCad Quellen.

4.2. KiCad Vorbereitungen

KiCad Quellen: In diesem Beispiel sind die Dateien in f:/kicad/. Alle Zeichenketten die übersetzt werdne können sind markiert wie z.B. _("string to translate").

PoEdit muss nach dem Zeichen _ (Unterstrich) suchen um diese Zeichenketten zu erkennen.

In KiCad muss das passende Verzeichnis für das Wörterbuch (kicad/share/internat/xx) hinzugefügt werden. In diesem Beispiel ist das Verzeichnis kicad/share/internat/fr.

4.3. PoEdit Konfiguration

PoEdit starten.

Aufrufen von Datei → Neu …

Es sollte folgendes zu sehen sein:

images/poedit-settings.png

4.4. Projekt Konfiguration

images/poedit-settings-fr.png

Die Quellen sind in Englisch, es muss daher nichts für den Quelltext ausgewählt werden.

4.5. Ordner und Datei Konfiguration

images/poedit-settings-paths.png

4.6. Schlüsselwort Konfiguration

images/poedit-settings-keywords.png

Es sind einige Schlüsselwörter hier einzutragen:

  • _ (Unterstrich) wird als Tag in den generischen Quelltext Dateien benutzt

  • _HKI wird als Tag für die Beschreibungen der Hotkey Übersetzungen benutzt

4.7. Abspeichern des Projektes

Speichern Sie das Projekt in kicad/share/internat/xx mit dem Namen kicad.po.

5. Erstellen oder Bearbeiten eines Wörterbuches

Starten Sie PoEdit und laden Sie ein Projekt (hier kicad.po).

images/poedit-settings-dict.png

Ausführen des Kommandos Katalog → Aus Quellen aktualisieren.

Neue (noch nicht übersetzte) Zeichenketten werden im oberen Teil des Fensters angezeigt.

6. Hinzufügen einer neuen Sprache in den KiCad Quellen (für Entwickler)

Dieser Schritt ist normaler Weise nicht notwendig. Er ist nur sinnvoll für Entwickler und für Testzwecke.

In KiCad kann die zu verwendete Sprache festgelegt werden.

Es wird empfohlen die Standardsprache des verwendeten Betriebssystems zu benutzen.

images/kicad-settings-language.png

Da aber Entwickler Übersetzungen überprüfen wollen kann ein neuer Eintrag für eine Sprache sehr nützlich für Testzwecke sein.

6.1. Ausführungsschritte

6.1.1. Hinzufügen einer neuen ID in include/id.h

→ In include/id.h, suchen der Sequenz:

ID_LANGUAGE_CHOICE,
ID_LANGUAGE_DEFAULT,
ID_LANGUAGE_ENGLISH,
ID_LANGUAGE_FRENCH,
ID_LANGUAGE_SPANISH,
ID_LANGUAGE_GERMAN,
ID_LANGUAGE_RUSSIAN,
ID_LANGUAGE_PORTUGUESE,

Hinzufügen eines neuen Eintrages in die Liste (welcher später in den Menüs verwendet wird):

ID_LANGUAGE_MY_LANGUAGE vor ID_LANGUAGE_CHOICE_END.

6.1.2. Hinzufügen eines neuen Icons (nur aus ästhetischen Gründen)

→ Erstellen eines neuen Icons im SVG Format (durch Inkscape z.B.): üblicher Weise eine Landesflagge. Zum Beispiel lang_new.svg

Andere Icons für die Sprachen sind in common/bitmaps_png/source abgelegt

6.1.3. Bearbeiten von bitmaps_png/CMakeLists.txt

→ Suchen der Text Sequenz:

lang_catalan
lang_chinese
lang_bg
lang_cs
lang_def
lang_de
lang_en
lang_es
lang_fr
lang_fi
lang_gr
lang_hu
lang_it
lang_jp
lang_ko
lang_nl
lang_pl
lang_pt
lang_ru
lang_sl

Hinzufügen des neuen Dateinamen (ohne die Dateierweiterung): lang_new

6.1.4. Bearbeiten von include/bitmaps.h

→ Suchen der Text Sequenz:

EXTERN_BITMAP( lang_bg_xpm )
EXTERN_BITMAP( lang_catalan_xpm )
EXTERN_BITMAP( lang_chinese_xpm )
EXTERN_BITMAP( lang_cs_xpm )
EXTERN_BITMAP( lang_def_xpm )
EXTERN_BITMAP( lang_de_xpm )
EXTERN_BITMAP( lang_en_xpm )
EXTERN_BITMAP( lang_es_xpm )
EXTERN_BITMAP( lang_fr_xpm )
EXTERN_BITMAP( lang_fi_xpm )
EXTERN_BITMAP( lang_gr_xpm )
EXTERN_BITMAP( lang_hu_xpm )
EXTERN_BITMAP( lang_it_xpm )
EXTERN_BITMAP( lang_jp_xpm )
EXTERN_BITMAP( lang_ko_xpm )
EXTERN_BITMAP( lang_nl_xpm )
EXTERN_BITMAP( lang_pl_xpm )
EXTERN_BITMAP( lang_pt_xpm )
EXTERN_BITMAP( lang_ru_xpm )
EXTERN_BITMAP( lang_sl_xpm )

Hinzufügen einer Zeile um das neue Icon mit dem Namen lang_new_xpm (_xpm hinzugefügt zum Dateinamen) einzupflegen.

6.1.5. Bearbeiten von common/edaappl.cpp

→ Suchen nach der Struktur struct LANGUAGE_DESCR

struct LANGUAGE_DESCR
{
    int           m_WX_Lang_Identifier;                 // wxWidget locale identifier (see wxWidget doc)
    int           m_KI_Lang_Identifier;                 // kicad identifier used in menu selection (see id.h)
    const char**  m_Lang_Icon;                          // the icon used in menus
    const wxChar* m_Lang_Label;                         // Label used in menus
    bool          m_DoNotTranslate;                     // set to true if the m_Lang_Label must not be translated
};

#define LANGUAGE_DESCR_COUNT 14
static struct LANGUAGE_DESCR s_Language_List[LANGUAGE_DESCR_COUNT] =
{
    {
        wxLANGUAGE_DEFAULT,
        ID_LANGUAGE_DEFAULT,
        lang_def_xpm,
        _( "Default" )
    },
    {
        wxLANGUAGE_ENGLISH,
        ID_LANGUAGE_ENGLISH,
        lang_en_xpm,
        wxT( "English" ),
        true;
    },
    {
        wxLANGUAGE_FRENCH,
        ID_LANGUAGE_FRENCH,
        lang_fr_xpm,
        _( "French" )
    },

Hinzufügen eines neuen Eintrages:

    {
        wxLANGUAGE_MY_LANGUAGE,
        ID_LANGUAGE_MY_LANGUAGE,
        lang_new_xpm,
        _( "My_language" )
    },

wxLANGUAGE_MY_LANGUAGE ist die wxWidgets Sprachidentifizierung für das Land (siehe wxWidget Dokumentation).

6.1.6. Neu übersetzen

Das neue Übersetzen der Quelltextdateien muss mit gesetzter Variable MAINTAIN_PNGS (cmake …. -DMAINTAIN_PNGS …) erfolgen, siehe auch bitmaps_png/CMakeLists.txt. Dieser Schritt ist der nächste und auch der letzte.