Date: Mon, 8 Jun 2015 16:14:12 +0000 (UTC) From: Johann Kois <jkois@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r46790 - head/de_DE.ISO8859-1/books/fdp-primer/tools Message-ID: <201506081614.t58GECPp098235@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: jkois Date: Mon Jun 8 16:14:12 2015 New Revision: 46790 URL: https://svnweb.freebsd.org/changeset/doc/46790 Log: r39631 -> r43126 MFde: resync the tools chapter of the fdp-primer Obtained from: The FreeBSD German Documentation Project Modified: head/de_DE.ISO8859-1/books/fdp-primer/tools/chapter.xml Modified: head/de_DE.ISO8859-1/books/fdp-primer/tools/chapter.xml ============================================================================== --- head/de_DE.ISO8859-1/books/fdp-primer/tools/chapter.xml Mon Jun 8 15:54:38 2015 (r46789) +++ head/de_DE.ISO8859-1/books/fdp-primer/tools/chapter.xml Mon Jun 8 16:14:12 2015 (r46790) @@ -30,148 +30,45 @@ $FreeBSD$ $FreeBSDde$ - basiert auf: r39631 + 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>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 - <package>textproc/docproj</package> - verwendet werden</title> - - <para>Durch die Installation des Ports <package>textproc/docproj</package> 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 - <package>textproc/docproj-jadetex</package> oder - <package>textproc/docproj-nojadetex</package> - installieren. Die Variable <varname>JADETEX</varname> 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 &tex;.</para> - </tip> - - <sect1 xml: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 separat - installieren, da alle Programme automatisch durch den - Metaport <package>textproc/docproj</package> installiert - werden.</para> - - <variablelist> - <varlistentry> - <term><application>Jade</application> (<package>textproc/jade</package>)</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> - (<package>www/tidy</package>)</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> (<package>www/links</package>)</term> - - <listitem> - <para>Ein Textbrowser, der HTML-Dateien in einfache Textdateien - umwandeln kann.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><application>peps</application> - (<package>graphics/peps</package>)</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> + <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 DTDs und - Entitätensätze, die installiert sein müssen, - bevor mit der Arbeit an einem beliebigen Dokument begonnen - werden kann.</para> + <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>HTML DTD (<package>textproc/html</package>)</term> + <term><acronym>XHTML</acronym> <acronym>DTD</acronym> (<filename + role="package">textproc/xhtml</filename>)</term> <listitem> - <para>HTML ist die bevorzugte <!-- ??? --> + <para><acronym>XHTML</acronym> ist die meistverwendete Auszeichnungssprache des World Wide Web und wird durchgängig für die FreeBSD-Webseite genutzt.</para> @@ -179,22 +76,23 @@ </varlistentry> <varlistentry> - <term>DocBook DTD (<package>textproc/docbook</package>)</term> + <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. Die - gesamte FreeBSD-Dokumentation wird mittels DocBook + technische Dokumentationen entwickelt worden. Ein + Großteil der FreeBSD-Dokumentation wird mittels DocBook erstellt.</para> </listitem> </varlistentry> <varlistentry> - <term>ISO 8879-Entitäten - (<package>textproc/iso8879</package>)</term> + <term>ISO 8879 entities + (<filename role="package">textproc/iso8879</filename>)</term> <listitem> - <para>19 der ISO 8879:1986-Zeichensätze, die von + <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 @@ -203,27 +101,6 @@ </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 (<package>textproc/dsssl-docbook-modular</package>)</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 xml:id="tools-optional"> @@ -239,74 +116,57 @@ <variablelist> <varlistentry> - <term><application>JadeTeX</application> und - <application>teTeX</application> (<package>print/jadetex</package> und <package>print/teTeX</package>)</term> + <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> und - <application>teTeX</application> werden eingesetzt, um + <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 + <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> + <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> (<package>editors/emacs</package> oder <package>editors/xemacs</package>)</term> + <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 + 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äß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>--> + und Fehlerwahrscheinlichkeit senken lässt.</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>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201506081614.t58GECPp098235>