1.2. Schnellstart

Dieser Abschnitt beschreibt, was Sie tun müssen, bevor Sie Änderungen an der FreeBSD-Dokumentation vornehmen können. Abonnieren Sie zuerst die Mailingliste FreeBSD documentation project. Einige Mitglieder dieser Mailingliste sind auch auf dem IRC-Kanal #bsddocs auf EFnet erreichbar. Nehmen Sie mit Ihnen Kontakt auf, wenn Sie Fragen oder Probleme bei der Arbeit an der FreeBSD-Dokumentation haben.

  1. Installieren Sie den Metaport textproc/docproj als Port oder Paket, um automatisch alle für die Arbeit an der Dokumentation benötigten Werkzeuge zu installieren.

  2. Installieren Sie eine lokale Arbeitskopie der Dokumentation von einem Spiegelserver des FreeBSD-Repository nach ~/doc (lesen Sie dazu auch Kapitel 3, Die Arbeitskopie).

    % svn checkout https://svn0.us-west.FreeBSD.org/doc/head ~/doc
  3. Ihr Texteditor sollte für die Arbeit an der FreeBSD-Dokumentation wie folgt konfiguriert sein:

    • Zeilenumbruch nach 70 Zeichen.

    • Tabstop auf 2 Zeichen.

    • 8 Leerzeichen sollen durch einen Tabstop ersetzt werden.

    Konfigurationen für einige häufig verwendete Editoren finden Sie im Kapitel 12, Der Schreibstil.

  4. Aktualisieren Sie Ihre lokale Arbeitskopie:

    % svn up ~/doc
  5. Bearbeiten Sie die Datei. Bevor Sie umfangreiche Änderungen an einer Datei vornehmen, kündigen Sie die geplanten Änderungen bitte auf der Mailingliste an.

    Eine Auflistung häufig verwendeter Tags und Entities finden Sie in Kapitel 8, XHMTL Markup (noch nicht übersetzt) und in Kapitel 9, DocBook Markup (noch nicht übersetzt).

  6. Nachdem Sie Ihre Änderungen vorgenommen haben, prüfen Sie diese auf potentielle Probleme:

    % igor -R filename.xml | less -RS

    Werden Fehler gemeldet, editieren Sie die Datei erneut. Speichern Sie das Ergebnis und fühen Sie den Test erneut aus. Wiederholen Sie dies solange, bis keine Fehler mehr gemeldet werden.

  7. Bauen Sie die Dokumentation immer, bevor Sie Änderungen einreichen. Dazu führen Sie make im Hauptverzeichnis des Dokuments aus, dass Sie gerade bearbeiten. Um beispielsweise die deutsche Version des FreeBSD-Handbuchs als einzelne HTML-Dateien zu bauen, führen Sie make im Verzeichnis de_DE.ISO8859-1/books/handbook/ aus. Durch diesen Schritt wird sichergestellt, dass Ihre Änderungen den Bau der Dokumentation nicht wegen eines Fehlers abbrechen.

  8. Wenn Ihre Änderungen abgeschlossen und erfolgreich getestet wurden, erzeugen Sie eine Differenzdatei mit Ihren Änderungen:

    % cd ~/doc
    % svn diff > bsdinstall.diff.txt

    Geben Sie der Differenzdatei einen aussagekräftigen Namen. Im angegebenen Bespiel wurden Änderungen im Abschnitt bsdinstall des Handbuchs vorgenommen.

  9. Reichen Sie Ihre Änderungen über das webbasierte Problembericht-Formular ein. Geben Sie eine kurze Beschreibung in der Form [patch] kurze Beschreibung des Problems ein. Als Kategorie wählen Sie docs und als Klasse doc-bug. Danach geben Sie eine Beschreibung Ihrer Änderungen ein sowie eventuelle weitere wichtige Punkte. Verwenden Sie danach den Button [ Browse... ], um Ihre Differenzdatei hochzuladen.

Wenn Sie Fragen zu FreeBSD haben, schicken Sie eine E-Mail an <de-bsd-questions@de.FreeBSD.org>.

Wenn Sie Fragen zu dieser Dokumentation haben, schicken Sie eine E-Mail an <de-bsd-translators@de.FreeBSD.org>.