Falls man einfach loslegen möchte und sich sicher genug fühlt, um alles weitere erst bei Bedarf nachzusehen, kann man einfach den folgenden Anweisungen folgen:
Zuerst muß der Metaport textproc/docproj
auf dem
betreffenden Arbeitsrechner installiert werden.
#
cd /usr/ports/textproc/docproj
#
make JADETEX=no install
Laden Sie mit svn eine lokale
Kopie des FreeBSD-doc
-Verzeichnisbaumes
herunter.
Selbst wenn Sie nur über eine geringe Bandbreite
oder wenig freien Plattenplatz verfügen, müssen Sie
mindestens die Verzeichnisse head/share
sowie
head/
auschecken, um an der Dokumentation arbeiten zu können.
Dazu ein Beispiel:language
/share
%
mkdir -p head/share
%
mkdir -p head/en_US.ISO8859-1/share
%
svn checkout https://svn0.us-
east.FreeBSD.org
/doc/head/share head/share
%
svn checkout https://svn0.us-
east.FreeBSD.org
/doc/head/en_US.ISO8859-1/share head/en_US.ISO8859-1/share
Für den Fall, dass ausreichend Platz auf der Festplatte vorhanden ist, kann auch eine vollständige Arbeitskopie des gesamten Subversion-Baumes anlegt werden.
%
svn checkout https://svn0.us-
east.FreeBSD.org
/doc/head head
svn0.us-east.FreeBSD.org ist ein öffentlicher Server. Wählen Sie einen Mirror in Ihrer Nähe und überprüfen Sie das Serverzertifikat auf der Seite Subversion mirror sites.
Sollte geplant sein, ein existierendes Buch oder einen existierenden Artikel zu ändern, muß natürlich noch zusätzlich das betreffende Verzeichnis aus dem CVS-Archiv geholt werden. Soll hingegen ein neues Buch oder ein neuer Artikel geschrieben werden, empfiehlt es sich, auf bestehende Bücher und Artikel zurückzugreifen und diese als Vorlage zu nutzen.
Ein Artikel über die Konfiguration eines VPNs zwischen FreeBSD und Windows 2000 kann wie folgt erstellt werden:
Zuerst wird das Verzeichnis
articles
aus dem FreeBSD-CVS-Archiv
lokal angelegt:
%
svn checkout https://svn0.us-
east.FreeBSD.org
/doc/head/en_US.ISO8859-1/articles
Anschließend kopiert man einen bereits
existierenden Artikel und nutzt ihn als Vorlage. In
diesem Beispiel soll der neue Artikel im Verzeichnis
vpn-w2k
liegen:
%
cd head/en_US.ISO8859-1/articles
%
svn export committers-guide vpn-w2k
Bereits existierende Dokumente, die geändert
werden sollen, können direkt aus dem CVS-Archiv
geholt werden. Das folgende Beispiel zeigt das
für die FAQ aus dem Verzeichnis
head/en_US.ISO8859-1/books/faq
:
%
svn checkout https://svn0.us-
east.FreeBSD.org
/doc/head/en_US.ISO8859-1/books/faq
Jetzt können die .xml
Dateien
mit einem beliebigen Texteditor bearbeitet werden.
Danach ist make
mit dem Ziel
lint
aufzurufen, um das gesamte
Dokument auf Auszeichnungsfehler hin zu untersuchen, ohne
dass zeitaufwändige Transformationen vorgenommen
werden.
%
make lint
Soll anschließend das Zieldokument erstellt
werden, kann mit Hilfe der Variable
FORMATS
bestimmt werden, welche
Ausgabeformate erzeugt werden sollen. Unterstützt werden
momentan html
,
html-split
, txt
,
ps
, pdf
und
rtf
. Die aktuelle Liste der
unterstützten Formate befindet sich am Anfang der Datei
head/share/mk/doc.docbook.mk
. Bei der
Verwendung dieser Variable ist es wichtig, darauf zu achten,
dass die Angabe der gewünschten Formate in
Anführungszeichen eingeschlossen wird, sofern mehr als
nur ein Format gleichzeitig erstellt werden soll.
Wenn das Dokument beispielsweise nach
HTML
konvertiert werden soll, kann dies
so vorgenommen werden:
%
make FORMATS=html
Soll es hingegen in den Formaten html
und txt
erzeugt werden,
kann man entweder
make(1) zweimal hintereinander aufrufen:
%
make FORMATS=html
%
make FORMATS=txt
oder beide Formate mit einem Aufruf von make(1) erzeugen:
%
make FORMATS="html txt"
Zum Schluss müssen die Änderungen an das FDP mittels send-pr(1) eingesandt werden.
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>.