<!-- 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: de-docproj/books/fdp-primer/tools/chapter.sgml,v 1.7 2005/01/16 17:15:11 mheinen Exp $
     basiert auf: 1.30
-->

<chapter id="tools">
  <title>Die Werkzeuge</title>

  <para>Innerhalb des FDPs werden verschiedene Programme f&uuml;r die
    Verwaltung der FreeBSD-Dokumentation, ihrer Transformation in
    verschiede Formate und weitere Aufgaben eingesetzt. Wer an der
    FreeBSD-Dokumentation mitarbeiten m&ouml;chte, wird diese
    Programme ben&ouml;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&uuml;ssen diese Programme installiert werden,
    bevor alle Beispiele der folgenden Kapitel ausprobiert werden
    k&ouml;nnen.</para>

  <tip>
    <title>
      Wenn es m&ouml;glich ist, sollte der Port
      <filename role="package">textproc/docproj</filename>
      verwendet werden</title>

    <!--
    "Abhaengigkeit zu"?
    Oliver Fischer
    -->
    <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
      &auml;hnliches installiert. Stattdessen enth&auml;lt er eine
      Vielzahl von Abh&auml;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&auml;nden ben&ouml;tigter Port
      ist das JadeTeX-Makro-Paket, das seinerseits eine
      &tex;-Installation voraussetzt. &tex; ist ein ziemlich gro&szlig;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&uuml;r die Installation von
      JadeTeX und &tex; zu sparen, mu&szlig; 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&uuml;nscht wird.
      Sie k&ouml;nnen stattdessen 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 definiert.  Ohne
      <application>JadeTeX</application> k&ouml;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, bevor man sinnvoll
        an der FreeBSD-Dokumentation arbeiten und diese in andere
        Formate wie HTML, reinen Text und RTF umwandeln kann.</para>

      <!-- Dieser Satz sollte sp&auml;ter besser formuliert werden! Oliver Fischer -->
      <!--
      They are all
      included in <filename role="package">textproc/docproj</filename>.
      -->

      <!--<para>These programs are required before you can usefully work with the
      FreeBSD documentation, and they will allow you to convert the
      documentation to HTML, plain text, and RTF formats.  They are all
      included in <filename role="package">textproc/docproj</filename>.</para>-->

      <variablelist>
	<varlistentry>
	  <term><application>SP</application>
	    (<filename role="package">textproc/sp</filename>)</term>

	  <listitem>
            <para>Eine Gruppe von Anwendungen, einschlie&szlig;lich
              eines validierenden SGML-Parsers und eines
              SGML-Normers.</para>
	  </listitem>
	</varlistentry>

	<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
              &uuml;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&ouml;hen.</para>

	    <!--<para>An HTML 'pretty printer', used to reformat some of the
	      automatically generated HTML so that it is easier to
	      follow.</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&ouml;nnen, m&uuml;ssen
              sie nach PNG konvertiert werden.</para>
	  </listitem>
	</varlistentry>
      </variablelist>
    </sect2>

    <sect2>
      <title>Die DTDs und die Entit&auml;ten</title>

      <para>Das FDP benutzt verschiedene DTDs und
        Entit&auml;tens&auml;tze, die installiert sein m&uuml;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&auml;ngig f&uuml;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&uuml;r
              technische Dokumentationen entwickelt worden. Die
              gesamte FreeBSD-Dokumentation wird mittels DocBook
              erstellt.</para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term>ISO 8879-Entit&auml;ten
	    (<filename role="package">textproc/iso8879</filename>)</term>

	  <listitem>
            <para>19 der ISO 8879:1986-Zeichens&auml;tze, die von
              vielen DTDs ben&ouml;tigt werden. Darin enthalten sind
              mathematische Symbole, zus&auml;tzliche Zeichen, die
              f&uuml;r auf dem lateinischen beruhende Alphabete
              ben&ouml;tigt werden und griechische Zeichen.</para>

	    <!--? Ist die &Uuml;bersetzung gut? Oliver Fischer
             <para>19 of the ISO 8879:1986 character entity sets used by many
	      DTDs.  Includes named mathematical symbols, additional
	      characters in the 'Latin' character set (accents, diacriticals,
	      and so on), and Greek symbols.</para>-->
	  </listitem>
	</varlistentry>
      </variablelist>
    </sect2>

    <sect2>
      <title>Die Stilvorlagen</title>

      <para>Die Stilvorlagen werden w&auml;hrend der Transformation und
	der Formatierung von Dokumenten, beispielsweise f&uuml;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&ouml;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&uuml;ssen nicht
      unbedingt installiert werden. Allerdings k&ouml;nnen sie die
      Arbeit an der Dokumentation erleichtern und die Anzahl an
      m&ouml;glichen Ausgabeformaten erh&ouml;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&uuml;r m&uuml;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&ouml;tigt, kann so Zeit und Plattenplatz gespart
              werden.</para>


            <important>
              <para>Wird sich f&uuml;r die Installation von
                <application>JadeTeX</application> und
                <application>teTeX</application> entschieden,
                mu&szlig; <application>teTeX</application>
                anschlie&szlig;end noch eingerichtet werden. Die Datei
                <filename>print/jadetex/pkg-message</filename>
                enth&auml;lt detailierte Angaben zu den daf&uuml;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&auml;tzlich bieten sie
              Funktionen an, mit denen sich der Tippaufwand reduzieren
              und Fehlerwahrscheinlichkeit senken
              l&auml;&szlig;t.</para>


            <!--? Kandidat f&uuml;r Optimierung Oliver Fischer -->
            <para>Nat&uuml;rlich mu&szlig; nicht mit einem dieser
              Texteditoren gearbeitet werden; jeder andere Editor kann
              daf&uuml;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&auml;ge haben, welche andere
        Software f&uuml;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>

<!--
     Local Variables:
     mode: sgml
     sgml-declaration: "../chapter.decl"
     sgml-indent-data: t
     sgml-omittag: nil
     sgml-always-quote-attributes: t
     sgml-parent-document: ("../book.sgml" "part" "chapter")
     End:
-->
