Hinweise für Perldoc-Übersetzer
%A% Die Perldoc-Texte sind nicht im TWiki-Format, sondern als Attachments im
POD-Format an das jeweilige Topic angehängt, um sie später mal als deutsche Perl-Dokumentation nutzen zu können.
Leider kann man sie daher auch nicht einfach im TWiki ändern, sondern muss die Dateien herunterladen, ändern und wieder neu anhängen. Hier sind weitere Hinweise dazu.
Funktionales
- Übersetzungen werden im POD-Format erstellt!
- Wenn ein POD nicht in ISO8859-1 kodiert ist, muss eine =encoding-Zeile am Anfang der Datei eingefügt werden. Beispiel: =encoding utf-8
- Um eine Übersetzung ins PerlCommunityWiki zu stellen, geht man wie folgt vor:
- In der WunschListe nachschauen, ob niemand anderes das Dokument schon übersetzen möchte. Wenn nein, trag dich selber und das von dir übersetzte / zu übersetzende Dokument ein.
- Wenn schon eine Seite mit dem Dokument existiert:
- Über den Link "Download als POD" oben auf der entsprechenden Seite das Dokument als POD herunterladen. (Oder eine lokale Version der POD-Datei als Vorlage nehmen.)
- Das Dokument lokal übersetzen.
- Über den Link "Anhang" oben auf der entsprechenden Seite die POD-Datei an das Topic anhängen.
- Falls vorher kein Anhang vorhanden war, das Topic editieren, den Text
%PERLDOC{name_des_poddokuments}%
ändern in
%PERLDOC{}%
und speichern. Jetzt sollte das angehängte POD-Dokument als HTML gerendert im Topic erscheinen.
- Wenn noch keine entsprechende Seite im PerlCommunityWiki existiert:
- Die passende PerlCommunityWiki-Seite erstellen. Für das Dokument
perlintro wäre das das Topic Perldoc.perlintro. Einfach die URL des Dokumentes im Browser eingeben, und man erhält ein Formular, um die Seite zu erstellen.
- Als Text des Topics folgendes eingeben
%PERLDOC{}%
und das Topic speichern. Es gibt normalerweise eine Fehlermeldung des PerlDocPlugins, weil noch kein Dokument vorhanden ist:
PerlDocPlugin: Module FooBar not found with version 5.8.0, language de en.
Diese kann man einfach ignorieren.
- Jetzt über den Link "Anhang" oben auf der Seite an das Topic die POD-Datei anhängen.
Wenn das POD-Dokument zu einer anderen Perl-Version als 5.8.0 gehört, dann sollte der Dateiname die Form podname.x.y.z.pod erhalten, wobei x.y.z die Perl-Version ist, aus der das Dokument stammt. Das sorgt dafür, dass in der Überschrift des Dokumentes die richtige Versionsnummer genannt wird.
- Jetzt sollte das angehängte POD-Dokument als HTML gerendert im Topic erscheinen.
- Hast du auch daran gedacht, dich als Übersetzer in die WunschListe einzutragen?
Formales
- Übersetzungen sollten auf Perl 5.8.0 oder neuer basieren. (Wenn einmal eine mehr oder weniger vollständige Liste von übersetzten Dokumenten existiert, kann man darüber nachdenken, ein "Release" der Doku für eine bestimmte Perl-Version zu erstellen.)
Die englischen Texte findet man entweder hier im PerlCommunityWiki, wenn man in ein Topic %PERLDOC{manpagename}% einträgt (allerdings nur die sogenannte "Kerndokumentation", sprich: alles was mit perl... anfängt), oder unter http://perldoc.perl.org/ (vormals http://www.perldoc.com/perl5.8.0/)
- Der Leser wird (anders als hier im Wiki) mit "Sie" angesprochen.
%A% Denkt dran, die Dokumentation soll später mal mit Perl ausgeliefert werden und einigermaßen professionell wirken.
- Es gibt eine WortListe mit einigen Begriffen aus den Perldocs, um Konsistenz in der Übersetzung zu gewährleisten. Als Referenz soll zusätzlich die deutsche Übersetzung des CamelBook dienen.
- Hier noch ein paar nützliche Links:
- Was man nicht zur Übersetzung nehmen sollte:
--
HaraldBongartz - 11 Aug 2004, 14 Jan 2006, 31 Aug 2008
--
ReneeBaecker - 13 Aug 2004