Translating Docs-de

From AMule Project FAQ
Jump to: navigation, search

English | Deutsch

Übersetzen der manpages von aMule mittels po4a

Set svn Rev. 9932 gibt es ein Verzeichnis names /docs/man/po/ in den Quellen. In diesem Verzeichnis findest du die Datei manpages.pot, und die zugehörigen .po Dateien der einzelnen Sprachen. Mit diesen Dateien kannst du dazu beitragen, das alle Nutzer manpages in ihrer Muttersprache haben können. Dieser Artikel beschreibt wie das geht. Es ist zwar nicht nötig po4a zu installieren um die Dokumentation zu übersetzen, es vereinfacht und beschleunigt das ganze aber erheblich.

Regeln

Bevor du beginnst, sind hier ein paar Grundregeln die du beachten solltest:

  1. Füge keine Informationen hinzu oder entferne welche (ausser im Anhang). Falls du das beabsichtigst, tue dies in der englischen Version
  2. Versichere dich, das dein Editor die UTF-8 Kodierung beherrscht und nutzt
  3. Entferne keine Zeichen mit Sonderbedeutung
  4. po4a wird jede Datei ignorieren die nicht zu mindestens 80% übersetzt ist
  5. Weder du, noch dein Programm sollten Leerzeichen am Zeilenende entfernen

Vorbereitung

Um eine Übersetzung zu beginnen existieren drei Mögliche Szenarien:

  1. Es gibt bereits eine übersetzte .po
  2. Es gibt noch keine übersetzte .po, aber du hast po4a installiert
  3. Es gibt noch keine übersetzte .po und du hast po4a nicht installiert

Vorbereitung mit bereits übersetzter .po

Keine Vorbereitung nötig, fange an zu übersetzen.

Vorbereitung ohne übersetzte .po aber installiertem po4a

Wechsel ins Verzeichnis docs/man/, öffne die Datei po4a.config in deinem favorisierten Texteditor. Die erste Zeile lautet:

[po4a_langs] de es eu fr hu

Füge deine Sprache einfach diese Zeile hinzu (alphabetische Reihenfolge bitte). Um pt_BR hinzuzufügen würde das so aussehen:

[po4a_langs] de es eu fr hu pt_BR

Nun starte

po4a po4a.config

in diesem Verzeichnis, und du bekommst eine neu erstellte .po Datei in po/. In unserem Beispiel po/manpages-pt_BR.po

Jetzt kannst du anfangen zu übersetzen. Natürlich kannst du auch die Schritte aus dem nächsten Abschnitt nutzen.

Vorbereitung ohne übersetzte .po und nicht installiertem po4a

Wechsle ins Verzeichnis docs/man/po/, kopiere manpages.pot auf eine .po Datei die zu deiner Sprache passt. Zum Beispiel:

cp manpages.pot manpages-pt_BR.po

um nach pt_BR zu übersetzen. Jetzt kannst du anfangen zu übersetzen, aber vergiss nicht beim einreichen zu erwähnen das du po4a nicht genutzt hast.

Übersetzen

Nimm einfach dein bevorzugtes Werkzeug zum editieren von .po Dateien, wie du es auch beim Übersetzen von aMule verwenden würdest. Wie immer, solltest du alle Sonderzeichen zur Formatierung unberührt lassen, und nur den Text übersetzen.

Zum Beispiel wird die Originalzeile:

msgid "B<[ -w> I<E<lt>pathE<gt>>, B<--use-amuleweb>=I<E<lt>pathE<gt>> B<]>"

auf Deutsch zu:

msgstr "B<[ -w> I<E<lt>PfadE<gt>>, B<--use-amuleweb>=I<E<lt>PfadE<gt>> B<]>"

Formatierungszeichen findest du in fast jeder Zeile. Im Zweifel frage lieber in den Foren oder im IRC.

Formatierungszeichen von po4a

Die Formatierungszeichen in po4a sind ein bisschen anders als die, welche in den originalen manpages verwendet werden. Hier ist eine, hoffentlich komplette, Liste der Zeichen auf die du stoßen wirst.

  1. E-Zeichen - Ein großes E beginnt ein Symbol, das unkodiert eine andere Bedeutung hätte.
    1. E<lt> ergibt das "<"-Zeichen
    2. E>lt> ergibt das ">"-Zeichen
  2. Textformat - Zum formatieren von Text werden 3 einzelene Großbuchstaben verwendet.
    1. B<Text> - Markiert das der Text zwischen < und > fett dargestellt wird
    2. I<Text> - Markiert das der Text zwischen < und > kursiv dargestellt wird
    3. R<Text> - Markiert das der Text zwischen < und > normal dargestellt wird

