Chapter 5. Entwickler-Handbuch zu Kwave

in Arbeit

Sorry, leider muss dieses Kapitel noch geschrieben werden ... im Moment ist der Quellcode fast vollständig mit Tags passend zu den KDE- Dokumentationswerkzeugen dokumentiert. Aktuell bevorzugen wir die Benutzung von doxygen. Vielleicht werden wir eines Tages etwas Zeit erübrigen können, um ein Tool zu schreiben, dass die doxygen Ausgabe in etwas umwandelt, was man in irgendeiner Art und Weise in die Docbook-Quellen (die Quellen, aus denen diese Seite erzeugt wurde) einbinden könnte.

Wenn Sie ein Plugin schreiben und etwas zu diesem Projekt beitragen (oder vielleicht den oben erwähnten Konverter schreiben) wollen, dann scheuen Sie sich nicht, einem der Autoren direkt zu schreiben und / oder der Kwave Mailing-Liste beizutreten. Hilfe ist immer willkommen!

Unterstützung einer neue Sprache hinzufügen

  1. Generiersystem:

    Bearbeiten Sie die Datei CMakeLists.txt im Hauptverzeichnis und fügen Sie einen neuen Eintrag zu der Liste der Sprachen hinzu. Suchen Sie dazu die Variable KWAVE_LINGUAS und fügen Sie eine Zeile für die neue Sprache hinzu. Jeder Eintrag besteht aus einem Paar von einem Sprach-Code und einem Sprach-Name, nach folgendem Schema: <code>:<name>. Beispiel:

    fr:Francais
    

    Der Sprach-Code ist ein 2-Buchstaben-Code der für Verzeichnisse und Dateinamen verwendet wird, genau so wie in KDE selbst. Der Name der Sprache wir nur intern benutzt für die Online-Hilfe im docbook-Format. Für eine Liste verfügbarer Sprachen-Codes und Namen sei auf den internationalen Standard ISO 639.2 verwiesen.

  2. Benutzerschnittstelle:

    Wechseln Sie in das Quellenverzeichnis von Kwave (nicht das Generierverzeichnis), wechseln Sie dann in das Unterverzeichnis po und kopieren Sie die Datei kwave.pot in die entsprechende .po-Datei der Sprache die Sie hinzufügen wollen: "<code>.po". Danach können Sie diese Datei mit ihrem hierfür bevorzugten Programm übersetzen, vorzugsweise mit Lokalize. Beispiel:

    % cd $HOME/src/kwave
    % cd po
    % cp kwave.pot fr.po
    % lokalize fr.po
    

  3. Online-Hilfe:

    Dies ist ähnlich wie das Verfahren für die Benutzerschnittstelle, erfordert jedoch ein paar zusätzliche Schritte, weil der Originaltext im docbook-Format vorliegt und die .pot-Vorlage eine generierte Datei ist. Wechseln Sie also in das Quellenverzeichnis von Kwave (nicht das Generier-Verzeichnis), wechseln Sie dort in das Unterverzeichnis doc und erzeugen Sie eine leere .po-Datei:

    % cd $HOME/src/kwave
    % cd doc
    % touch help_fr.po
    

    Dann wechseln Sie in das Generierverzeichnis (z.B. irgendwo unter /tmp),bereiten die Generierung vor und erzeugen dann die .pot-Vorlage (Sie können getrost die Fehlermeldungen ignorieren die in dieser Stufe angezeigt werden). Diese Vorlage muss dann in die .po-Datei im Quellenverzeichnis der Online-Hilfe kopiert werden. Beispiel:

    % mkdir /tmp/kwave-build
    % cd /tmp/kwave-build
    % cmake $HOME/src/kwave
    % make doc
    % cp doc/help_en.pot $HOME/src/kwave/doc/help_fr.po
    

    Nun können Sie die .po-Datei wie oben beschrieben übersetzen:

    % cd $HOME/src/kwave
    % cd doc
    % lokalize help_fr.po
    

  4. Bildschirmfotos:

    Für die Online-Hilfe benötigen Sie auch noch Screenshots die die übersetzten Texte enthalten. Dies erfordert ein generiertes und installiertes Kwave-Paket, Sie sollten also die in den Anweisungen im Abschnitt Kompilierung und Installation. Natürlich dürfen Sie nicht die Generier-OptionWITH_DOC=no verwenden, eben sowenig eine andere Option die Funktionalität entfernt; von den deaktivierten Komponenten könnten Sie sonst keine Screenshots anfertigen.

    Für eine Liste bereits existierender Screenshots können Sie in eines der bereits existierenden Quellen-Verzeichnisse nachsehen, beispielsweise in$HOME/doc/de. Alle Screenshots sind im .png-Format und sollten sich an die KDE Documentation Screenshots Requirements halten. Hier kurz zusammengefasst:

    • Fensterdekoration: Oxygen

    • Stil: Oxygen

    • Farben: Oxygen

    • Hintergrund: Einfache Farbe -muss "weiss" sein

    • verwenden Sie X11 im 72dpi-Modus

    • Speichern Sie die Dateien in 8 Bit/Pixel

    • Versuchen Sie die Dateien kleiner als 20kB zu halten

  5. .desktop-Datei:

    Fügen Sie eine Comment-Zeile für die neue Sprache zu der Datei kwave/kwave.desktop.in hinzu. Bitte beachten Sie dass diese Datei in UTF-8 kodiert ist! Beispiel:

    Comment[fr]=Un éditeur de sons pour KDE
    

Hilfreiche Links: