i18n - 3. Dokumente aktualisieren
Die englische Dokumentation muss zuerst aktualisiert werden, weil sie die Basis ist. Die Aktualisierung kann von einem Mitglied des i18n-Teams (also englische Dokumentatoren) oder einem Mitglied des Core-Teams kommen.
Damit alles glatt geht, sollte wie folgt vorgegangen werden:
3.1 Aufruf für Übersetzungen
Wird ein neues Dokument erstellt oder erfolgen Änderungen der englischen Dokumentation, sollte eine Nachricht in der Mailing-Liste fink-18n verfasst werden, die alle Übersetzer darüber informiert. Die Nachricht sollte folgendes enthalten:
- Eine Notiz in der Betreffzeile, dass dies eine Aufforderung zur Übersetzung ist, also "[translation]" oder "[translation-delayed]", wenn die englische Dokumentation verzögert online gestellt wird.
- Zusätzlich sollte der Dateiname der Basisdatei in der Nachricht enthalten sein.
-
Ein komplettes diff sollte enthalten sein, also:
diff -Nru3 -rlast_revision rhead
damit man die Änderungen in ihrem Kontext sehen kann.
Notiz: Lädt man eine xml-Datei hoch wird automatisch eine Nachricht auf fink-commits erzeugt, die alle Kriterien erfüllt. Das einfachste ist deshalb, diese Nachricht mit einem angepassten Betreff weiter zu leiten. Sind allerdings viele Änderungen gemacht wurden, klappt das leider nicht.
3.2 Neues Dokument
Die englische Version des Dokuments wird hoch geladen und aktiviert und übersetzt wie unten beschrieben.
Notiz: Befindet sich das neue Dokument in einem neuen
Ordner, sollten sie den neuen Ordner im Makefile hinzufügen, der im
Ordner xml
ist. Ansonsten wird die Erstellung
der Dokumentaion nicht erfolgreich sein
3.3 Neue Übersetzungen
Der Team-Leiter einer Sprache (oder sonst jemand mit CVS-Zugang) lädt jedes Dokument hoch und aktiviert es, sobald es fertig ist.
Diese Klassifizierung umfasst:
- Das erste Mal, dass eine Übersetzung eines Dokuments verfasst wird.
- Teilweise Übersetzung eines existierenden Dokuments.
- Übersetzung eines neuen, englischen Dokuments
3.4 Sofortige Aktualisierung der existierenden Dokumentation
Die englische Basisdokumentation wird hoch geladen und sofort aktiviert. Wer die xml-Dateien geändert hat, sollte auch die HTML- und PHP-Dateien hoch laden und aktivieren. Die Übersetzungsteams aktualisieren dann ihre Versionen, laden alle Dateien (XML und PHP) hoch und aktivieren dann die Änderungen.
Niemals die erzeugten php-Dateien ändern; statt dessen immer die xml-Datei ändern.
Überprüfen, dass die Zeile mit cvsid am Anfang der xml-Datei nicht aufgeteilt ist.
Notizen:
- Änderungen in der Internationalisierung-Anleitung (diese Dokument) werden immer nach diesem Schema gemacht, weil sie alle Übersetzungsteams betreffen.
- Änderungen der statischen Dokumente (php-Dateien, die nicht aus xml-Dateien erzeugt werden) werden auch immer nach diesem Schema gemacht, weil es schwierig ist, sie mit einer Verzögerung zu aktivieren.
3.5 Verzögerte Aktualisierung existierender Dokumente (nur für Dateien, die aus xml-Dateien erzeugt werden)
In diesem Fall wird die englische Version der xml-Datei hoch geladen, aber nicht die php- und html-Dateien, d.h. Stopp nach Schritt 5 unter Dynamisch in Kapitel 2.9. Alle Übersetzer erledigen ihre Arbeit und laden innerhalb eines vereinbarten Zeitraums nur ihre xml-Datei hoch (d.h. genau wie für Englisch). Alle php- und html-Dateien werden erzeugt, hoch geladen und gleichzeitig von einer Person, sprich jemand aus dem i18n-Core-Team, zu einem vereinbarten Zeitpunkt aktiviert.
3.6 Für Entwickler und Dokumentatoren für Englisch
Derzeit wird bei allen Dokumenten nach dem Schema sofortige Aktualisierung verfahren, außer es liegen wirklich gewichtige Gründe für eine Ausnahme vor.
Weiter: 4. Zusätzliche Quellen