MFde: Start to bring the German version of the dfp-primer to 2015:
- add new chapters/remove 1 unused chapter/rename 1 chapter - fix Makefile - link to english versions if a german version does not exist yet. - Update multiple chapters so that the fdp-primer can be built. More updates will follow. de_DE.ISO8859-1/books/fdp-primer/Makefile r38826 -> r42410 de_DE.ISO8859-1/books/fdp-primer/book.sgml r38826 -> r42410 de_DE.ISO8859-1/books/fdp-primer/chapters.ent r38826 -> r42410 de_DE.ISO8859-1/books/fdp-primer/doc-build/chapter.xml r39631 -> r44068 de_DE.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml new file de_DE.ISO8859-1/books/fdp-primer/editor-config/chapter.xml new file de_DE.ISO8859-1/books/fdp-primer/overview/chapter.xml r41125 -> r46642 de_DE.ISO8859-1/books/fdp-primer/sgml-primer/chapter.xml moved to xml-primer/chapter.xml de_DE.ISO8859-1/books/fdp-primer/working-copy/chapter.xml new file de_DE.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml new file Obtained from: The FreeBSD German Documentation Project
This commit is contained in:
Johann Kois
parent
3a9411b519
commit
7f1d28ac05
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=46773
10 changed files with 429 additions and 357 deletions
de_DE.ISO8859-1/books/fdp-primer
Makefilebook.xmlchapters.ent
doc-build
docbook-markup
editor-config
overview
working-copy
xhtml-markup
xml-primer
|
|
@ -1,7 +1,7 @@
|
|||
#
|
||||
# $FreeBSD$
|
||||
# $FreeBSDde$
|
||||
# basiert auf: r38826
|
||||
# basiert auf: r42410
|
||||
#
|
||||
# Build the FreeBSD Documentation Project Primer.
|
||||
#
|
||||
|
|
@ -22,17 +22,19 @@ INSTALL_ONLY_COMPRESSED?=
|
|||
# XML content
|
||||
SRCS= book.xml
|
||||
SRCS+= overview/chapter.xml
|
||||
SRCS+= psgml-mode/chapter.xml
|
||||
SRCS+= see-also/chapter.xml
|
||||
SRCS+= sgml-markup/chapter.xml
|
||||
SRCS+= sgml-primer/chapter.xml
|
||||
SRCS+= stylesheets/chapter.xml
|
||||
SRCS+= tools/chapter.xml
|
||||
SRCS+= working-copy/chapter.xml
|
||||
SRCS+= structure/chapter.xml
|
||||
SRCS+= doc-build/chapter.xml
|
||||
SRCS+= the-website/chapter.xml
|
||||
SRCS+= tools/chapter.xml
|
||||
SRCS+= xml-primer/chapter.xml
|
||||
SRCS+= xhtml-markup/chapter.xml
|
||||
SRCS+= docbook-markup/chapter.xml
|
||||
SRCS+= stylesheets/chapter.xml
|
||||
SRCS+= translations/chapter.xml
|
||||
SRCS+= writing-style/chapter.xml
|
||||
SRCS+= editor-config/chapter.xml
|
||||
SRCS+= see-also/chapter.xml
|
||||
|
||||
SRCS+= examples/appendix.xml
|
||||
|
||||
|
|
|
|||
|
|
@ -34,21 +34,22 @@
|
|||
POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
$FreeBSD$
|
||||
$FreeBSDde: de-docproj/books/fdp-primer/book.xml,v 1.24 2012/03/25 14:39:26 bcr Exp $
|
||||
basiert auf: r40986
|
||||
$FreeBSDde$
|
||||
basiert auf: r44895
|
||||
-->
|
||||
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:lang="de">
|
||||
<info><title>Die Fibel für neue Mitarbeiter des
|
||||
FreeBSD-Dokumentationsprojekts</title>
|
||||
|
||||
|
||||
<author><orgname>The FreeBSD Documentation Project</orgname></author>
|
||||
|
||||
<copyright>
|
||||
<year>1998-2012</year>
|
||||
<year>1998-2014</year>
|
||||
<holder>The FreeBSD Documentation Project</holder>
|
||||
</copyright>
|
||||
|
||||
<copyright>
|
||||
<year>1998-2012</year>
|
||||
<year>1998-2015</year>
|
||||
<holder>The FreeBSD German Documentation Project</holder>
|
||||
</copyright>
|
||||
|
||||
|
|
@ -60,17 +61,18 @@
|
|||
|
||||
<abstract>
|
||||
<para>Vielen Dank für Ihr Interesse und Ihre Mitarbeit an
|
||||
der FreeBSD-Dokumentation. Jeder Beitrag ist für uns sehr
|
||||
wichtig.</para>
|
||||
der FreeBSD-Dokumentation. Wir freuen uns über jeden Beitrag.</para>
|
||||
|
||||
<para>In dieser Fibel wird von der eingesetzten Software bis hin
|
||||
zu den Vorstellungen des FreeBSD-Dokumentationsprojekts alles
|
||||
behandelt, was Sie wissen müssen, wenn Sie sich am
|
||||
FreeBSD-Dokumentationsprojekt beteiligen wollen.</para>
|
||||
<para>Diese Fibel enthält die Informationen, die Sie für die
|
||||
Mitarbeit am FreeBSD-Dokumentationsprojekt (auch als
|
||||
<acronym>FDP</acronym> bekannt) benötigen. Diese reichen von
|
||||
verpflichtender und optionaler Software bis hin zur Philosophie
|
||||
des FreeBSD-Dokumentationsprojekts.</para>
|
||||
|
||||
<para>Bitte beachten Sie, dass diese Fibel
|
||||
<emphasis>jederzeit</emphasis> unter Bearbeitung und noch
|
||||
nicht vollständig ist.</para>
|
||||
nicht vollständig ist. Falls Sie einen Fehler finden, würden
|
||||
wir uns freuen, wenn Sie uns darüber informieren.</para>
|
||||
</abstract>
|
||||
</info>
|
||||
|
||||
|
|
@ -80,11 +82,11 @@
|
|||
<sect1 xml:id="preface-prompts">
|
||||
<title>Die Eingabeaufforderungen</title>
|
||||
|
||||
<para>Die folgende Tabelle zeigt die normale Eingabeaufforderung
|
||||
des Systems und die Eingabeaufforderung des Superusers. Die in
|
||||
diesem Buch vorkommenden Beispiele benutzen die jeweilige
|
||||
Eingabeaufforderung, um zu zeigen, unter welchem Benutzer die
|
||||
Beispiele ausgeführt werden sollten.</para>
|
||||
<para>Die folgende Tabelle enthält die Eingabeaufforderung eines
|
||||
normalen Benutzers sowie die des Superusers. Die in
|
||||
diesem Buch verwendeten Beispiele benutzen die jeweilige
|
||||
Eingabeaufforderung, um zu zeigen, als welcher Benutzer die
|
||||
Beispiele ausgeführt werden.</para>
|
||||
|
||||
<informaltable frame="none" pgwide="1">
|
||||
<tgroup cols="2">
|
||||
|
|
@ -143,11 +145,18 @@
|
|||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Bildschirmein- und ausgaben</entry>
|
||||
<entry>Bildschirmausgaben</entry>
|
||||
|
||||
<entry><screen>You have mail.</screen></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Bildschirmein- und ausgaben</entry>
|
||||
|
||||
<entry><screen>&prompt.user; <userinput>date +"The time is %H:%M"</userinput>
|
||||
The time is 09:18</screen></entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Referenzen auf Hilfeseiten</entry>
|
||||
|
||||
|
|
@ -158,8 +167,8 @@
|
|||
<row>
|
||||
<entry>Benutzer- und Gruppennamen</entry>
|
||||
|
||||
<entry>Ich bin <systemitem class="username">root</systemitem>, ich darf
|
||||
das.</entry>
|
||||
<entry>Ich bin <systemitem class="username">root</systemitem>,
|
||||
ich darf das.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
|
|
@ -170,14 +179,13 @@
|
|||
</row>
|
||||
|
||||
<row>
|
||||
<entry>Argumente auf der Kommandozeile, die durch
|
||||
existierende Namen, Dateien oder Variablen ersetzt
|
||||
werden müssen</entry>
|
||||
<entry>Text, der vom Benutzer durch seine Eingaben ersetzt
|
||||
werden muss</entry>
|
||||
|
||||
<entry>Dateien können Sie mit dem Befehl
|
||||
<command>rm
|
||||
Dateiname</command>
|
||||
löschen.</entry>
|
||||
<entry>Um die Hilfeseiten nach einem bestimmten Begriff zu
|
||||
durchsuchen, geben Sie
|
||||
<command>man -k <replaceable>Suchbegriff</replaceable></command>
|
||||
ein.</entry>
|
||||
</row>
|
||||
|
||||
<row>
|
||||
|
|
@ -252,15 +260,17 @@
|
|||
|
||||
&chap.overview;
|
||||
&chap.tools;
|
||||
&chap.xml-primer;
|
||||
&chap.xml-markup;
|
||||
&chap.stylesheets;
|
||||
&chap.working-copy;
|
||||
&chap.structure;
|
||||
&chap.doc-build;
|
||||
&chap.the-website;
|
||||
&chap.xml-primer;
|
||||
&chap.xhtml-markup;
|
||||
&chap.docbook-markup;
|
||||
&chap.stylesheets;
|
||||
&chap.translations;
|
||||
&chap.writing-style;
|
||||
&chap.psgml-mode;
|
||||
&chap.editor-config;
|
||||
&chap.see-also;
|
||||
|
||||
&app.examples;
|
||||
|
|
|
|||
|
|
@ -9,20 +9,22 @@
|
|||
|
||||
$FreeBSD$
|
||||
$FreeBSDde$
|
||||
basiert auf: r38826
|
||||
basiert auf: r42410
|
||||
-->
|
||||
|
||||
<!ENTITY chap.overview SYSTEM "overview/chapter.xml">
|
||||
<!ENTITY chap.xml-primer SYSTEM "sgml-primer/chapter.xml">
|
||||
<!ENTITY chap.tools SYSTEM "tools/chapter.xml">
|
||||
<!ENTITY chap.xml-markup SYSTEM "sgml-markup/chapter.xml">
|
||||
<!ENTITY chap.stylesheets SYSTEM "stylesheets/chapter.xml">
|
||||
<!ENTITY chap.working-copy SYSTEM "working-copy/chapter.xml">
|
||||
<!ENTITY chap.structure SYSTEM "structure/chapter.xml">
|
||||
<!ENTITY chap.doc-build SYSTEM "doc-build/chapter.xml">
|
||||
<!ENTITY chap.the-website SYSTEM "the-website/chapter.xml">
|
||||
<!ENTITY chap.xml-primer SYSTEM "xml-primer/chapter.xml">
|
||||
<!ENTITY chap.xhtml-markup SYSTEM "xhtml-markup/chapter.xml">
|
||||
<!ENTITY chap.docbook-markup SYSTEM "docbook-markup/chapter.xml">
|
||||
<!ENTITY chap.stylesheets SYSTEM "stylesheets/chapter.xml">
|
||||
<!ENTITY chap.translations SYSTEM "translations/chapter.xml">
|
||||
<!ENTITY chap.writing-style SYSTEM "writing-style/chapter.xml">
|
||||
<!ENTITY chap.psgml-mode SYSTEM "psgml-mode/chapter.xml">
|
||||
<!ENTITY chap.editor-config SYSTEM "editor-config/chapter.xml">
|
||||
<!ENTITY chap.see-also SYSTEM "see-also/chapter.xml">
|
||||
<!ENTITY chap.doc-build SYSTEM "doc-build/chapter.xml">
|
||||
|
||||
<!ENTITY app.examples SYSTEM "examples/appendix.xml">
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
$FreeBSD$
|
||||
$FreeBSDde$
|
||||
basiert auf: r39631
|
||||
basiert auf: r44068
|
||||
-->
|
||||
<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>
|
||||
|
|
@ -43,70 +43,37 @@
|
|||
|
||||
<para>Dieses Kapitels erklärt detailliert,
|
||||
<emphasis>wie der Bau der Dokumentation organisiert
|
||||
ist</emphasis> und <emphasis>wie Sie diesen Prozess beeinflussen
|
||||
können</emphasis>.</para>
|
||||
|
||||
<para>Nachdem Sie dieses Kapitel gelesen haben, werden Sie:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Wissen, wie Sie (unter Verwendung der im Kapitel <link linkend="tools">SGML-Werkzeuge</link> beschriebenen Tools)
|
||||
die FDP-Dokumentation selbst bauen können.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>In der Lage sein, sowohl die
|
||||
<application>make</application>-Anweisungen der für
|
||||
jedes Dokument benötigten <filename>Makefile</filename>s
|
||||
als auch die Anweisungen der projektweiten Vorgaben der Datei
|
||||
<filename>doc.project.mk</filename> zu lesen und zu
|
||||
verstehen.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Den Bau der Dokumentation über
|
||||
<application>make</application>-Variablen und
|
||||
<application>make</application>-Target anpassen
|
||||
können.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
ist</emphasis> und wie Sie diesen Prozess mit &man.make.1;
|
||||
beeinflussen können.</para>
|
||||
|
||||
<sect1 xml:id="doc-build-toolset">
|
||||
<title>Für den Bau der FreeBSD-Dokumentation benötigte
|
||||
<title>Für den Bau der &os;-Dokumentation benötigte
|
||||
Werkzeuge</title>
|
||||
|
||||
<para>Zusätzlich zu den im Kapitel <link linkend="tools">XML-Werkzeuge</link> beschriebenen
|
||||
Werkzeugen benötigen Sie noch folgende Programme:</para>
|
||||
<para>Die folgende Werkzeuge werden benötigt, um die
|
||||
<acronym>FDP</acronym>-Dokumente zu bauen und zu installieren.</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Das wichtigste Werkzeug zum Bau der Dokumentation ist
|
||||
<application>make</application>, genauer
|
||||
<para>Das wichtigste Werkzeug ist &man.make.1;, genauer
|
||||
<application>Berkeley Make</application>.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Der Bau von Paketen erfolgt unter FreeBSD mit
|
||||
<application>pkg_create</application>. Wenn Sie ein
|
||||
anderes Betriebssystem als FreeBSD einsetzen, müssen
|
||||
Sie entweder ohne Pakete auskommen oder den Quellcode
|
||||
selbst kompilieren.</para>
|
||||
&man.pkg.create.1;.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para><application>gzip</application> dient zur Erstellung
|
||||
komprimierter Versionen der Dokumentation. Unterstützt
|
||||
werden sowohl <application>bzip2</application>- als auch
|
||||
<application>zip</application>-Archive. Wollen Sie Pakete
|
||||
der Dokumentation erstellen, benötigen Sie auch noch
|
||||
<application>tar</application>.</para>
|
||||
<para>&man.gzip.1; dient zur Erstellung
|
||||
komprimierter Versionen der Dokumentation. &man.bzip2.1; wird
|
||||
ebenfalls unterstützt. Wollen Sie Pakete der Dokumentation
|
||||
erstellen, benötigen Sie auch &man.tar.1;.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Mit <application>install</application> installieren
|
||||
Sie in der Standardeinstellung die Dokumentation auf Ihrem
|
||||
System. Es gibt aber auch alternative Wege, die Dokumentation
|
||||
zu installieren.</para>
|
||||
<para>Mit &man.install.1; installieren Sie die Dokumentation auf
|
||||
Ihrem System.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect1>
|
||||
|
|
@ -115,7 +82,7 @@
|
|||
<title>Die <filename>Makefile</filename>s des Dokumentationsbaums
|
||||
verstehen</title>
|
||||
|
||||
<para>Innerhalb des FreeBSD Documentation Projects gibt es drei
|
||||
<para>Innerhalb des &os; Documentation Projects gibt es drei
|
||||
verschiedene Arten von <filename>Makefile</filename>s:</para>
|
||||
|
||||
<itemizedlist>
|
||||
|
|
@ -138,7 +105,7 @@
|
|||
<application>Make</application>-Includes</link> sind der
|
||||
"Klebstoff", der für den Bau der Dokumentation
|
||||
erforderlich ist. In der Regel heissen diese Dokumente
|
||||
<filename>doc.xxx.mk</filename>.</para>
|
||||
<filename>doc.<replaceable>xxx</replaceable>.mk</filename>.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
|
|
@ -157,11 +124,11 @@ DOC_PREFIX?= ${.CURDIR}/..
|
|||
.include "${DOC_PREFIX}/share/mk/doc.project.mk"</programlisting>
|
||||
|
||||
<para>Die ersten vier nicht-leeren Zeilen definieren die
|
||||
<application>make</application>-Variablen
|
||||
&man.make.1;-Variablen
|
||||
<varname>SUBDIR</varname>, <varname>COMPAT_SYMLINK</varname>,
|
||||
und <varname>DOC_PREFIX</varname>.</para>
|
||||
|
||||
<para>Die erste <varname>SUBDIR</varname>-Anweisung weist
|
||||
<para>Die <varname>SUBDIR</varname>-Anweisung weist
|
||||
(ebenso wie die <varname>COMPAT_SYMLINK</varname>-Anweisung)
|
||||
einer Variable einen Wert zu und überschreibt dabei
|
||||
deren ursprünglichen Wert.</para>
|
||||
|
|
@ -196,13 +163,13 @@ DOC_PREFIX?= ${.CURDIR}/..
|
|||
Wurzelverzeichnis des Quellcode-Baums des FreeBSD Documentation
|
||||
Projects an. Diese Vorgabe kann jederzeit durch einen eigenen
|
||||
Wert ersetzt werden. Bei <varname>.CURDIR</varname> handelt es
|
||||
sich um eine in <application>make</application> eingebaute
|
||||
sich um eine in &man.make.1; eingebaute
|
||||
Variable, die den Pfad des aktuellen Verzeichnisses
|
||||
enthält.</para>
|
||||
|
||||
<para>Die letzte Zeile bindet <filename>doc.project.mk</filename>,
|
||||
die zentrale, projektweite <application>make</application>-Datei
|
||||
des FreeBSD Documentation Projects, in den Bau ein. Diese Datei
|
||||
die zentrale, projektweite &man.make.1;-Datei
|
||||
des &os; Documentation Projects, in den Bau ein. Diese Datei
|
||||
enthält den "Klebstoff", der die diversen Variablen in
|
||||
Anweisungen zum Bau der Dokumentation konvertiert.</para>
|
||||
|
||||
|
|
@ -255,12 +222,6 @@ DOC_PREFIX?= ${.CURDIR}/../../..
|
|||
wenn ausschließlich komprimierte Pakete der Dokumentation
|
||||
erstellt werden sollen.</para>
|
||||
|
||||
<note>
|
||||
<para>Die Zuweisung von Werten an verschiedene Variablen wurde
|
||||
bereits im Abschnitt <link linkend="sub-make">Unterverzeichnis-Makefiles</link>
|
||||
behandelt.</para>
|
||||
</note>
|
||||
|
||||
<para>Die Variable <varname>DOC_PREFIX</varname> und die
|
||||
verschiedenen Include-Anweisungen sollten Ihnen ebenfalls
|
||||
bereits vertraut sein.</para>
|
||||
|
|
@ -268,8 +229,7 @@ DOC_PREFIX?= ${.CURDIR}/../../..
|
|||
</sect1>
|
||||
|
||||
<sect1 xml:id="make-includes">
|
||||
<title><application>Make</application>-Includes des FreeBSD
|
||||
Documentation Projects</title>
|
||||
<title>&man.make.1;-Includes des &os; Documentation Projects</title>
|
||||
|
||||
<para>Diese Dateien lassen sich am besten verstehen, indem man sich
|
||||
deren Inhalt näher ansieht. Konkret handelt es sich dabei
|
||||
|
|
@ -341,8 +301,8 @@ PRI_LANG?= en_US.ISO8859-1
|
|||
Variable hat den Standardwert "US English".</para>
|
||||
|
||||
<note>
|
||||
<para><varname>PRI_LANG</varname> beeinflusst in keinster
|
||||
Weise, welche Dokumente gebaut werden können oder
|
||||
<para><varname>PRI_LANG</varname> beeinflusst nicht,
|
||||
welche Dokumente gebaut werden können oder
|
||||
sollen. Diese Variable wird lediglich dazu verwendet,
|
||||
häufig verwendete Dokumente in das Wurzelverzeichnis
|
||||
der installierten Dokumentation zu verlinken.</para>
|
||||
|
|
@ -353,8 +313,7 @@ PRI_LANG?= en_US.ISO8859-1
|
|||
<title>Bedingungen</title>
|
||||
|
||||
<para>Die Zeile <literal>.if defined(DOC)</literal> ist ein
|
||||
Beispiel für eine
|
||||
<application>make</application>-Bedingung, die (analog zum
|
||||
Beispiel für eine &man.make.1;-Bedingung, die (analog zum
|
||||
Einsatz in anderen Programmen) festlegt, was geschehen soll,
|
||||
wenn eine Bedingung "wahr" oder "falsch" ist.
|
||||
<literal>defined</literal> ist eine Funktion, die
|
||||
|
|
@ -415,8 +374,8 @@ PRI_LANG?= en_US.ISO8859-1
|
|||
<para>Abhängigkeiten
|
||||
(<foreignphrase>Dependencies</foreignphrase>) werden
|
||||
folgendermaßen definiert:
|
||||
<literal>target
|
||||
abhaengigkeit1 abhaengigkeit2 ...</literal>.
|
||||
<literal><replaceable>target</replaceable>
|
||||
<replaceable>abhaengigkeit1 abhaengigkeit2 ...</replaceable></literal>.
|
||||
Um <literal>target</literal> zu bauen, müssen Sie zuvor
|
||||
die angegebenen Abhängigkeiten bauen.</para>
|
||||
|
||||
|
|
|
|||
46
de_DE.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml
Normal file
46
de_DE.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- Copyright (c) 2013 Warren Block
|
||||
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 THE AUTHOR "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:
|
||||
-->
|
||||
|
||||
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="docbook-markup">
|
||||
<title>DocBook Markup (noch nicht übersetzt)</title>
|
||||
|
||||
<para>Dieses Kapitel ist noch nicht übersetzt. Lesen Sie daher bitte
|
||||
das <link
|
||||
xlink:href="&url.books.fdp-primer.en;/docbook-markup.html">Original in
|
||||
englischer Sprache</link>. Wenn Sie bei der Übersetzung
|
||||
mithelfen wollen, schicken Sie bitte eine E-Mail
|
||||
an &a.de.translators;.</para>
|
||||
</chapter>
|
||||
46
de_DE.ISO8859-1/books/fdp-primer/editor-config/chapter.xml
Normal file
46
de_DE.ISO8859-1/books/fdp-primer/editor-config/chapter.xml
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- Copyright (c) 2013 Warren Block
|
||||
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 THE AUTHOR "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:
|
||||
-->
|
||||
|
||||
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="editor-config">
|
||||
<title>Editor Configuration (noch nicht übersetzt)</title>
|
||||
|
||||
<para>Dieses Kapitel ist noch nicht übersetzt. Lesen Sie daher bitte
|
||||
das <link
|
||||
xlink:href="&url.books.fdp-primer.en;/editor-config.html">Original in
|
||||
englischer Sprache</link>. Wenn Sie bei der Übersetzung
|
||||
mithelfen wollen, schicken Sie bitte eine E-Mail
|
||||
an &a.de.translators;.</para>
|
||||
</chapter>
|
||||
|
|
@ -30,57 +30,46 @@
|
|||
|
||||
$FreeBSD$
|
||||
$FreeBSDde$
|
||||
basiert auf: r41125
|
||||
basiert auf: r46642
|
||||
|
||||
-->
|
||||
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="overview">
|
||||
<title>Überblick</title>
|
||||
|
||||
<para>Herzlich Willkommen beim FreeBSD-Dokumentationsprojekt.
|
||||
Qualitativ hochwertige Dokumentation ist ein wichtiger
|
||||
Erfolgsfaktor und sehr bedeutend für die Verbreitung von
|
||||
FreeBSD. Die wichtigste Quelle dafür ist das
|
||||
FreeBSD-Dokumentationsprojekt (FDP). Jeder Beitrag, der zu diesem
|
||||
Projekt geleistet wird, ist ungemein wertvoll.</para>
|
||||
<para>Herzlich Willkommen beim FreeBSD-Dokumentationsprojekt
|
||||
(auch nur <acronym>FDP</acronym> genannt). Qualitativ hochwertige
|
||||
Dokumentation ist sehr wichtig für den Erfolg von &os;. Jeder
|
||||
Beitrag, der zu diesem Projekt geleistet wird, ist ungemein wertvoll.</para>
|
||||
|
||||
<para>Es ist das Anliegen dieser Fibel, den Leser mit dem FDP
|
||||
vertraut zu machen und zu erklären, <emphasis>wie das FDP
|
||||
organisiert ist</emphasis>, <emphasis>wie man selber Dokumente
|
||||
erstellt und an das FDP einreicht</emphasis> und <emphasis>wie
|
||||
die verfügbaren Werkzeuge effektiv beim Schreiben
|
||||
eingesetzt werden können</emphasis>.</para>
|
||||
<para>Dieses Dokument macht den Leser mit dem
|
||||
<acronym>FDP</acronym> vertraut und erklärt, wie man
|
||||
selbst Dokumente erstellt und einreicht und wie die verfügbaren
|
||||
Werkzeuge effektiv beim Schreiben eingesetzt werden
|
||||
können.</para>
|
||||
|
||||
<indexterm>
|
||||
<primary>Mitgliedschaft</primary>
|
||||
</indexterm>
|
||||
<para>Jeder kann zum <acronym>FDP</acronym> beitragen. Die einzige
|
||||
Voraussetzung ist die Bereitschaft, helfen zu wollen.</para>
|
||||
|
||||
<para>Wie jedes Open-Source-Projekt, ist auch das FDP auf die Mithilfe
|
||||
vieler angewiesen. Deshalb ist jeder herzlich eingeladen
|
||||
mitzuarbeiten. Die dafür erforderlichen Voraussetzungen sind
|
||||
gering und es gibt keine Verpflichtung eine bestimmte Menge an
|
||||
Dokumenten pro Monat oder Jahr beizusteuern. Das Einzige, was Sie
|
||||
tun müssen, ist sich auf der Mailingliste &a.doc; einzutragen.</para>
|
||||
|
||||
<para>Nach dem Lesen der FDP-Fibel sollte man wissen:</para>
|
||||
<para>Nach dem Lesen dieses Dokuments werden Sie in der Lage sein,</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>welche Dokumente durch das FDP betreut werden,</para>
|
||||
<para>die vom <acronym>FDP</acronym> betreuten Dokumente zu
|
||||
erkennen,</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>wie man SGML-Dokumente liest und den SGML-Quellcode der
|
||||
durch das FDP betreuten Dokumente versteht,</para>
|
||||
<para>die benötigten Dokumentations-Werkzeuge und Dateien
|
||||
zu installieren,</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>wie man selbst Änderungen an Dokumenten vornehmen
|
||||
kann und</para>
|
||||
<para>Änderungen an der Dokumentation vorzunehmen,</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>wie man Änderungen zur Begutachtung durch das FDP
|
||||
einreichen kann.</para>
|
||||
<para>Änderungen zur Begutachtung durch das FDP
|
||||
einreichen können.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
|
|
@ -89,269 +78,195 @@
|
|||
|
||||
<para>Das FDP umfasst vier verschiedene Kategorien:</para>
|
||||
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Manualpages</term>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para><emphasis>Handbook:</emphasis> Das Handbuch ist die
|
||||
umfassende Quelle und Referenz für &os;-Benutzer.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Die englischen Manualpages wurden nicht vom FDP
|
||||
<para><emphasis>FAQ:</emphasis> Eine Sammlung von kurzen
|
||||
Fragen und Antworten zu Themen, die auf den
|
||||
verschiedenen Mailinglisten und in auf &os; spezialisierten
|
||||
Foren regelmäßig diskutiert werden. Lange und komplizierte
|
||||
Antworten werden Sie hier nicht finden.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para><emphasis>Manualpages:</emphasis> Die englischen
|
||||
Manualpages werden normalerweise nicht vom FDP
|
||||
geschrieben, da sie ein Teil des Basissystems sind. Jedoch
|
||||
können bzw. wurden bereits Teile von existierenden
|
||||
Manualpages umformuliert, um sie verständlicher zu
|
||||
machen oder um Fehler zu beheben.</para>
|
||||
|
||||
<para>Für die Übersetzung der Manualpages des
|
||||
Systems in die verschiedenen Sprachen sind die einzelnen
|
||||
Übersetzergruppen verantwortlich. Alle dabei
|
||||
entstandenen Übersetzungen gehören zum
|
||||
FDP.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Die FAQ</term>
|
||||
|
||||
<listitem>
|
||||
<para>Das Ziel der FAQ ist es, Fragen, die auf den
|
||||
verschiedenen Mailinglisten und in Newsgruppen
|
||||
regelmäßig diskutiert werden, nach einem
|
||||
einfachen Frage- und Antwort-Muster zu behandeln. Das
|
||||
schließt nicht aus, das auf bestimmte Fragen
|
||||
ausführlich und umfassend eingegangen wird.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Das Handbuch</term>
|
||||
|
||||
<listitem>
|
||||
<para>Das Ziel des Handbuches ist es, die
|
||||
umfassende Quelle und Referenz im Netz für
|
||||
FreeBSD-Benutzer zu sein.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term>Die Webseite</term>
|
||||
|
||||
<listitem>
|
||||
<para>Die Webseite <link xlink:href="&url.base;/index.html">http://www.FreeBSD.org</link>
|
||||
und ihre vielen Spiegel auf der ganzen Welt vertreten das
|
||||
FreeBSD-Projekt im WWW. Für viele Menschen
|
||||
ist sie der erste Kontakt mit FreeBSD.</para>
|
||||
<para><emphasis>Die Webseite:</emphasis> Die Hauptpräsenz
|
||||
von &os; im Internet, zu erreichen unter <link
|
||||
xlink:href="http://www.freebsd.org/index.html">http://www.FreeBSD.org</link>
|
||||
oder einem der zahlreichen Spiegelserver. Für viele Menschen
|
||||
ist sie der erste Kontakt mit &os;.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</itemizedlist>
|
||||
|
||||
<para>Übersetzer-Teams sind für die Übersetzung des Handbuchs und
|
||||
der Webseite in verschiedene Sprachen verantwortlich. Manualpages
|
||||
werden derzeit nicht übersetzt.</para>
|
||||
|
||||
<para>Die Quellen für die FreeBSD-Website, das &os; Handbuch
|
||||
sowie die &os; FAQ werden im <literal>doc/</literal>
|
||||
Subversion-Repository von &os; verwaltet, das Sie über
|
||||
sowie die &os; <acronym>FAQ</acronym> werden im
|
||||
Dokumentations-Repository von &os; verwaltet, das Sie über
|
||||
<literal>https://svn.FreeBSD.org/doc/</literal> erreichen
|
||||
können.</para>
|
||||
|
||||
<para>Manualpages werden im <literal>src/</literal>
|
||||
Subversion-Repository von &os; verwaltet, das Sie über
|
||||
<para>Manualpages werden von &os; im einem eigenen
|
||||
Quellcode-Repository verwaltet, das Sie über
|
||||
<literal>https://svn.FreeBSD.org/base/</literal> erreichen
|
||||
können.</para>
|
||||
|
||||
<para>Das bedeutet, dass alle Änderungen an den
|
||||
Dateien für jeden verfügbar sind und sich jeder
|
||||
mit <application>svn</application> eine lokale Kopie der
|
||||
Dokumentation anlegen kann.</para>
|
||||
<para>Committ-Nachrichten des <acronym>FDP</acronym>
|
||||
sind über <application>svn</application> abrufbar und werden
|
||||
zusätzlich unter
|
||||
<uri xlink:href="&a.svn-doc-all.url;">&a.svn-doc-all.url;</uri>
|
||||
archiviert.</para>
|
||||
|
||||
<para>Parallel zum FDP haben viele Menschen Anleitungen
|
||||
<para>Beide Repositories sind auch über ein Web-Interface erreichbar:
|
||||
<link xlink:href="https://svnweb.FreeBSD.org/doc/"></link> sowie
|
||||
<link xlink:href="https://svnweb.FreeBSD.org/base/"></link>.</para>
|
||||
|
||||
<para>Viele Menschen haben &os;-spezifische Anleitungen
|
||||
geschrieben und Webseiten mit Bezug zu FreeBSD erstellt. Einige
|
||||
davon werden im Subversion-Archiv verwaltet, sofern der Autor dem
|
||||
zugestimmt hat. In anderen Fällen hat sich der Autor
|
||||
entschlossen, seine Dokumentation außerhalb des zentralen
|
||||
FreeBSD-Archivs zu verwalten. Das FDP bemüht sich, so
|
||||
viele Verweise wie möglich auf solche Quellen
|
||||
FreeBSD-Archivs zu verwalten. Das <acronym>FDP</acronym> bemüht sich,
|
||||
so viele Verweise wie möglich auf solche Quellen
|
||||
bereitzustellen.</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 xml:id="overview-before">
|
||||
<title>Bevor es losgeht</title>
|
||||
|
||||
<para>Zum Verständnis der folgenden Kapitel sollte folgendes
|
||||
bereits bekannt sein:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Wie eine aktuelle lokale Kopie des FreeBSD
|
||||
Subversion-Repository mit Hilfe von
|
||||
<application>svn</application> angelegt und gepflegt
|
||||
werden kann.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para>Wie neue Programme mit Hilfe des
|
||||
FreeBSD-Portsystems oder mittels &man.pkg.add.1;
|
||||
heruntergeladen und installiert werden.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</sect1>
|
||||
|
||||
<sect1 xml:id="overview-quick-start">
|
||||
<title>Der Schnellstart</title>
|
||||
<title>Schnellstart</title>
|
||||
|
||||
<para>Falls man einfach loslegen möchte und sich sicher genug
|
||||
fühlt, um alles weitere erst bei Bedarf nachzusehen, kann
|
||||
man einfach den folgenden Anweisungen folgen:</para>
|
||||
<para>Dieser Abschnitt beschreibt, was Sie tun müssen, bevor
|
||||
Sie Änderungen an der &os;-Dokumentation vornehmen können.
|
||||
Abonnieren Sie die Mailingliste &a.doc;. Einige Mitglieder dieser
|
||||
Mailingliste sind auch auf dem <acronym>IRC</acronym>-Kanal
|
||||
<literal>#bsddocs</literal> auf <link
|
||||
xlink:href="http://www.efnet.org/">EFnet</link> erreichbar. Nehmen
|
||||
Sie mit Ihnen Kontakt auf, wenn Sie Fragen oder Probleme bei
|
||||
der Arbeit an der &os;-Dokumentation haben.</para>
|
||||
|
||||
<procedure>
|
||||
<step>
|
||||
<para>Zuerst muß der Metaport <package>textproc/docproj</package> auf dem
|
||||
betreffenden Arbeitsrechner installiert werden.</para>
|
||||
|
||||
<screen>&prompt.root; <userinput>cd /usr/ports/textproc/docproj</userinput>
|
||||
&prompt.root; <userinput>make JADETEX=no install</userinput></screen>
|
||||
<para></para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Laden Sie mit <application>svn</application> eine lokale
|
||||
Kopie des FreeBSD-<filename>doc</filename>-Verzeichnisbaumes
|
||||
herunter.</para>
|
||||
|
||||
<para>Selbst wenn Sie nur über eine geringe Bandbreite
|
||||
oder wenig freien Plattenplatz verfügen, müssen Sie
|
||||
mindestens die Verzeichnisse <filename>head/share</filename>
|
||||
sowie
|
||||
<filename>head/language/share</filename>
|
||||
auschecken, um an der Dokumentation arbeiten zu können.
|
||||
Dazu ein Beispiel:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>mkdir -p head/share</userinput>
|
||||
&prompt.user; <userinput>mkdir -p head/en_US.ISO8859-1/share</userinput>
|
||||
&prompt.user; <userinput>svn checkout https://svn0.us-
|
||||
east.FreeBSD.org/doc/head/share head/share</userinput>
|
||||
&prompt.user; <userinput>svn checkout https://svn0.us-
|
||||
east.FreeBSD.org/doc/head/en_US.ISO8859-1/share head/en_US.ISO8859-1/share</userinput></screen>
|
||||
|
||||
<para>Für den Fall, dass ausreichend Platz auf der
|
||||
Festplatte vorhanden ist, kann auch eine
|
||||
vollständige Arbeitskopie des gesamten Subversion-Baumes
|
||||
anlegt werden.</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>svn checkout https://svn0.us-
|
||||
east.FreeBSD.org/doc/head head</userinput></screen>
|
||||
|
||||
<note>
|
||||
<para><link xlink:href="https://svn0.us-east.FreeBSD.org/">svn0.us-east.FreeBSD.org</link>
|
||||
ist ein öffentlicher Server. Wählen Sie einen Mirror
|
||||
in Ihrer Nähe und überprüfen Sie das Serverzertifikat
|
||||
auf der Seite <link xlink:href="&url.books.handbook;/svn-mirrors.html">Subversion
|
||||
mirror sites</link>.</para>
|
||||
</note>
|
||||
<para>Installieren Sie den Metaport
|
||||
<package>textproc/docproj</package> als Port oder Paket, um
|
||||
automatisch alle für die Arbeit an der Dokumentation benötigten
|
||||
Werkzeuge zu installieren.</para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Sollte geplant sein, ein existierendes Buch oder einen
|
||||
existierenden Artikel zu ändern, muß
|
||||
natürlich noch zusätzlich das betreffende
|
||||
Verzeichnis aus dem CVS-Archiv geholt werden. Soll hingegen
|
||||
ein neues Buch oder ein neuer Artikel geschrieben werden,
|
||||
empfiehlt es sich, auf bestehende Bücher und Artikel
|
||||
zurückzugreifen und diese als Vorlage zu nutzen.</para>
|
||||
<para>Installieren Sie eine lokale Arbeitskopie der Dokumentation
|
||||
von einem Spiegelserver des &os;-Repository nach
|
||||
<filename>~/doc</filename> (lesen Sie dazu
|
||||
auch <xref linkend="working-copy"/>).</para>
|
||||
|
||||
<para>Ein Artikel über die Konfiguration eines VPNs
|
||||
zwischen FreeBSD und Windows 2000 kann wie
|
||||
folgt erstellt werden:</para>
|
||||
|
||||
<procedure>
|
||||
<step>
|
||||
<para>Zuerst wird das Verzeichnis
|
||||
<filename>articles</filename> aus dem FreeBSD-CVS-Archiv
|
||||
lokal angelegt:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>svn checkout https://svn0.us-
|
||||
east.FreeBSD.org/doc/head/en_US.ISO8859-1/articles</userinput></screen>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Anschließend kopiert man einen bereits
|
||||
existierenden Artikel und nutzt ihn als Vorlage. In
|
||||
diesem Beispiel soll der neue Artikel im Verzeichnis
|
||||
<filename>vpn-w2k</filename> liegen:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>cd head/en_US.ISO8859-1/articles</userinput>
|
||||
&prompt.user; <userinput>svn export committers-guide vpn-w2k</userinput></screen>
|
||||
</step>
|
||||
</procedure>
|
||||
|
||||
<para>Bereits existierende Dokumente, die geändert
|
||||
werden sollen, können direkt aus dem CVS-Archiv
|
||||
geholt werden. Das folgende Beispiel zeigt das
|
||||
für die FAQ aus dem Verzeichnis
|
||||
<filename>head/en_US.ISO8859-1/books/faq</filename>:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>svn checkout https://svn0.us-
|
||||
east.FreeBSD.org/doc/head/en_US.ISO8859-1/books/faq</userinput></screen>
|
||||
<screen>&prompt.user; <userinput>svn checkout https://<replaceable>svn0.us-west.FreeBSD.org</replaceable>/doc/head <replaceable>~/doc</replaceable></userinput></screen>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Jetzt können die <filename>.xml</filename> Dateien
|
||||
mit einem beliebigen Texteditor bearbeitet werden.</para>
|
||||
<para>Ihr Texteditor sollte für die Arbeit an der
|
||||
&os;-Dokumentation wie folgt konfiguriert sein:</para>
|
||||
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Zeilenumbruch nach 70 Zeichen.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Tabstop auf 2 Zeichen.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>8 Leerzeichen sollen durch einen Tabstop ersetzt
|
||||
werden.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
<para>Konfigurationen für einige häufig verwendete Editoren
|
||||
finden Sie im <xref linkend="writing-style"/>.</para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<!--?
|
||||
Vielleicht besser als Befehl auf der Kommandozeile
|
||||
darstellen?
|
||||
Oliver Fischer
|
||||
-->
|
||||
<para>Danach ist <command>make</command> mit dem Ziel
|
||||
<buildtarget>lint</buildtarget> aufzurufen, um das gesamte
|
||||
Dokument auf Auszeichnungsfehler hin zu untersuchen, ohne
|
||||
dass zeitaufwändige Transformationen vorgenommen
|
||||
werden.</para>
|
||||
<para>Aktualisieren Sie Ihre lokale Arbeitskopie:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>make lint</userinput></screen>
|
||||
|
||||
<!--?
|
||||
Glossar sollte vorhanden sein. Darin dann erklären,
|
||||
was mit Ziel- und Quelldokument gemeint ist.
|
||||
Oliver Fischer
|
||||
-->
|
||||
|
||||
<para>Soll anschließend das Zieldokument erstellt
|
||||
werden, kann mit Hilfe der Variable
|
||||
<varname>FORMATS</varname> bestimmt werden, welche
|
||||
Ausgabeformate erzeugt werden sollen. Unterstützt werden
|
||||
momentan <literal>html</literal>,
|
||||
<literal>html-split</literal>, <literal>txt</literal>,
|
||||
<literal>ps</literal>, <literal>pdf</literal> und
|
||||
<literal>rtf</literal>. Die aktuelle Liste der
|
||||
unterstützten Formate befindet sich am Anfang der Datei
|
||||
<filename>head/share/mk/doc.docbook.mk</filename>. Bei der
|
||||
Verwendung dieser Variable ist es wichtig, darauf zu achten,
|
||||
dass die Angabe der gewünschten Formate in
|
||||
Anführungszeichen eingeschlossen wird, sofern mehr als
|
||||
nur ein Format gleichzeitig erstellt werden soll.</para>
|
||||
|
||||
<para>Wenn das Dokument beispielsweise nach
|
||||
<literal>HTML</literal> konvertiert werden soll, kann dies
|
||||
so vorgenommen werden:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>make FORMATS=html</userinput></screen>
|
||||
|
||||
<para>Soll es hingegen in den Formaten <literal>html</literal>
|
||||
und <literal>txt</literal> erzeugt werden,
|
||||
kann man entweder
|
||||
&man.make.1; zweimal hintereinander aufrufen:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>make FORMATS=html</userinput>
|
||||
&prompt.user; <userinput>make FORMATS=txt</userinput></screen>
|
||||
|
||||
<para>oder beide Formate mit einem Aufruf von &man.make.1;
|
||||
erzeugen:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>make FORMATS="html txt"</userinput></screen>
|
||||
<screen>&prompt.user; <userinput>svn up <replaceable>~/doc</replaceable></userinput></screen>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Zum Schluss müssen die Änderungen an das
|
||||
FDP mittels &man.send-pr.1; eingesandt werden.</para>
|
||||
<para>Bearbeiten Sie die Datei. Bevor Sie umfangreiche Änderungen
|
||||
an einer Datei vornehmen, kündigen Sie die geplanten Änderungen
|
||||
bitte auf der Mailingliste an.</para>
|
||||
|
||||
<para>Eine Auflistung häufig verwendeter Tags und
|
||||
Entities finden Sie in <xref linkend="xhtml-markup"/> und
|
||||
in <xref linkend="docbook-markup"/>.</para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Nachdem Sie Ihre Änderungen vorgenommen haben, prüfen
|
||||
Sie diese auf potentielle Probleme:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>igor -R filename.xml | less -RS</userinput></screen>
|
||||
|
||||
<para>Werden Fehler gemeldet, editieren Sie die Datei erneut.
|
||||
Speichern Sie das Ergebnis und fühen Sie den Test erneut aus.
|
||||
Wiederholen Sie dies solange, bis keine Fehler mehr gemeldet
|
||||
werden.</para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Bauen Sie die Dokumentation <emphasis>immer</emphasis>,
|
||||
bevor Sie Änderungen einreichen. Dazu führen Sie
|
||||
<userinput>make</userinput> im Hauptverzeichnis des
|
||||
Dokuments aus, dass Sie gerade bearbeiten. Um beispielsweise
|
||||
die deutsche Version des &os;-Handbuchs als einzelne
|
||||
<acronym>HTML</acronym>-Dateien zu bauen, führen Sie
|
||||
<userinput>make</userinput> im Verzeichnis
|
||||
<filename>de_DE.ISO8859-1/books/handbook/</filename> aus.
|
||||
Durch diesen Schritt wird sichergestellt, dass Ihre
|
||||
Änderungen den Bau der Dokumentation nicht wegen eines
|
||||
Fehlers abbrechen.</para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Wenn Ihre Änderungen abgeschlossen und erfolgreich
|
||||
getestet wurden, erzeugen Sie eine
|
||||
<quote>Differenzdatei</quote>-Datei mit
|
||||
Ihren Änderungen:</para>
|
||||
|
||||
<screen>&prompt.user; <userinput>cd ~/doc</userinput>
|
||||
&prompt.user; <userinput>svn diff > <replaceable>bsdinstall</replaceable>.diff.txt</userinput></screen>
|
||||
|
||||
<para>Geben Sie der Differenzdatei einen aussagekräftigen Namen.
|
||||
Im angegebenen Bespiel wurden Änderungen im Abschnitt
|
||||
<filename>bsdinstall</filename> des Handbuchs vorgenommen.</para>
|
||||
</step>
|
||||
|
||||
<step>
|
||||
<para>Reichen Sie Ihre Änderungen über das webbasierte <link
|
||||
xlink:href="&url.base;/support.html#gnats">Problembericht-Formular</link>
|
||||
ein. Geben Sie eine kurze Beschreibung in der Form
|
||||
<emphasis>[patch] <replaceable>kurze Beschreibung des Problems</replaceable></emphasis>
|
||||
ein. Als Kategorie wählen Sie <literal>docs</literal>
|
||||
und als Klasse <literal>doc-bug</literal>. Danach geben
|
||||
Sie eine Beschreibung Ihrer Änderungen ein sowie eventuelle
|
||||
weitere wichtige Punkte. Verwenden Sie danach den Button
|
||||
<guibutton>[ Browse... ]</guibutton>, um Ihre
|
||||
Differenzdatei hochzuladen.</para>
|
||||
</step>
|
||||
</procedure>
|
||||
</sect1>
|
||||
</chapter>
|
||||
|
|
|
|||
46
de_DE.ISO8859-1/books/fdp-primer/working-copy/chapter.xml
Normal file
46
de_DE.ISO8859-1/books/fdp-primer/working-copy/chapter.xml
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- Copyright (c) 2013 Warren Block
|
||||
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 THE AUTHOR "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:
|
||||
-->
|
||||
|
||||
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="working-copy">
|
||||
<title>The Working Copy (noch nicht übersetzt)</title>
|
||||
|
||||
<para>Dieses Kapitel ist noch nicht übersetzt. Lesen Sie daher bitte
|
||||
das <link
|
||||
xlink:href="&url.books.fdp-primer.en;/working-copy.html">Original in
|
||||
englischer Sprache</link>. Wenn Sie bei der Übersetzung
|
||||
mithelfen wollen, schicken Sie bitte eine E-Mail
|
||||
an &a.de.translators;.</para>
|
||||
</chapter>
|
||||
46
de_DE.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml
Normal file
46
de_DE.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- Copyright (c) 2013 Warren Block
|
||||
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 THE AUTHOR "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:
|
||||
-->
|
||||
|
||||
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="xhtml-markup">
|
||||
<title>XHMTL Markup (noch nicht übersetzt)</title>
|
||||
|
||||
<para>Dieses Kapitel ist noch nicht übersetzt. Lesen Sie daher bitte
|
||||
das <link
|
||||
xlink:href="&url.books.fdp-primer.en;/xhtml-markup.html">Original in
|
||||
englischer Sprache</link>. Wenn Sie bei der Übersetzung
|
||||
mithelfen wollen, schicken Sie bitte eine E-Mail
|
||||
an &a.de.translators;.</para>
|
||||
</chapter>
|
||||
Loading…
Reference in a new issue