Die Fibel für neue Mitarbeiter des FreeBSD-Dokumentationsprojekts
Zurück |  | Weiter

# Kapitel 2. Die Werkzeuge

Innerhalb des FDPs werden verschiedene Programme für die Verwaltung der FreeBSD-Dokumentation, ihrer Transformation in verschiede Formate und weitere Aufgaben eingesetzt. Wer an der FreeBSD-Dokumentation mitarbeiten möchte, wird diese Programme benötigen.

Doch dies ist kein Grund zur Angst, da alle notwendigen Programme als FreeBSD-Ports und fertige Pakete vorhanden sind, wodurch sich die Installation drastisch vereinfacht.

Allerdings müssen diese Programme installiert werden, bevor alle Beispiele der folgenden Kapitel ausprobiert werden können.

> Wenn es möglich ist, sollte der Port `textproc/docproj` verwendet werden: Durch die Installation des Ports `textproc/docproj` kann die Installation vereinfacht und eine Menge Zeit gespart werden. Bei diesem Port handelt es sich um einen Metaport, der selbst keine Programme oder ähnliches installiert. Stattdessen enthält er eine Vielzahl von Abhängigkeiten zu anderen Ports und setzt deren korrekte Installation voraus. Durch seine Installation sollten automatisch alle Pakete, die in diesem Kapitel genannt werden, auf den Rechner geladen und dort installiert werden.

> Ein nur unter bestimmten Umständen benötigter Port ist das JadeTeX-Makro-Paket, das seinerseits eine TeX-Installation voraussetzt. TeX ist ein ziemlich großes Programmpaket und sollte nur installiert werden, sofern Zieldokumente im PostScript- oder PDF-Format generiert werden sollen.

> Um den Platz und die Zeit für die Installation von JadeTeX und TeX zu sparen, muß bei der Installation angeben werden, ob JadeTeX (und damit auch TeX) installiert werden soll oder nicht.

> Daher sollte der docproj-Port entweder mit

>     # make JADETEX=yes install

> oder mit

>     # make JADETEX=no install

> installiert werden, je nachdem was gewünscht wird. Alternativ können Sie auch direkt die Ports `textproc/docproj-jadetex` oder `textproc/docproj-nojadetex` installieren. Die Variable `JADETEX` wird von diesen Ports automatisch entsprechend gesetzt. Ohne JadeTeX können Sie nur die Formate HTML und ASCII erzeugen. Die Formate PostScript und PDF erfordern TeX.

# 2.1. Notwendige Werkzeuge

## 2.1.1. Software

Die folgenden Programme sind notwendig, um sinnvoll an der FreeBSD-Dokumentation arbeiten und diese in andere Formate wie HTML, reinen Text und RTF umwandeln zu können. Sie müssen diese aber nicht seperat installieren, da alle Programme automatisch durch den Metaport `textproc/docproj` installiert werden.

Jade (`textproc/jade`)

  Eine DSSSL-Implementierung. Sie wird gebraucht, um Dokumente in andere Formate wie HTML und TeX zu übersetzen.

Tidy (`www/tidy`)

  Ein Formatierer, mit dem man Teile der automatisch generierten HTML-Dateien neuformatieren kann, um ihre Lesbarkeit zu erhöhen.

Links (`www/links`)

  Ein Textbrowser, der HTML-Dateien in einfache Textdateien umwandeln kann.

peps (`graphics/peps`)

  Einige der Dokumente enthalten Grafiken, die nur im EPS-Format vorliegen. Damit diese von dem meisten Webbrowsern angezeigt werden können, müssen sie nach PNG konvertiert werden.

## 2.1.2. Die DTDs und die Entitäten

Das FDP benutzt verschiedene DTDs und Entitätensätze, die installiert sein müssen, bevor mit der Arbeit an einem beliebigen Dokument begonnen werden kann.

HTML DTD (`textproc/html`)

  HTML ist die bevorzugte Auszeichnungssprache des World Wide Web und wird durchgängig für die FreeBSD-Webseite genutzt.

DocBook DTD (`textproc/docbook`)

  DocBook ist als Auszeichnungssprache für technische Dokumentationen entwickelt worden. Die gesamte FreeBSD-Dokumentation wird mittels DocBook erstellt.

ISO 8879-Entitäten (`textproc/iso8879`)

  19 der ISO 8879:1986-Zeichensätze, die von vielen DTDs benötigt werden. Darin enthalten sind mathematische Symbole, zusätzliche Zeichen, die für auf dem lateinischen beruhende Alphabete benötigt werden sowie griechische Zeichen.

## 2.1.3. Die Stilvorlagen

Die Stilvorlagen werden während der Transformation und der Formatierung von Dokumenten, beispielsweise für die Bildschirmdarstellung oder den Druck, benutzt.

Modular DocBook Stylesheets (`textproc/dsssl-docbook-modular`)

  Die Modular DocBook Stylesheets werden benötigt, wenn mittels DocBook erstellte Dokumente in Formate wie HTML oder RTF konvertiert werden sollen.

Zurück | Zum Anfang | Weiter
Der Schnellstart |  | Optionale Werkzeuge

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>.