r39632 -> r46365
MFde: Resync the structure chapter of the fdp-primer. Obtained from: The FreeBSD German Documentation Project
This commit is contained in:
parent
218bcdca5c
commit
3e3fb557c8
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=46800
1 changed files with 90 additions and 84 deletions
|
@ -30,21 +30,17 @@
|
|||
|
||||
$FreeBSD$
|
||||
$FreeBSDde$
|
||||
basiert auf: r39632
|
||||
basiert auf: r46365
|
||||
-->
|
||||
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="structure">
|
||||
<info><title>Verzeichnisstruktur unter <filename>doc/</filename></title>
|
||||
<info><title>Dokumentation-Verzeichnisstruktur</title>
|
||||
<authorgroup>
|
||||
<author><personname><firstname>Johann</firstname><surname>Kois</surname></personname><contrib>Übersetzt von </contrib></author>
|
||||
</authorgroup>
|
||||
</info>
|
||||
|
||||
|
||||
|
||||
<para>Der <filename>doc/</filename>-Baum ist auf eine besondere
|
||||
Weise organisiert. Dies gilt analog für die Dokumente, aus
|
||||
denen der FDP besteht. Das Ziel dieser Organisation ist es, das
|
||||
Hinzufügen neuer Dokumente zu erleichtern, sowie</para>
|
||||
<para>Die Struktur der Dateien und Ordner unterhalb von
|
||||
<filename>doc/</filename> hilft dabei,</para>
|
||||
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
|
@ -60,7 +56,7 @@
|
|||
|
||||
<listitem>
|
||||
<para>die Entscheidung, wo neue Dokumente innerhalb des Baumes
|
||||
platziert werden sollen, zu erleichtern.</para>
|
||||
platziert werden sollen, leichter zu machen.</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
|
||||
|
@ -77,92 +73,107 @@
|
|||
Arten von Verzeichnissen, die jeweils über spezifische
|
||||
Dateinamen und eine spezifische Bedeutung verfügen.</para>
|
||||
|
||||
<segmentedlist>
|
||||
<segtitle>Verzeichnis</segtitle>
|
||||
<informaltable pgwide="1" frame="none">
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Verzeichnis</entry>
|
||||
<entry>Bedeutung</entry>
|
||||
</row>
|
||||
</thead>
|
||||
|
||||
<segtitle>Bedeutung</segtitle>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry valign="top"><filename>share</filename></entry>
|
||||
|
||||
<seglistitem>
|
||||
<seg><filename>share/</filename></seg>
|
||||
|
||||
<seg>Enthält Dateien, die für alle Sprachen und
|
||||
<entry>Enthält Dateien, die für alle Sprachen und
|
||||
Kodierungen der Dokumentation gültig sind. Es
|
||||
enthält weitere Unterverzeichnisse, um diese
|
||||
Informationen zu kategorisieren. So enthält
|
||||
<filename>share/mk</filename> beispielsweise die Dateien,
|
||||
<filename class="directory">share/mk</filename>
|
||||
beispielsweise die Dateien,
|
||||
die die &man.make.1;-Infrastruktur bilden, während
|
||||
sich die für die SMGL-Unterstützung nötigen
|
||||
Dateien (darunter die FreeBSD DocBook DTD) unter
|
||||
<filename>share/xml</filename> befinden.</seg>
|
||||
</seglistitem>
|
||||
sich die für die <acronym>XML</acronym>-Unterstützung nötigen
|
||||
Dateien (darunter die FreeBSD DocBook <acronym>DTD</acronym>) unter
|
||||
<filename>share/xml</filename> befinden.</entry>
|
||||
</row>
|
||||
|
||||
<seglistitem>
|
||||
<seg><filename>Sprache.Kodierung/</filename></seg>
|
||||
<row>
|
||||
<entry valign="top"><filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename></entry>
|
||||
|
||||
<seg>Für jede verfügbare Sprache und Kodierung
|
||||
<entry>Für jede verfügbare Sprache und Kodierung
|
||||
existiert ein eigenes Unterverzeichnis. Beispiele dafür
|
||||
sind <filename>en_US.ISO8859-1/</filename> oder
|
||||
<filename>zh_TW.Big5/</filename>. Zwar sind diese
|
||||
<filename>zh_TW.UTF-8/</filename>. Zwar sind diese
|
||||
Verzeichnisnamen nicht gerade kurz, durch die vollständige
|
||||
Angabe von Sprache und Kodierung werden aber Probleme bei einer
|
||||
eventuellen Erweiterung der Dokumentation (etwa um eine
|
||||
zusätzliche Kodierung für eine bereits vorhandene
|
||||
Sprache) vermieden. Auch eine eventuelle Konvertierung der
|
||||
Dokumentation nach Unicode ist dadurch problemlos
|
||||
möglich.</seg>
|
||||
</seglistitem>
|
||||
</segmentedlist>
|
||||
möglich.</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</sect1>
|
||||
|
||||
<sect1 xml:id="structure-locale">
|
||||
<title>Die Verzeichnisse
|
||||
<filename>Sprache.Kodierung/</filename></title>
|
||||
<filename><replaceable>Sprache</replaceable>.<replaceable>Kodierung</replaceable>/</filename></title>
|
||||
|
||||
<para>Diese Verzeichnisse enthalten die eigentliche Dokumentation.
|
||||
Auf dieser Ebene erfolgt eine Unterteilung in drei Kategorien,
|
||||
die durch entsprechende Verzeichnisnamen gekennzeichnet
|
||||
werden.</para>
|
||||
|
||||
<segmentedlist>
|
||||
<segtitle>Verzeichnis</segtitle>
|
||||
<informaltable pgwide="1" frame="none">
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Verzeichis</entry>
|
||||
<entry>Bedeutung</entry>
|
||||
</row>
|
||||
</thead>
|
||||
|
||||
<segtitle>Inhalt</segtitle>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry valign="top"><filename>articles</filename></entry>
|
||||
|
||||
<seglistitem>
|
||||
<seg><filename>articles</filename></seg>
|
||||
|
||||
<seg>DocBook-formatierte Artikel (<tag>article</tag>)
|
||||
<entry>DocBook-formatierte Artikel (<tag>article</tag>)
|
||||
oder ähnliche Dokumente. Meist relativ kurz und in
|
||||
Abschnitte aufgeteilt. Artikel sind in der Regel als ein
|
||||
einziges, großes HTML-Dokument verfügbar.</seg>
|
||||
</seglistitem>
|
||||
einziges, großes <acronym>XHTML</acronym>-Dokument verfügbar.</entry>
|
||||
</row>
|
||||
|
||||
<seglistitem>
|
||||
<seg><filename>books</filename></seg>
|
||||
<row>
|
||||
<entry valign="top"><filename>books</filename></entry>
|
||||
|
||||
<seg>DocBook-formatierte Bücher (<tag>book</tag>)
|
||||
<entry>DocBook-formatierte Bücher (<tag>book</tag>)
|
||||
oder ähnliche Dokumente. Umfangreiche Dokumente,
|
||||
die in Kapitel aufgeteilt werden. Sind in der Regel sowohl
|
||||
als eine einzige, große HTML-Datei (für Personen
|
||||
als eine einzige, große <acronym>XHTML</acronym>-Datei (für Personen
|
||||
mit einer schnellen Internetanbindung oder für einen
|
||||
einfachen Druck über ein Browser) oder als eine
|
||||
Sammlung von vielen kleinen, miteinander verlinkten Dateien
|
||||
verfügbar.</seg>
|
||||
</seglistitem>
|
||||
verfügbar.</entry>
|
||||
</row>
|
||||
|
||||
<seglistitem>
|
||||
<seg><filename>man</filename></seg>
|
||||
<row>
|
||||
<entry valign="top"><filename>man</filename></entry>
|
||||
|
||||
<seg>Dient für Übersetzungen von Manualpages. Es
|
||||
enthält ein oder mehrere
|
||||
<filename>mann</filename>-Verzeichnisse,
|
||||
<entry>Dient für Übersetzungen von Manualpages. Es
|
||||
enthält ein oder mehrere <filename
|
||||
role="directory">man<replaceable>n</replaceable></filename>-Verzeichnisse,
|
||||
je nachdem, welche Abschnitte der Manualpages bereits
|
||||
übersetzt wurden.</seg>
|
||||
</seglistitem>
|
||||
</segmentedlist>
|
||||
übersetzt wurden.</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
|
||||
<para>Nicht jedes
|
||||
<filename>Sprache.Kodierung</filename>-Verzeichnis
|
||||
<para>Nicht jedes <filename
|
||||
role="directory"><replaceable>Sprache</replaceable>.<replaceable>Kodierung</replaceable></filename>-Verzeichnis
|
||||
enthält all diese Unterverzeichnisse. Ob ein Verzeichnis
|
||||
vorhanden ist, hängt vielmehr davon ab, ob bereits ein
|
||||
entsprechender Teil der Dokumentation übersetzt wurde.</para>
|
||||
|
@ -180,8 +191,10 @@
|
|||
|
||||
<subtitle><filename>books/handbook/</filename></subtitle>
|
||||
|
||||
<para>Das Handbuch wurde unter Verwendung der vom FreeBSD
|
||||
Project erweiterten DocBook-DTD geschrieben.</para>
|
||||
<para>Das Handbuch wurde unter Verwendung von
|
||||
DocBook <acronym>XML</acronym> (und der vom FreeBSD
|
||||
Project erweiterten <acronym>XML</acronym> DocBook-DTD)
|
||||
geschrieben.</para>
|
||||
|
||||
<para>Das Handbuch ist als DocBook-<tag>book</tag>
|
||||
organisiert. Es besteht aus mehreren Teilen
|
||||
|
@ -211,7 +224,7 @@
|
|||
<title><filename>Makefile</filename></title>
|
||||
|
||||
<para>Das <filename>Makefile</filename> definiert verschiedene
|
||||
Variablen zur Konvertierung der XML-Quellen in andere
|
||||
Variablen zur Konvertierung der<acronym>XML</acronym>-Quellen in andere
|
||||
Formate. Außerdem listet es die verschiedenen Dateien
|
||||
auf, aus denen das Handbuch gebaut wird. Zusätzlich
|
||||
wird die Standard-<filename>doc.project.mk</filename>
|
||||
|
@ -223,8 +236,9 @@
|
|||
<title><filename>book.xml</filename></title>
|
||||
|
||||
<para>Das Hauptdokument innerhalb des Handbuchs. Neben der
|
||||
<link linkend="xml-primer-doctype-declaration">
|
||||
DOCTYPE-Deklaration</link> des Handbuchs werden hier auch
|
||||
<link
|
||||
linkend="xml-primer-doctype-declaration">DOCTYPE-Deklaration</link>
|
||||
des Handbuchs werden hier auch
|
||||
die Elemente aufgelistet, die die Struktur des Handbuchs
|
||||
definieren.</para>
|
||||
|
||||
|
@ -237,7 +251,8 @@
|
|||
</sect4>
|
||||
|
||||
<sect4>
|
||||
<title><filename>Verzeichnis/chapter.xml</filename></title>
|
||||
<title><filename
|
||||
role="directory"><replaceable>Verzeichnis</replaceable>/chapter.xml</filename></title>
|
||||
|
||||
<para>Jedes Kapitel des Handbuchs wird in einer
|
||||
<filename>chapter.xml</filename> genannten Datei
|
||||
|
@ -248,18 +263,17 @@
|
|||
<para>Enthält eine Kapiteldatei beispielsweise die
|
||||
Einträge</para>
|
||||
|
||||
<programlisting><![CDATA[
|
||||
<chapter id="kernelconfig">
|
||||
<programlisting><tag class="starttag">chapter id="kernelconfig"</tag>
|
||||
...
|
||||
</chapter>]]></programlisting>
|
||||
<tag class="endtag">chapter</tag></programlisting>
|
||||
|
||||
<para>so handelt es sich um die Datei
|
||||
<filename>chapter.xml</filename> im Verzeichnis
|
||||
<filename>kernelconfig</filename>. Im Allgemeinen
|
||||
enthält diese Datei das komplette Kapitel.</para>
|
||||
|
||||
<para>Wird die XHTML-Version des Handbuchs gebaut, entsteht
|
||||
dadurch
|
||||
<para>Wird die <acronym>XHTML</acronym>-Version des Handbuchs
|
||||
gebaut, entsteht dadurch
|
||||
<filename>kernelconfig.html</filename>. Der Grund
|
||||
dafür ist allerdings der Wert des
|
||||
<literal>id</literal>-Attributs, und nicht der Name des
|
||||
|
@ -277,7 +291,8 @@
|
|||
Kapitel aufzunehmen. Die Bilder für das Handbuch
|
||||
werden zentral im Verzeichnis <filename>share/images/books/handbook</filename>
|
||||
gespeichert. Existiert eine lokalisierte Version eines
|
||||
Bildes, wird diese hingegen gemeinsam mit dem XML-Quellcode
|
||||
Bildes, wird diese hingegen gemeinsam mit dem
|
||||
<acronym>XML</acronym>-Quellcode
|
||||
im gleichen Verzeichnis gespeichert. Ein Vorteil
|
||||
dieser Methode ist beispielsweise die Vermeidung von
|
||||
Namenskollisionen. Außerdem ist es
|
||||
|
@ -293,27 +308,18 @@
|
|||
<filename>printing/chapter.xml</filename>.</para>
|
||||
|
||||
<important>
|
||||
<para>Im Normalfall sollte ein Umstrukturierung des
|
||||
Handbuchs nicht dazu führen, dass dafür
|
||||
Dateien umbenannt werden müssen (es sei denn,
|
||||
einzelne Kapitel werden neu aufgenommen oder
|
||||
entfernt). Kapitel und Verzeichnisse sollten daher
|
||||
nicht nach ihrer Reihenfolge innerhalb des Handbuchs
|
||||
benannt werden, da sich diese Reihenfolge bei einer
|
||||
Umstrukturierung des Handbuchs ändern
|
||||
könnte.</para>
|
||||
<para>Benennen Sie Kapitel und Verzeichnisse nicht nach
|
||||
Ihrer Reihenfolge innerhalb des Handbuchs. Dann führt
|
||||
eine Umstrukturierung des Handbuchs im Normalfall nicht
|
||||
dazu, dass dafür Dateien umbenannt werden müssen (es sei
|
||||
denn, einzelne Kapitel werden neu aufgenommen oder
|
||||
entfernt).</para>
|
||||
</important>
|
||||
|
||||
<para>Die Datei <filename>chapter.xml</filename> ist keine
|
||||
komplette XML-Datei, da unter anderem die Zeilen mit
|
||||
der DOCTYPE-Deklaration am Beginn der Datei nicht
|
||||
vorhanden sind.</para>
|
||||
|
||||
<para>Durch diesen Umstand ist es nicht möglich,
|
||||
einzelne Dateien direkt nach HTML, RTF, PS oder ein
|
||||
anderes Format zu konvertieren. Vielmehr muss dazu
|
||||
das <emphasis>komplette</emphasis> Handbuch neu gebaut
|
||||
werden.</para>
|
||||
komplette <acronym>XML</acronym>-Datei. Dies bedeutet,
|
||||
dass sie nicht alleine gebaut werden kann, sondern nur
|
||||
als Teil des Handbuchs.</para>
|
||||
</sect4>
|
||||
</sect3>
|
||||
</sect2>
|
||||
|
|
Loading…
Reference in a new issue