322 lines
12 KiB
XML
322 lines
12 KiB
XML
<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
|
|
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
|
|
|
|
Redistribution and use in source (SGML DocBook) and 'compiled' forms
|
|
(SGML, HTML, PDF, PostScript, RTF and so forth) with or without
|
|
modification, are permitted provided that the following conditions
|
|
are met:
|
|
|
|
1. Redistributions of source code (SGML DocBook) must retain the above
|
|
copyright notice, this list of conditions and the following
|
|
disclaimer as the first lines of this file unmodified.
|
|
|
|
2. Redistributions in compiled form (transformed to other DTDs,
|
|
converted to PDF, PostScript, RTF and other formats) must reproduce
|
|
the above copyright notice, this list of conditions and the
|
|
following disclaimer in the documentation and/or other materials
|
|
provided with the distribution.
|
|
|
|
THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY EXPRESS OR
|
|
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR ANY DIRECT,
|
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
$FreeBSD$
|
|
$FreeBSDde$
|
|
basiert auf: r38826
|
|
-->
|
|
|
|
<chapter id="tools">
|
|
<title>Die Werkzeuge</title>
|
|
|
|
<para>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.</para>
|
|
|
|
<para>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.</para>
|
|
|
|
<para>Allerdings müssen diese Programme installiert werden,
|
|
bevor alle Beispiele der folgenden Kapitel ausprobiert werden
|
|
können.</para>
|
|
|
|
<tip>
|
|
<title>
|
|
Wenn es möglich ist, sollte der Port
|
|
<filename role="package">textproc/docproj</filename>
|
|
verwendet werden</title>
|
|
|
|
<para>Durch die Installation des Ports <filename
|
|
role="package">textproc/docproj</filename> kann die
|
|
Installation vereinfacht und eine Menge Zeit gespart werden. Bei
|
|
diesem Port handelt es sich um einen
|
|
<emphasis>Metaport</emphasis>, 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
|
|
<emphasis>sollten</emphasis> automatisch alle Pakete, die in
|
|
diesem Kapitel genannt werden, auf den Rechner geladen und dort
|
|
installiert werden.</para>
|
|
|
|
<para>Ein nur unter bestimmten Umständen benötigter Port
|
|
ist das <application>JadeTeX</application>-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.</para>
|
|
|
|
<para>Um den Platz und die Zeit für die Installation von
|
|
<application>JadeTeX</application> und &tex; zu sparen,
|
|
muß bei der Installation
|
|
angeben werden, ob JadeTeX (und damit auch &tex;) installiert
|
|
werden soll oder nicht.</para>
|
|
|
|
<para>Daher sollte der docproj-Port entweder mit</para>
|
|
|
|
<screen>&prompt.root; <userinput>make JADETEX=yes install</userinput></screen>
|
|
|
|
<para>oder mit</para>
|
|
|
|
<screen>&prompt.root; <userinput>make JADETEX=no install</userinput></screen>
|
|
|
|
<para>installiert werden, je nachdem was gewünscht wird.
|
|
Alternativ können Sie auch direkt die Ports
|
|
<filename role="package">textproc/docproj-jadetex</filename> oder
|
|
<filename role="package">textproc/docproj-nojadetex</filename>
|
|
installieren. Die Variable <makevar>JADETEX</makevar> wird
|
|
von diesen Ports automatisch entsprechend gesetzt. Ohne
|
|
<application>JadeTeX</application> können Sie nur die Formate
|
|
HTML und ASCII erzeugen. Die Formate PostScript und PDF
|
|
erfordern <application>&tex;</application>.</para>
|
|
</tip>
|
|
|
|
<sect1 id="tools-mandatory">
|
|
<title>Notwendige Werkzeuge</title>
|
|
|
|
<sect2>
|
|
<title>Software</title>
|
|
|
|
<para>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 <filename
|
|
role="package">textproc/docproj</filename> installiert
|
|
werden.</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><application>Jade</application> (<filename
|
|
role="package">textproc/jade</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Eine DSSSL-Implementierung. Sie wird gebraucht, um
|
|
Dokumente in andere Formate wie HTML und &tex; zu
|
|
übersetzen.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><application>Tidy</application>
|
|
(<filename role="package">www/tidy</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Ein Formatierer, mit dem man Teile der automatisch
|
|
generierten HTML-Dateien neuformatieren kann, um ihre
|
|
Lesbarkeit zu erhöhen.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><application>Links</application> (<filename
|
|
role="package">www/links</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Ein Textbrowser, der HTML-Dateien in einfache Textdateien
|
|
umwandeln kann.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><application>peps</application>
|
|
(<filename role="package">graphics/peps</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>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.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>Die DTDs und die Entitäten</title>
|
|
|
|
<para>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.</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>HTML DTD (<filename role="package">textproc/html</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>HTML ist die bevorzugte <!-- ??? -->
|
|
Auszeichnungssprache des World Wide Web und wird
|
|
durchgängig für die FreeBSD-Webseite
|
|
genutzt.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>DocBook DTD (<filename role="package">textproc/docbook</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>DocBook ist als Auszeichnungssprache für
|
|
technische Dokumentationen entwickelt worden. Die
|
|
gesamte FreeBSD-Dokumentation wird mittels DocBook
|
|
erstellt.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>ISO 8879-Entitäten
|
|
(<filename role="package">textproc/iso8879</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>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.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>Die Stilvorlagen</title>
|
|
|
|
<para>Die Stilvorlagen werden während der Transformation und
|
|
der Formatierung von Dokumenten, beispielsweise für die
|
|
Bildschirmdarstellung oder den Druck, benutzt.</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>Modular DocBook Stylesheets (<filename
|
|
role="package">textproc/dsssl-docbook-modular</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Die Modular DocBook Stylesheets werden
|
|
benötigt, wenn mittels DocBook erstellte Dokumente
|
|
in Formate wie HTML oder RTF konvertiert werden
|
|
sollen.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</sect2>
|
|
</sect1>
|
|
|
|
<sect1 id="tools-optional">
|
|
<title>Optionale Werkzeuge</title>
|
|
|
|
<para>Die in diesem Kapitel genannten Programme müssen nicht
|
|
unbedingt installiert werden. Allerdings können sie die
|
|
Arbeit an der Dokumentation erleichtern und die Anzahl an
|
|
möglichen Ausgabeformaten erhöhen.</para>
|
|
|
|
<sect2>
|
|
<title>Software</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><application>JadeTeX</application> und
|
|
<application>teTeX</application> (<filename
|
|
role="package">print/jadetex</filename> und <filename
|
|
role="package">print/teTeX</filename>)</term>
|
|
|
|
<listitem>
|
|
<para><application>Jade</application> und
|
|
<application>teTeX</application> werden eingesetzt, um
|
|
DocBook-Dokumente nach DVI, Postscript und PDF zu
|
|
konvertieren. Hierfür müssen die
|
|
<application>JadeTeX</application> Makros installiert
|
|
sein.</para>
|
|
|
|
<para>Ist es nicht geplant, die Dokumente in einem dieser
|
|
Formate zu erzeugen, wenn also HTML, Text und RTF
|
|
ausreichend sind, brauchen
|
|
<application>JadeTeX</application> und
|
|
<application>teTeX</application> nicht installiert zu
|
|
werden. Da die Installation von
|
|
<application>teTeX</application> insgesamt 30 MB
|
|
benötigt, kann so Zeit und Plattenplatz gespart
|
|
werden.</para>
|
|
|
|
|
|
<important>
|
|
<para>Wird sich für die Installation von
|
|
<application>JadeTeX</application> und
|
|
<application>teTeX</application> entschieden,
|
|
muß <application>teTeX</application>
|
|
anschließend noch eingerichtet werden. Die Datei
|
|
<filename>print/jadetex/pkg-message</filename>
|
|
enthält detailierte Angaben zu den dafür
|
|
notwendigen Schritten.</para>
|
|
</important>
|
|
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><application>Emacs</application> oder
|
|
<application>XEmacs</application> (<filename
|
|
role="package">editors/emacs</filename> oder <filename
|
|
role="package">editors/xemacs</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Beide Texteditoren haben einen speziellen Modus zur
|
|
Bearbeitung von SGML-Dokumenten entsprechend den
|
|
Vorgaben einer SGML-DTD. Zusätzlich bieten sie
|
|
Funktionen an, mit denen sich der Tippaufwand reduzieren
|
|
und Fehlerwahrscheinlichkeit senken
|
|
läßt.</para>
|
|
|
|
|
|
<!--? Kandidat für Optimierung Oliver Fischer -->
|
|
<para>Natürlich muß nicht mit einem dieser
|
|
Texteditoren gearbeitet werden; jeder andere Editor kann
|
|
dafür genausogut genutzt werden, doch vielleicht
|
|
wird die Arbeit durch sie als effektiver empfunden
|
|
werden.</para>
|
|
|
|
<!--? Der vorherige Satz ist auch nicht erste Sahne. -->
|
|
<!--<para>You do not need to use them; any text editor can be used to
|
|
edit marked up documents. You may find they make you more
|
|
efficient.</para>-->
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<para>Sofern Sie Vorschläge haben, welche andere
|
|
Software für die Verarbeitung oder Bearbeitung von
|
|
SGML-Dokumenten in diese Liste mitaufgenommen werden sollte,
|
|
senden Sie diese bitte an &a.doceng;.</para>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|