[prev in list] [next in list] [prev in thread] [next in thread]
List: pear-doc
Subject: [PEAR-DOC] cvs: peardoc /de/chapters contributing.xml /de/chapters/faq documentation.xml
From: "Alexander Merz" <alexmerz () php ! net>
Date: 2007-02-25 21:26:00
Message-ID: cvsalexmerz1172438760 () cvsserver
[Download RAW message or body]
alexmerz Sun Feb 25 21:26:00 2007 UTC
Added files:
/peardoc/de/chapters/faq documentation.xml
Modified files:
/peardoc/de/chapters contributing.xml
Log:
sync to en
["alexmerz-20070225212600.txt" (text/plain)]
http://cvs.php.net/viewvc.cgi/peardoc/de/chapters/contributing.xml?r1=1.1&r2=1.2&diff_format=u
Index: peardoc/de/chapters/contributing.xml
diff -u peardoc/de/chapters/contributing.xml:1.1 peardoc/de/chapters/contributing.xml:1.2
--- peardoc/de/chapters/contributing.xml:1.1 Wed Oct 11 07:23:04 2006
+++ peardoc/de/chapters/contributing.xml Sun Feb 25 21:26:00 2007
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.1 $ -->
-<!-- EN-Revision: 1.16 Maintainer: alexmerz Status: ready -->
+<!-- $Revision: 1.2 $ -->
+<!-- EN-Revision: 1.17 Maintainer: alexmerz Status: ready -->
<chapter id="contributing">
<chapterinfo>
<author>
@@ -85,8 +85,11 @@
</para>
<para>
- Im nächsten Schritt müssen Sie den Patch versenden. Dazu schreiben
- Sie eine Email an die Mailingliste &email.pear.dev; und ergänzen
+ Im nächsten Schritt müssen Sie den Patch versenden. Dafür gibt es zwei
+ Wege: Sie können einen Bug-Report für das betreffende Package erstellen.
+ Auf der Webseite des Packages auf pear.php.net klicken Sie dazu den
+ "Bugs"-Reiter an. Den Patch fügen Sie in die Fehlerbeschreibung ein.
+ Oder Sie schreiben eine Email an die Mailingliste &email.pear.dev; und ergänzen
die EMail-Adresse des/der Package-Maintainer im CC-Feld der Email.
Der Betreff der Email sollte mit <quote>[Patch]</quote> beginnen,
um klar anzuzeigen, das es sich um einen Patch handelt. Auch sollten
http://cvs.php.net/viewvc.cgi/peardoc/de/chapters/faq/documentation.xml?view=markup&rev=1.1
Index: peardoc/de/chapters/faq/documentation.xml
+++ peardoc/de/chapters/faq/documentation.xml
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<!-- EN-Revision: 1.2 Maintainer: alexmerz Status: ready -->
<sect1 id="faq.documentation">
<title>Dokumentations- und Übersetzungs-FAQ</title>
<sect2 id="faq.docs-pagedoesnotshowup">
<title>
I habe neue Dokumentation für ein Packages ergänzt,
aber die neuen Seiten erscheinen nicht im erzeugten
Handbuch.
</title>
<titleabbrev>Neue Seiten nicht sichtbar</titleabbrev>
<para>
In den meisten Fällen haben Sie vergessen, erneut <command>./configure</command>
aufzurufen. Damit werden die neuen Seiten erkannt und auch eingebunden.
</para>
<para>
Ein anderer Grund kann sein, dass Sie nicht die erforderlichen Verknüpfungen
in der der übergeordneten Seite eingefügt haben. Im Verzeichnis
<filename>en/package/</filename> befinden sich die XML-Dateien für die
einzelnen Kategorien, welche die entsprechenden Verknüpfungen
beinhalten. Ergänzen Sie in der entsprechenden Datei die Verknüpfung
zu Ihrem neuen Eintrag.
</para>
</sect2>
<sect2 id="faq.docs-allonterminal">
<title>
Das erzeugte Handbuch wird auf der Konsole ausgegeben,
es werden aber keine Dateien erzeugt!
</title>
<titleabbrev>Handbuch erscheint auf der Konsole</titleabbrev>
<para>
<filename>configure</filename> hat nicht die erforderlichen Docbook-DSSSL-Stylesheets
gefunden. Prüfen Sie ob die Verzeichnisangaben stimmen und ob die Stylesheets
auf dem Rechner verfügbar sind.
</para>
</sect2>
<sect2 id="faq.translators-revision-tracking">
<title>
Gibt es ein Programm für Übersetzer, um die Änderungen
an Dateien zu verfolgen?
</title>
<titleabbrev>
Revisions-Verfolgung
</titleabbrev>
<para>
Wenn Sie an der Übersetzung arbeiten, bedeutet das nicht nur einfach
den englischen Text zu übersetzen und das Ergebnis hochzuladen.
Ein Großteil der Arbeit besteht vorallem darin, die bereits übersetzten
Inhalte auch aktuell zu halten. Um die Änderung an den englischen
Originaltexte zu verfolgen, sollten Sie die
<ulink url="mailto:&email.pear.doc-subscribe;">Dokumentations-Mailingliste von
PEAR</ulink> abonnieren. So erhalten Sie die CVS-Benachrichtigungen,
wenn neue Dateien hochgeladen oder geändert wurden. Wenn Sie
die Übersetzung nicht regelmäßig pflegen, kann sie schnell
nutzlos werden.
</para>
<para>
Es ist nicht einfach, den Überblick zu behalten, wenn man die Änderungen
an Inhalten in einer fremden Sprache verfolgen muss. Deswegen
existiert ein entsprechendes System um die Versionsänderungen
und Modifikationen anhand von Zeitstempeln in <literal>peardoc</literal>
zu verfolgen.
</para>
<sect3 id="faq.translators.revcheck-comments">
<title>Die Revisions-Kommentare</title>
<para>
Anstatt Informationen zum Übersetzungsstand in einer zentralen Datei
zu speichern, enthält jede einzelne Datei einen entsprechenden
Eintrag. Dieser Eintrag enthält den Benutzername des Übersetzers, die
Revisionsnummer und den Übersetzungsstatus.
Betrachten wir dies am Beispiel der Datei
<filename>bookinfo.xml</filename>:
<programlisting>
<!-- EN-Revision: 1.16 Maintainer: jane Status: ready -->
</programlisting>
</para>
<para>
Sie sehen die Revisionsnummer derjenigen englischen Datei, die für
die Überstetzung verwendet wurde (EN-Revision: 1.16), und
der Name des CVS-Accounts, welcher die (initiale) Übersetzung
vorgenommen hat.
Die Status-Angabe liefert weitere Informationen, wenn erforderlich,
z.B. "partial" für unvollständige Übersetzungen. Die dezentrale
Speicherung dieser Daten ist äusserst praktikabel, schließlich
existieren mittlerweile mehr 2400 Dateien im englischen
Sprachzweig.
</para>
<para>
Derzeit müssen alle drei Felder (EN-Revisionsnummer, Maintainer, Status)
angegeben werden. Die Maintainer-Angabe sollte dem CVS-Benutzernamen
entsprechen, kann aber auch ein beliebiger Name sein, dieser darf
aber keine Leerzeichen enthalten. Die Statusangabe kann jeden Wert
annehmen, aber auch dieser darf kein Leerzeichen enthalten.
Achtung: Dieser Kopf-Angabe wird nicht durch das CVS aktuell
gehalten! Sie müssen ihn manuell anpassen, wenn Sie Änderungen
an einer Datei vornehmen.
</para>
<para>
So praktikabel dieses System für eine einzelne Datei ist, so
schwierig wird es die Übersicht über alle Dateien zu behalten.
Wenn Sie eine Liste benötigen, bei welchen Dateien z.B.
die Übersetzung veraltet ist, dann rufen Sie im
<filename>peardoc</filename>-Verzeichnis folgendes Kommando auf:
<programlisting>../scripts/revcheck_pear.php xx > revcheck.html
</programlisting>
Das <literal>xx</literal> steht für den Sprachcode der übersetzten
Sprache.
Nach dem das Skript durchgelaufen ist, befindet sich
die Datei <filename>revcheck.html</filename> in diesem
Verzeichnis.
Sie finden Vergleiche der Revisionsnummern und Links
zur Anzeige der Diffs für die betreffende Sprache.
Sie können beim Skriptaufruf zusätzlich den Maintainer-Namen
angeben, dessen Dateien ausschließlich beachtet werden sollen.
</para>
<para>
Leider können in den Kommentaren keine weiterführenden
Informationen untergebracht werden. Deshalb können zusätzliche
Angaben in <filename>translation.xml</filename> untergebracht
werden. Diese werden in die erzeugte HTML-Seite eingefügt.
Hier am Beispiel für die imaginäre Sprache XX:
<programlisting><![CDATA[
<?xml version="1.0" encoding="iso-8859-1" ?>
<!DOCTYPE translation SYSTEM "../dtds/translation.dtd">
<translation>
<intro>
Dieser Text enthält Informationen für Übersetzer für die Sprache XX,
u.a. wer die Überstezung leitet und wo Sie weiterführende Informationen
finden. Dieser Absatz wird am Anfang der erzeugten HTML-Seite
ausgegeben.
</intro>
<translators>
<person name="Joe Doe" email="joe@hotmail.com"
nick="joedoe" cvs="yes" editor="yes"/>
<person name="Jane Smith" email="jsmith@yahoo.com"
nick="jane" cvs="yes"/>
<person name="Joe Forever" email="joe@forever.net"
nick="joefo" cvs="no"/>
</translators>
<work-in-progress>
<file name="appendices/aliases.xml" person="joedoe"
type="working"/>
<file name="functions/dbx.xml" person="joefo"
type="working"/>
</work-in-progress>
</translation>
]]></programlisting>
In der Datei können auch Benutzer angegeben werden, die keinen
CVS-Account besitzen. Weiterhin können Sie Dokumente auflisten,
welche in Bearbeitung oder bereits fertig gestellt sind.
Die enthaltenen Angaben werden verwendet, um die dynamisch erzeugten
Tabellen der Übersetzer und Dateien zu bilden.
Die Übersetzer werden mit den entsprechenden Dateien verknüpft, und
es wird dargestellt, welchen Übersetzungs-Status die Dateien
besitzen, für welche ein Übersetzer zuständig ist.
Die Zuweisung von bereits übersetzten Dateien ist sinnvoll,
wenn ein zeitaufwendiges Update der Übersetzung notwendig ist.
</para>
<para>
Sie können im <file>-Tag zwei optionale Attribute angeben:
<literal>date</literal> und <literal>revision</literal>.
Die Datums-Angabe kennzeichnet den Beginn der Übersetzung;
die Revisions-Angabe enthält das Release der englischen Datei, welche
als erste für die Übersetzung verwendet wurde.
Für das Format des <literal>date</literal>-Attributes gibt es
keine Vorgabe.
</para>
<para>
Mit einer weiteren Erweitung des Systems können Sie ehemalige Übersetzer
Tribut zollen. Dazu können Sie einen Kommentar in der übersetzten Datei
platzieren:
<programlisting>
<!-- CREDITS: joedoe -->
</programlisting>
Sie können auch mehrere Namen angeben, getrennt durch Komma.
Die Angaben werden in der HTML-Datei mit bei den Übersetzern aufgeführt.
</para>
</sect3>
</sect2>
</sect1>
--
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic