MFde:	sync the section about possible doc-build FORMATs

Obained from:	The FreeBSD German Documentation Project
This commit is contained in:
Johann Kois 2015-09-09 18:17:42 +00:00
parent 991f29b7ab
commit cf83f9b39a
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=47399
2 changed files with 77 additions and 6 deletions

View file

@ -30,7 +30,7 @@
$FreeBSD$ $FreeBSD$
$FreeBSDde$ $FreeBSDde$
basiert auf: r44068 basiert auf: r47338
--> -->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="doc-build"> <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="doc-build">
<info><title>Die Erzeugung der Zieldokumente</title> <info><title>Die Erzeugung der Zieldokumente</title>
@ -39,13 +39,85 @@
</authorgroup> </authorgroup>
</info> </info>
<para>Dieses Kapitels erklärt detailliert, <para>Dieses Kapitels erklärt detailliert,
<emphasis>wie der Bau der Dokumentation organisiert <emphasis>wie der Bau der Dokumentation organisiert
ist</emphasis> und wie Sie diesen Prozess mit &man.make.1; ist</emphasis> und wie Sie diesen Prozess mit &man.make.1;
beeinflussen können.</para> beeinflussen können.</para>
<sect1 xml:id="doc-build-rendering">
<title>DocBook in verschiedene Ausgabeformate konvertieren</title>
<para>Aus einer einzigen DocBook-Quellcodedatei können
verschiedene Ausgabeformate erstellt werden. Welches Dateiformat
erstellt wird, wird über die Variable
<varname>FORMATS</varname> festgelegt. Eine Liste aller
verfügbaren Formate ist in <varname>KNOWN_FORMATS</varname>
gespeichert:</para>
<screen xml:id="doc-build-rendering-known-formats">&prompt.user; <userinput>cd ~/doc/en_US.ISO8859-1/books/handbook</userinput>
&prompt.user; <userinput>make -V KNOWN_FORMATS</userinput></screen>
<table xml:id="doc-build-rendering-common-formats" frame="none">
<title>Häufige Ausgabeformate</title>
<tgroup cols="3">
<thead>
<row>
<entry><varname>FORMATS</varname></entry>
<entry>Dateityp</entry>
<entry>Beschreibung</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>html</literal></entry>
<entry><acronym>HTML</acronym>, Einzeldatei</entry>
<entry>Eine einzelne <filename>book.html</filename> oder
<filename>article.html</filename>.</entry>
</row>
<row>
<entry><literal>html-split</literal></entry>
<entry><acronym>HTML</acronym>, multiple Dateien</entry>
<entry>Multiple <acronym>HTML</acronym>-Dateien, eine
für jedes Kapitel oder für jeden Abschnitt. Dieser
Typ wird in der Regel für die Nutzung des Dokuments
auf einer Internetseite verwendet.</entry>
</row>
<row>
<entry><literal>pdf</literal></entry>
<entry><acronym>PDF</acronym></entry>
<entry>Portable Document Format</entry>
</row>
</tbody>
</tgroup>
</table>
<para>Welches Format verwendet wird, hängt vom jeweiligen
Dokument ab, in der Regel handelt es sich aber um
<literal>html-split</literal>. Weitere Formate werden über die
Variable <varname>FORMATS</varname> angegeben. Dabei können
Sie ein einzelnes Format, aber auch mehrere Formate gleichzeitig
definieren.</para>
<example xml:id="doc-build-formats-example-html">
<title>Das Dokument als eine einzelne HTML-Seite bauen</title>
<screen>&prompt.user; <userinput>cd ~/doc/en_US.ISO8859-1/books/handbook</userinput>
&prompt.user; <userinput>make FORMATS=html</userinput></screen>
</example>
<example xml:id="doc-build-formats-example-html-split-pdf">
<title>Das Dokument in den Formaten HTML-Split sowie
<acronym>PDF</acronym> bauen</title>
<screen>&prompt.user; <userinput>cd ~/doc/en_US.ISO8859-1/books/handbook</userinput>
&prompt.user; <userinput>make FORMATS="html-split pdf"</userinput></screen>
</example>
</sect1>
<sect1 xml:id="doc-build-toolset"> <sect1 xml:id="doc-build-toolset">
<title>Für den Bau der &os;-Dokumentation benötigte <title>Für den Bau der &os;-Dokumentation benötigte
Werkzeuge</title> Werkzeuge</title>

View file

@ -779,9 +779,8 @@ DOC_PREFIX?= ${.CURDIR}/../../..
sich das Ergebnis in <application>Firefox</application> sich das Ergebnis in <application>Firefox</application>
anzeigen. Für die englische Dokumentation gehen Sie analog anzeigen. Für die englische Dokumentation gehen Sie analog
vor. Eine Liste aller verfügbaren Werte für die Variable vor. Eine Liste aller verfügbaren Werte für die Variable
<varname>FORMATS</varname> findet sich im FDP-Primer. <varname>FORMATS</varname> finden Sie in <xref
<!-- See <xref linkend="doc-build-rendering-common-formats"/>.</para>
linkend="doc-build-rendering-common-formats"/>.--></para>
<screen>&prompt.user; <userinput>make FORMATS=html</userinput> <screen>&prompt.user; <userinput>make FORMATS=html</userinput>
&prompt.user; <userinput>firefox book.html</userinput></screen> &prompt.user; <userinput>firefox book.html</userinput></screen>