mirror of
https://git.FreeBSD.org/doc.git
synced 2026-06-02 11:25:20 +00:00
df05abb2d1
MFde: resync the tools chapter of the fdp-primer Obtained from: The FreeBSD German Documentation Project
173 lines
6.8 KiB
XML
173 lines
6.8 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- 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: r43126
|
|
-->
|
|
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="tools">
|
|
<title>Die Werkzeuge</title>
|
|
|
|
<para>Um die FreeBSD-Dokumentation zu verwalten und in verschiedene
|
|
Formate zu konvertieren, werden diverse Werkzeuge verwendet. Einige
|
|
dieser Werkzeuge sind verpflichtend und müssen auf Ihrem System
|
|
installiert sein, bevor Sie den Beispielen in den folgenden Kapiteln
|
|
folgen können. Andere sind hingegen optional und dienen dazu,
|
|
zusätzliche Funktionalität bereitzustellen oder das Erzeugen der
|
|
Dokumentation zu vereinfachen.</para>
|
|
|
|
<sect1 xml:id="tools-required">
|
|
<title>Verpflichtende Werkzeuge</title>
|
|
|
|
<para>Installieren Sie zuerst den Port
|
|
<filename role="package">textproc/docproj</filename> über die
|
|
Ports-Sammlung. Dieser <emphasis>Metaport</emphasis> installiert
|
|
alle verpflichtenden Werkzeuge für die Arbeit an der
|
|
&os;-Dokumentation. Einige dieser Komponenten werden in den
|
|
folgenden Abschnitten näher beschrieben.</para>
|
|
|
|
<sect2>
|
|
<title>Die DTDs und die Entitäten</title>
|
|
|
|
<para>Das FDP benutzt verschiedene <emphasis>Document Type
|
|
Definitions</emphasis> (<acronym>DTD</acronym>s) und diverse
|
|
<acronym>XML</acronym>-Entitätensätze. Diese werden durch den
|
|
Port <filename role="package">textproc/docproj</filename>
|
|
automatisch installiert.</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><acronym>XHTML</acronym> <acronym>DTD</acronym> (<filename
|
|
role="package">textproc/xhtml</filename>)</term>
|
|
|
|
<listitem>
|
|
<para><acronym>XHTML</acronym> ist die meistverwendete
|
|
Auszeichnungssprache des World Wide Web und wird
|
|
durchgängig für die FreeBSD-Webseite
|
|
genutzt.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>DocBook <acronym>DTD</acronym> (<filename
|
|
role="package">textproc/docbook-xml-450</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>DocBook ist als Auszeichnungssprache für
|
|
technische Dokumentationen entwickelt worden. Ein
|
|
Großteil der FreeBSD-Dokumentation wird mittels DocBook
|
|
erstellt.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>ISO 8879 entities
|
|
(<filename role="package">textproc/iso8879</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Enties des ISO 8879:1986-Standards, 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>
|
|
</sect1>
|
|
|
|
<sect1 xml: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>,
|
|
<application>teTeX</application> und Modular DocBook Stylesheets
|
|
(<filename role="package">print/jadetex</filename>,
|
|
<filename role="package">print/teTeX</filename> und
|
|
<filename role="package">textproc/dsssl-docbook-modular</filename>)</term>
|
|
|
|
<listitem>
|
|
<para><application>Jade</application>,
|
|
<application>teTeX</application> und Modular DocBook
|
|
Stylesheets 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 nicht geplant, die Dokumente in einem dieser
|
|
Formate zu erzeugen (wenn also <acronym>XHTML</acronym>
|
|
und Text ausreichend sind), brauchen Sie diese nicht zu
|
|
installieren. Dazu deaktivieren Sie diese Option im
|
|
Konfigurationsbildschirm des Ports <filename
|
|
role="package">textproc/docproj</filename>.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><application>Vim</application>
|
|
(<filename role="package">editors/vim</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Ein beliebter Texteditor zur Bearbeitung von
|
|
<acronym>XML</acronym> und davon abgeleiteten Dokumenten
|
|
wie DocBook <acronym>XML</acronym>.</para>
|
|
</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 Dokumenten entsprechend den Vorgaben
|
|
einer <acronym>XML</acronym> <acronym>DTD</acronym>.
|
|
Zusätzlich bieten sie
|
|
Funktionen an, mit denen sich der Tippaufwand reduzieren
|
|
und Fehlerwahrscheinlichkeit senken lässt.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|