Der Anhang

Ein Anhang ist eine Datei, welche zusätzliche Informationen in deiner Sprache enthält die im ursprünglichen Dokument nicht enthalten sind. Das ist der richtige Ort um der Welt mitzuteilen das die großartige Leistung vollbracht hast diese Dokumentation zu übersetzen.

Der Anhang befindet sich einer Datei namens manpages-<deine-sprache>.add im Verzeichnis docs/man/po/.

Die erste Zeile enthält Informationen darüber, wo im die enthaltenen Informationen eingefügt werden sollen, also das Ende der übersetzten Datei.

  • ÄNDERE NIEMALS DIESE ERSTE ZEILE

Die einfachste Möglichkeit ist es, eine existierende Datei zu kopieren und zu bearbeiten. Um einen Zeilenumbruch zu bekommen, füge eine Leerzeile ein. Ohne diese, wird die neue Zeile direkt an die vorhergehende angehängt.

Hier kannst du eine Zeile wie

Übersetzt von <dein-Name>

in deiner Sprache einfügen, oder falls solch eine Zeile schon existiert

Aktualisiert von <dein-Name>

Zum Beispiel sieht der deutsche Anhang wie folgt aus:

PO4A-HEADER:mode=after;position=^\.TH;beginboundary=^FakePo4aBoundary

Diese manpage wurde übersetzt von Vollstrecker <amule@vollstreckernet.de>

Einreichen der &UUML,bersetzung

Wieder hast du mehr als eine Möglichkeit.

Falls du eine existierende Übersetzung genutzt hast, poste die aktualisierte .po und .add im Forum, und jemand wird sie in den Quelltext übernehemen. Dies ist allerdings nicht die beste Möglichkeit, da du jemanden brauchst, der zum einchecken berechtigt ist, und po4a installiert hat. Wahrscheinlich wird jemand mit installiertem po4a die Übersetzungen erstellen, und sie dir zurück senden damit du sie prüfen kannst, und jemand anderes wird sie dann einchecken.

Ein besserer Weg wäre es, wenn du po4a installierst, und von Anfang an verwendest. Po4a is für die meisten Distributionen verfügbar, guck einfach mal in deinem Paketmanager.

Falls du deine Sprache noch nicht in der po4a.config eingetragen hast, ist jetzt der richtige Zeitpunkt.

Nun starte

po4a po4a.config

nochmal, um deine übersetzte Dokumentation zu erstellen. Um sie zu prüfen nutzt du

man <übersetzte-Seite>

Du solltest alle Seiten prüfen. Hier ist eine Liste:

  1. docs/man/amule.<deine-Sprache>.1
  2. docs/man/amulecmd.<deine-Sprache>.1
  3. docs/man/amuled.<deine-Sprache>.1
  4. docs/man/amulegui.<deine-Sprache>.1
  5. docs/man/amuleweb.<deine-Sprache>.1
  6. docs/man/ed2k.<deine-Sprache>.1
  7. src/utils/aLinkCreator/docs/alc.<deine-Sprache>.1
  8. src/utils/aLinkCreator/docs/alcc.<deine-Sprache>.1
  9. src/utils/cas/docs/cas.<deine-Sprache>.1
  10. src/utils/wxCas/docs/wxcas.<deine-Sprache>.1
  11. src/utils/xas/docs/xas.<deine-Sprache>.1

Nun musst du nur noch make wissen lassen was du getan hast, indem du die neuen Datei zur Dateiliste hinzufügst. Dafür öffnest du die Datei Makefile.am, welche in jedem Verzeichnis das die Dokumentation enthält vorhanden ist. Darin siehst du eine Zeile wie:

EXTRA_DIST = \
       amule.1 amuled.1 amulecmd.1 amulegui.1 amuleweb.1 ed2k.1 \
       amule.de.1 amuled.de.1 amulecmd.de.1 amulegui.de.1 amuleweb.de.1 ed2k.de.1 \
       amule.es.1 amuled.es.1 amulecmd.es.1 amuleweb.es.1 ed2k.es.1

Schreibe die Dateien deiner Sprache einfach dazu.

Wenn du deine Sprache irgendwo in der Mitte einfügst, um die alphabetische Reihenfolge zu erhalten, achte darauf die Zeile mit einem Leerzeichen und einem Backshlash abzuschließen (" \").

Wenn deine Sprache am Ende steht, füge das Leerzeichen und den Backshlash der vorherigen Zeile hinzu.

Wenn alles fertig ist, erstelle einen diff vom gesamten Quelltextverzeichnis, und schicke ihn ans Forum.