Die Fibel für neue Mitarbeiter des FreeBSD-Dokumentationsprojekts

jederzeit

You have mail.
% date +"The time is %H:%M"
The time is 09:18
% svn checkout https://svn0.us-west.FreeBSD.org/doc/head ~/doc
% svn up ~/doc
% igor -R filename.xml | less -RS
% cd ~/doc
% svn diff > bsdinstall.diff.txt
% svn checkout https://svn0.us-west.FreeBSD.org/doc/head ~/doc
% svn checkout https://svn0.us-west.FreeBSD.org/base/head ~/src
% svn update ~/doc
% svn revert chapter.xml
% cd ~/doc
% svn diff > doc-fix-spelling.diff
% cd ~/doc
% svn diff disks/chapter.xml printers/chapter.xml > disks-printers.diff
<chapter id="kernelconfig">
...
</chapter>
% cd ~/doc/en_US.ISO8859-1/books/handbook
% make -V KNOWN_FORMATS
% cd ~/doc/en_US.ISO8859-1/books/handbook
% make FORMATS=html
% cd ~/doc/en_US.ISO8859-1/books/handbook
% make FORMATS="html-split pdf"
SUBDIR =articles
SUBDIR+=books

COMPAT_SYMLINK = en

DOC_PREFIX?= ${.CURDIR}/..
.include "${DOC_PREFIX}/share/mk/doc.project.mk"
MAINTAINER=nik@FreeBSD.org

DOC?= book

FORMATS?= html-split html

INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=

# SGML content
SRCS=  book.xml

DOC_PREFIX?= ${.CURDIR}/../../..

.include "$(DOC_PREFIX)/share/mk/docproj.docbook.mk"
DOCFORMAT?=	docbook
MAINTAINER?=	doc@FreeBSD.org

PREFIX?=	/usr/local
PRI_LANG?=	en_US.ISO8859-1

.if defined(DOC)
.if ${DOCFORMAT} == "docbook"
.include "doc.docbook.mk"
.endif
.endif

.include "doc.subdir.mk"
.include "doc.install.mk"
_SUBDIRUSE: .USE
.for entry in ${SUBDIR}
	@${ECHO} "===> ${DIRPRFX}${entry}"
	@(cd ${.CURDIR}/${entry} && \
	${MAKE} ${.TARGET:S/realpackage/package/:S/realinstall/install/} DIRPRFX=${DIRPRFX}${entry}/ )
.endfor
clean: _SUBDIRUSE
	rm -f ${CLEANFILES}
_SUBDIRUSE: .USE
.for entry in ${SUBDIR}
	@${ECHO} "===> ${DIRPRFX}${entry}"
	@(cd ${.CURDIR}/${entry} && \
	${MAKE} ${.TARGET:S/realpackage/package/:S/realinstall/install/} DIRPRFX=${DIRPRFX}${entry}/ )
.endfor
WEB_LANG="de_DE.ISO8859-1 fr_FR.ISO8859-1"
% cd ~/doc/en_US.ISO8859-1/htdocs/
% make all
% cd ~/doc/en_US.ISO8859-1/htdocs/
% env DESTDIR=/tmp/www make ENGLISH_ONLY=yes WEB_ONLY=yes all install
% firefox /tmp/www/data/index.html
# httpd.conf for testing the FreeBSD website
Define TestRoot "/tmp/www/data"

# directory for configuration files
ServerRoot "/usr/local"

Listen 80

# minimum required modules
LoadModule authz_core_module libexec/apache24/mod_authz_core.so
LoadModule mime_module libexec/apache24/mod_mime.so
LoadModule unixd_module libexec/apache24/mod_unixd.so
LoadModule cgi_module libexec/apache24/mod_cgi.so
LoadModule dir_module libexec/apache24/mod_dir.so

# run the webserver as user and group
User www
Group www

ServerAdmin you@example.com
ServerName fbsdtest

# deny access to all files
<Directory />
    AllowOverride none
    Require all denied
</Directory>

# allow access to the website directory
DocumentRoot "${TestRoot}"
<Directory "${TestRoot}">
    Options Indexes FollowSymLinks
    AllowOverride None
    Require all granted
</Directory>

# prevent access to .htaccess and .htpasswd files
<Files ".ht*">
    Require all denied
</Files>

ErrorLog "/var/log/httpd-error.log"
LogLevel warn

# set up the CGI script directory
<Directory "${TestRoot}/cgi">
    AllowOverride None
    Options None
    Require all granted
    Options +ExecCGI
    AddHandler cgi-script .cgi
</Directory>

Include etc/apache24/Includes/*.conf
# service apache24 onestart
% cd ~/doc/en_US.ISO8859-1/htdocs
% make all
% su -
Password:
# cd /usr/home/jru/doc/en_US.ISO8859-1/htdocs
# make install
# find /usr/local/www -ctime 3 -delete
% rm /tmp/foo
<para>Löschen Sie <filename>/tmp/foo</filename> mittels &man.rm.1;.</para>

<screen>&prompt.user; <userinput>rm /tmp/foo</userinput></screen>
Das ist ein Absatz. Er beginnt mit Starttag
 für das Element 'p' und endet mit dem Endtag für
 das Element 'p'.

<p>Das ist ein etwas kürzerer Absatz.</p>
<p>Das ist ein Abschnitt.</p>

<hr>

Das ist ein weiterer Absatz. Eine horizontale Linie
 trennt ihn vom vorherigen Absatz.
Das ist ein einfacher Abschnitt, in dem
 einige Worte hervorgehoben wurden.
Die Verwendung des align-Attributs
 für diesen Absatz ist überflüssig, da left
 der Standardwert ist.

<p align="center">Dieser Absatz wird hoffentlich mittig dargestellt.</p>
<p align='right'>Ich stehe rechts!</p>
SGML_ROOT=/usr/local/share/xml
SGML_CATALOG_FILES=${SGML_ROOT}/jade/catalog
SGML_CATALOG_FILES=${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/doc/share/xml/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/doc/en_US.ISO8859-1/share/xml/catalog:$SGML_CATALOG_FILES
export SGML_CATALOG_FILES
setenv SGML_ROOT /usr/local/share/xml
setenv SGML_CATALOG_FILES ${SGML_ROOT}/jade/catalog
setenv SGML_CATALOG_FILES ${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES ${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES ${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES /usr/doc/share/xml/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/xml/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES /usr/doc/de_DE.ISO8859-1/share/xml/catalog:$SGML_CATALOG_FILES
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<html>
  <head>
    <title>Eine Beispieldatei in HTML</title>
  </head>

  <body>
    <p>Das ist ein Absatz mit etwas Text.</p>

    <p>Das ist ein Absatz mit anderem Text.</p>

    <p align="right">Dieser Absatz wird rechtsbündig
      ausgerichtet.</p>
  </body>
</html>
% onsgmls -s beispiel.xml
% onsgmls -s beispiel.xml
onsgmls:beispiel.xml:5:4:E: character data is not allowed here
onsgmls:beispiel.xml:6:8:E: end tag for "HEAD" which is not finished
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN">
"Besitzer//Schlüsselwort Beschreibung//Sprache"
PUBLIC "-//W3C//DTD HTML 4.0//EN"             "4.0/strict.dtd"
<!DOCTYPE html SYSTEM "/pfad/zur/dokumenten.dtd">
<!-- Testkommentar -->
<!-- Text innerhalb eines Kommentars -->

6lt;!-- Ein anderer Kommentar    -->

6lt;!-- So können mehrzeilige Kommentare
     genutzt werden -->

<!-- Eine andere Möglichkeit für --
  -- mehrzeilige Kommentare.     -->
<!-- Innerhalb eines Kommentars --

     DIES IST NICHT TEIL EINES KOMMENTARS

  -- Wieder innerhalb eines Kommentars -->
<!DIES IST NICHT TEIL EINES KOMMENTARS>
<!----- Eine wirklich schlechte Idee  ----->
<!--===================================================-->
<para>Die aktuelle Version des
  Programms ist &current.version;.</para>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY current.version    "3.0-RELEASE">
<!ENTITY last.version       "2.2.7-RELEASE">
]>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % param.etwas "etwas">
<!ENTITY % param.text "Text">
<!ENTITY % param.neu  "%param.etwas mehr %param.text">
]>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" [
<!ENTITY version "1.1">
]>

<html>
  <head>
    <title>Eine HTML-Beispieldatei</title>
  </head>

  <body>
    <p>Das ist ein Absatz mit etwas Text.</p>

    <p>Das ist ein Absatz mit anderem Text.</p>

    <p align="right">Dieser Absatz wird rechtsbündig
      ausgerichtet.</p>

    <p>Die aktuelle Version ist: &amp;version;</p>
  </body>
</html>
% osgmlnorm beispiel.xml > beispiel.html
% osgmlnorm -d beispiel.xml > beispiel.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY kapitel.1 SYSTEM "kapitel1.xml">
<!ENTITY kapitel.2 SYSTEM "kapitel2.xml">
<!ENTITY kapitel.3 SYSTEM "kapitel3.xml">
]>

<html>

  &amp;kapitel.1;
  &amp;kapitel.2;
  &amp;kapitel.3;
</html>
<!ENTITY kapitel.1 SYSTEM "kapitel1.xml">
<!ENTITY kapitel.2 SYSTEM "kapitel2.xml">
<!ENTITY kapitel.3 SYSTEM "kapitel3.xml">
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % kapitel SYSTEM "kapitel.ent">
%kapitel;
]>

<html>
  &amp;kapitel.1;
  &amp;kapitel.2;
  &amp;kapitel.3;
</html>
<p>Erster Absatz.</p>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY version "1.1">
<!ENTITY absatz1 SYSTEM "absatz1.xml">
<!ENTITY absatz2 SYSTEM "absatz2.xml">
<!ENTITY absatz3 SYSTEM "absatz3.xml">
]>

<html>
  <head>
    <title>Eine HTML-Beispieldatei</title>
  </head>

  <body>
    <p>Die aktuelle Version dieses Dokuments ist &version;</p>

    &absatz1;
    &absatz2;
    &absatz3;
  </body>
</html>
% osgmlnorm -d beispiel.xml > beispiel.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % entitaeten SYSTEM "entitaeten.xml"> %entitaeten;
]>

<html>
  <head>
    <title>Eine HTML-Beispieldatei</title>
  </head>

  <body>
    <p>Die aktuelle Version dieses Dokuments ist &version;</p>

    &absatz1;
    &absatz2;
    &absatz3;
  </body>
</html>
<!ENTITY version "1.1">
<!ENTITY absatz1 SYSTEM "absatz1.xml">
<!ENTITY absatz2 SYSTEM "absatz2.xml">
<!ENTITY absatz3 SYSTEM "absatz3.xml">
% osgmlnorm -d beispiel.xml > beispiel.html
<![ SCHLÜSSELWORT [
  Inhalt des markierten Bereiches
]]>
<para>Das ist ein Beispiel, wie man einen Text,
  der viele &lt;- und &amp;-
  Entitäten enthält, in ein Dokument einbinden kann.
  Das Beispiel selbst, das sich innerhalb des markierten Bereiches befindet,
  ist ein HTML-Fragment. Der diesen Text umschließende Tag, beginnend mit
  mit para und endend mit /para, stammt aus der DocBook DTD.</para>

<programlisting>
  <![RCDATA[  
    <p>Dieses Beispiel demonstriert die Verwendung von HTML-Elementen.
      Da spitze Klammern so oft vorkommen, ist es einfacher, das
      gesamte Beispiel als CDATA Abschnitt auszuweisen, als die
      entsprechenden Entitäten zu nutzen.</p>

    <ul>
      <li>Das ist ein Listenelement.</li>
      <li>Das ist ein zweites Listenelement.</li>
      <li>Das ist ein drittes Listenelement.</li>
    </ul>

    <p>Und das hier, das ist das Ende des Beispiels.</p>
  ]]>
</programlisting>
<![ INCLUDE [
  Dieser Text wird verarbeitet und eingebunden.
]]>

<![ IGNORE [
  Dieser Text wird weder verarbeitet noch eingebunden.
]]>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % digitale.kopie "INCLUDE">
]]>

...

<![ %digitale.kopie [
 Dieser Satz sollte nur in der digitalen Version enthalten sein.
]]>	 
<!ENTITY % digitale.kopie "IGNORE">
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % text.ausgabe "INCLUDE">
]>

<html>
  <head>
    <title>Ein Beispiel mit markierten Abschnitten</title>
  </head>

  <body>
    <p>Dieser Absatz <![CDATA[beinhaltet viele <
      Zeichen (< < < < <). Weshalb es einfacher ist,
      ihn als CDATA Bereich auszuweisen. ]]></p>

    <![ IGNORE [
    <p>Dieser Absatz wird NICHT in der Ausgabe enthalten sein.</p>
    ]]>

    <![ %text.ausgabe [
     <p>Dieser Absatz wird in Abhängigkeit von %text.ausgabe
       mitausgegeben.</p>
    ]]>
  </body>
</html>
% svn checkout https://svn.FreeBSD.org/doc/head/ head
% svn diff -r33733:33734 en_US.ISO8859-1/books/fdp-primer/book.xml
head/
    sv_SE.ISO8859-1/
                     Makefile
                     htdocs/
                           docproj/
                     books/
                           faq/
                               Makefile
                               book.xml
% cd doc
% tar cf swedish-docs.tar sv_SE.ISO8859-1
% gzip -9 swedish-docs.tar
<!--
     The FreeBSD Documentation Project

     $FreeBSD: head/en_US.ISO8859-1/books/faq/book.xml 38674 2012-04-14 13:52:52Z $
<!--
     The FreeBSD Spanish Documentation Project

     $FreeBSD: head/es_ES.ISO8859-1/books/faq/book.xml 38826 2012-05-17 19:12:14Z hrs $
     Original revision: r38674
-->
# cd /usr/ports/editors/poedit
# make install clean
% svn mkdir --parents ~/doc/es_ES.ISO8859-1/articles/leap-seconds/
% svn cp ~/doc/en_US.ISO8859-1/articles/leap-seconds/Makefile \
    ~/doc/es_ES.ISO8859-1/articles/leap-seconds/
% cd ~/doc/es_ES.ISO8859-1/articles/leap-seconds/
% make po
% poedit es_ES.po
% cd ~/doc/es_ES.ISO8859-1/articles/leap-seconds/
% make tran
% make FORMATS=html
% firefox article.html
% cd ~/doc/es_ES.ISO8859-1/books/
% svn mkdir porters-handbook
A         porters-handbook
% cd ~/doc/es_ES.ISO8859-1/books/porters-handbook
% svn cp ~/doc/en_US.ISO8859-1/books/porters-handbook/Makefile .
A         Makefile
#
# $FreeBSD$
#
# Build the FreeBSD Porter's Handbook.
#

MAINTAINER=doc@FreeBSD.org

DOC?= book

FORMATS?= html-split

INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=

# XML content
SRCS=  book.xml

# Images from the cross-document image library
IMAGES_LIB+=    callouts/1.png
IMAGES_LIB+=    callouts/2.png
IMAGES_LIB+=    callouts/3.png
IMAGES_LIB+=    callouts/4.png
IMAGES_LIB+=    callouts/5.png
IMAGES_LIB+=    callouts/6.png
IMAGES_LIB+=    callouts/7.png
IMAGES_LIB+=    callouts/8.png
IMAGES_LIB+=    callouts/9.png
IMAGES_LIB+=    callouts/10.png
IMAGES_LIB+=    callouts/11.png
IMAGES_LIB+=    callouts/12.png
IMAGES_LIB+=    callouts/13.png
IMAGES_LIB+=    callouts/14.png
IMAGES_LIB+=    callouts/15.png
IMAGES_LIB+=    callouts/16.png
IMAGES_LIB+=    callouts/17.png
IMAGES_LIB+=    callouts/18.png
IMAGES_LIB+=    callouts/19.png
IMAGES_LIB+=    callouts/20.png
IMAGES_LIB+=    callouts/21.png

URL_RELPREFIX?= ../../../..
DOC_PREFIX?= ${.CURDIR}/../../..

.include "${DOC_PREFIX}/share/mk/doc.project.mk"
% cd ~/doc/fr_FR.ISO8859-1/articles/
% svn mkdir pgpkeys
A         pgpkeys
% cd ~/doc/fr_FR.ISO8859-1/articles/pgpkeys
% svn cp ~/doc/en_US.ISO8859-1/articles/pgpkeys/Makefile .
A         Makefile
#
# $FreeBSD$
#
# Article: PGP Keys

DOC?= article

FORMATS?= html
WITH_ARTICLE_TOC?= YES

INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=

SRCS=   article.xml

# To build with just key fingerprints, set FINGERPRINTS_ONLY.

URL_RELPREFIX?= ../../../..
DOC_PREFIX?=    ${.CURDIR}/../../..

.include "${DOC_PREFIX}/share/mk/doc.project.mk"
% cd ~/doc/es_ES.ISO8859-1/books/porters-handbook
% make po
% poedit es_ES.po
If <acronym>NTP</acronym> is not being used
Si <acronym>NTP</acronym> no se utiliza
&dollar;FreeBSD&dollar;
&dollar;FreeBSD&dollar;
% cd ~/doc/es_ES.ISO8859-1/books/porters-handbook
% make tran
% make FORMATS=html
% firefox book.html
#$FreeBSD$
% cd ~/doc/es_ES.ISO8859-1/articles/nanobsd/
% ls
Makefile	article.xml	es_ES.po
% svn add Makefile article.xml es_ES.po
A         Makefile
A         article.xml
A         es_ES.po
% svn propset svn:keywords FreeBSD=%H Makefile article.xml es_ES.po
property 'svn:keywords' set on 'Makefile'
property 'svn:keywords' set on 'article.xml'
property 'svn:keywords' set on 'es_ES.po'
% svn propset svn:mime-type text/x-gettext-translation es_ES.po
property 'svn:mime-type' set on 'es_ES.po'
% svn propset svn:mime-type text/xml article.xml
property 'svn:mime-type' set on 'article.xml'
% cd ~/doc
svn diff es_ES.ISO8859-1/articles/nanobsd/ > /tmp/es_nanobsd.diff
#$FreeBSD$
% cd ~/doc/ko_KR.UTF-8/articles/explaining-bsd/
% ls
Makefile	article.xml	ko_KR.po
% svn add Makefile article.xml ko_KR.po
A         Makefile
A         article.xml
A         ko_KR.po
% svn propset svn:keywords FreeBSD=%H Makefile article.xml ko_KR.po
property 'svn:keywords' set on 'Makefile'
property 'svn:keywords' set on 'article.xml'
property 'svn:keywords' set on 'ko_KR.po'
% svn propset svn:mime-type 'text/x-gettext-translation; charset=UTF-8' ko_KR.po
property 'svn:mime-type' set on 'ko_KR.po'
% svn propset fbsd:notbinary yes ko_KR.po
property 'fbsd:notbinary' set on 'ko_KR.po'
% svn propset svn:mime-type 'text/xml; charset=UTF-8' article.xml
property 'svn:mime-type' set on 'article.xml'
% svn propset fbsd:notbinary yes article.xml
property 'fbsd:notbinary' set on 'article.xml'
% cd ~/doc
svn diff ko_KR.UTF-8/articles/explaining-bsd > /tmp/ko-explaining.diff
+--- Einrückung (Spalte) 0
V
<chapter>
  <title>...</title>

  <sect1>
    <title>...</title>

    <sect2>
      <title>Einrückung</title>

      <para>Die erste Zeile jeder Datei hat die Einrückung 0, und
        zwar <emphasis>unabhängig</emphasis> von der Einrückung
        der Datei, in der sie enthalten ist.</para>

      ...
    </sect2>
  </sect1>
</chapter>
augroup sgmledit
  autocmd FileType sgml set formatoptions=cq2l " Special formatting options
  autocmd FileType sgml set textwidth=70       " Wrap lines at 70 columns
  autocmd FileType sgml set shiftwidth=2       " Automatically indent
  autocmd FileType sgml set softtabstop=2      " Tab key indents 2 spaces
  autocmd FileType sgml set tabstop=8          " Replace 8 spaces with a tab
  autocmd FileType sgml set autoindent         " Automatic indentation
augroup END
<article lang='de'>
  <articleinfo>
    <title>NIS</title>

    <pubdate>October 1999</pubdate>

    <abstract>
      <para>...
	...
	...</para>
    </abstract>
  </articleinfo>

  <sect1>
    <title>...</title>

    <para>...</para>
  </sect1>

  <sect1>
    <title>...</title>

    <para>...</para>
  </sect1>
</article>
Data capacity ranges from 40 MB to 15
GB.  Hardware compression …
57600&nbsp;bps
FreeBSD&nbsp;4.7
Sun&nbsp;Microsystems
if has("autocmd")
    au BufNewFile,BufRead *.sgml,*.ent,*.xsl,*.xml call Set_SGML()
    au BufNewFile,BufRead *.[1-9] call ShowSpecial()
endif " has(autocmd)

function Set_Highlights()
    "match ExtraWhitespace /^\s* \s*\|\s\+$/
    highlight default link OverLength ErrorMsg
    match OverLength /\%71v.\+/
    return 0
endfunction

function ShowSpecial()
    setlocal list listchars=tab:>>,trail:*,eol:$
    hi def link nontext ErrorMsg
    return 0
endfunction " ShowSpecial()

function Set_SGML()
    setlocal number
    syn match sgmlSpecial "&[^;]*;"
    setlocal syntax=sgml
    setlocal filetype=xml
    setlocal shiftwidth=2
    setlocal textwidth=70
    setlocal tabstop=8
    setlocal softtabstop=2
    setlocal formatprg="fmt -p"
    setlocal autoindent
    setlocal smartindent
    " Rewrap paragraphs
    noremap P gqj
    " Replace spaces with tabs
    noremap T :s/        /\t/<CR>
    call ShowSpecial()
    call Set_Highlights()
    return 0
endfunction " Set_SGML()
<locatingRules xmlns="http://thaiopensource.com/ns/locating-rules/1.0">
  <documentElement localName="section" typeId="DocBook">
  <documentElement localName="chapter" typeId="DocBook">
  <documentElement localName="article" typeId="DocBook">
  <documentElement localName="book" typeId="DocBook">
  <typeId id="DocBook" uri="/usr/local/share/xml/docbook/5.0/rng/docbook.rnc">
</locatingRules>
(add-to-list 'package-archives '("melpa" . "http://stable.melpa.org/packages/") t)
(package-install 'flycheck)
(flycheck-define-checker igor
  "FreeBSD Documentation Project sanity checker.

See URLs http://www.freebsd.org/docproj/ and
http://www.freshports.org/textproc/igor/."
  :command ("igor" "-X" source-inplace)
  :error-parser flycheck-parse-checkstyle
  :modes (nxml-mode)
  :standard-input t)

  (add-to-list 'flycheck-checkers 'igor 'append)
;;; Directory Local Variables
;;; For more information see (info "(emacs) Directory Variables")

((nxml-mode
  (eval . (turn-on-auto-fill))
  (fill-column . 70)
  (eval . (require 'flycheck))
  (eval . (flycheck-mode 1))
  (flycheck-checker . igor)
  (eval . (add-to-list 'rng-schema-locating-files "~/.emacs.d/schema/schemas.xml"))))
% cp /usr/local/share/nano/xml.nanorc ~/.nanorc
syntax "xml" "\.([jrs]html?|xml|xslt?)$"
# trailing whitespace
color ,blue "[[:space:]]+$"
# multiples of eight spaces at the start a line
# (after zero or more tabs) should be a tab
color ,blue "^([TAB]*[ ]{8})+"
# tabs after spaces
color ,yellow "( )+TAB"
# highlight indents that have an odd number of spaces
color ,red "^(([ ]{2})+|(TAB+))*[ ]{1}[^ ]{1}"
# lines longer than 70 characters
color ,yellow "^(.{71})|(TAB.{63})|(TAB{2}.{55})|(TAB{3}.{47}).+$"
% perl -i'' -pe 's/TAB/\t/g' ~/.nanorc
% nano -AKipwz -r 70 -T8 chapter.xml
alias nano "nano -AKipwz -r 70 -T8"
% nano chapter.xml
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN">

<book lang='de'>
  <bookinfo>
    <title>Ein Buchbeispiel</title>

    <author>
      <firstname>Vorname</firstname>
      <surname>Nachname</surname>
      <affiliation>
        <address><email>vorname.nachname@domain.de</email></address>
      </affiliation>
    </author>

    <copyright>
      <year>2000</year>
      <holder>Urheberhinweis</holder>
    </copyright>

    <abstract>
      <para>Falls das Buch eine Zusammenfassung hat, sollte sie
        hier stehen.</para>
    </abstract>
  </bookinfo>

  <preface>
    <title>Einleitung</title>

    <para>Falls das Buch eine Einleitung hat, sollte diese hier
      stehen.</para>
  </preface>

  <chapter>
    <title>Das erste Kapitel</title>

    <para>Das ist das erste Kapitel des Buches.</para>

    <sect1>
      <title>Der erste Abschnitt</title>

      <para>Das ist der erste Abschnitte des Buches.</para>
    </sect1>
  </chapter>
</book>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN">

<article lang='de'>
  <articleinfo>
    <title>Ein Beispielartikel</title>

    <author>
      <firstname>Vorname</firstname>
      <surname>Nachname</surname>
      <affiliation>
        <address><email>vorname.nachname@domain.de</email></address>
      </affiliation>
    </author>

    <copyright>
      <year>2000</year>
      <holder>Urheberhinweis</holder>
    </copyright>

    <abstract>
      <para>Falls der Artikel eine Zusammenfassung hat, sollte sie
        hier stehen.</programlisting>
    </abstract>
  </articleinfo>

  <sect1>
    <title>Der erste Abschnitt</title>

    <para>Das ist der erste Abschnitt des Artikels.</para>

    <sect2>
      <title>Der erste Unterabschnitt</title>

      <para>Das ist der erste Unterabschnitt des Artikels.</para>
    </sect2>
  </sect1>
</article>
% jade -V nochunks \  
-c /usr/local/share/xml/docbook/dsssl/modular/catalog \ 
-c /usr/local/share/xml/docbook/catalog \
-c /usr/local/share/xml/jade/catalog \
-d /usr/local/share/xml/docbook/dsssl/modular/html/docbook.dsl \
-t sgml  datei.xml > datei.html 
% jade \
-c /usr/local/share/xml/docbook/dsssl/modular/catalog \ 
-c /usr/local/share/xml/docbook/catalog \
-c /usr/local/share/xml/jade/catalog \
-d /usr/local/share/xml/docbook/dsssl/modular/html/docbook.dsl \
-t sgml  datei.xml 
% jade -V tex-backend \ 
    -c /usr/local/share/xml/docbook/dsssl/modular/catalog \ 
    -c /usr/local/share/xml/docbook/catalog \
    -c /usr/local/share/xml/jade/catalog \
    -d /usr/local/share/xml/docbook/dsssl/modular/print/docbook.dsl \
    -t tex  datei.xml
% tex "&jadetex" datei.tex
% dvips -o datei.ps datei.dvi
% pdftex "&pdfjadetex" datei.tex

Benutzer	Eingabeaufforderung
`Normaler Benutzer`	`%`
`Superuser`	`#`

Bedeutung	Beispiel
Kommandonamen	Geben Sie `ls -a` ein, um alle Dateien anzuzeigen.
Datei- und Verzeichnisnamen	Bearbeiten Sie `.login`.
Bildschirmausgaben	You have mail.
Bildschirmein- und ausgaben	`%` `date +"The time is %H:%M"` The time is 09:18
Referenzen auf Hilfeseiten	Mit su(1) können Sie sich als ein anderer Benutzer anmelden.
Benutzer- und Gruppennamen	Ich bin `root`, ich darf das.
Hervorhebungen	Hier müssen Sie vorsichtig sein.
Text, der vom Benutzer durch seine Eingaben ersetzt werden muss	Um die Hilfeseiten nach einem bestimmten Begriff zu durchsuchen, geben Sie `man -k Suchbegriff` ein.
Umgebungsvariablen	`$HOME` ist Ihr Benutzerverzeichnis.

Verzeichis	Bedeutung
`articles`	DocBook-formatierte Artikel (`article`) oder ähnliche Dokumente. Meist relativ kurz und in Abschnitte aufgeteilt. Artikel sind in der Regel als ein einziges, großes XHTML-Dokument verfügbar.
`books`	DocBook-formatierte Bücher (`book`) oder ähnliche Dokumente. Umfangreiche Dokumente, die in Kapitel aufgeteilt werden. Sind in der Regel sowohl als eine einzige, große XHTML-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.
`man`	Dient für Übersetzungen von Manualpages. Es enthält ein oder mehrere `mann`-Verzeichnisse, je nachdem, welche Abschnitte der Manualpages bereits übersetzt wurden.

`FORMATS`	Dateityp	Beschreibung
`html`	HTML, Einzeldatei	Eine einzelne `book.html` oder `article.html`.
`html-split`	HTML, multiple Dateien	Multiple HTML-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.
`pdf`	PDF	Portable Document Format

Spalte	Bedeutung
1	Der Name des Programms, das den Fehler meldet. Hier wird immer `onsgmls` stehen.
2	Der Name der fehlerhaften Datei.
3	Die Zeilennummer des Fehlers.
4	Die Spaltenummer des Fehlers.
5	Ein einbuchstabiger Code, der über die Art des Fehlers informiert. `I` steht für eine informelle Meldung, `W` für eine Warnung und `E` für Fehler^[a] und `X` für einen Querverweis. Bei den oben stehenden Ausgaben handelt es sich also um Fehlermeldungen.
6	Die Meldung.
^[a]Nicht immer besteht eine Meldung aus fünf Spalten. Die Ausgabe von `onsgmls -sv` ist beispielsweise `onsgmls:I: SP version "1.3"` (natürlich abhängig von der Version). Wie man sehen kann, handelt es sich hier um eine informelle Meldung.

11.1.	Was bedeuten die Abkürzungen i18n und l10n?
	i18n steht für internationalization (Internationalisierung), l10n für localization (Lokalisierung). Es handelt sich dabei um besser handhabbare Abkürzungen dieser Begriffe. i18n kann als „i“, gefolgt von 18 Buchstaben, gefolgt von einem „n“, gelesen werden. Analog steht l10n für „l“, gefolgt von 10 Buchstaben, gefolgt von einem „n“.
11.2.	Gibt es eigene Mailinglisten für Übersetzer?
	Ja. Die verschiedenen Übersetzergruppen haben jeweils eigene Mailinglisten. Genauere Informationen finden Sie in der Liste der Übersetzungsprojekte. Diese Liste enthält die Mailinglisten und Internetseiten, die von den einzelnen Übersetzungsprojekten betrieben werden. Für allgemeine Diskussionen zur Übersetzung der FreeBSD-Dokumentation gibt es die Mailingliste `<freebsd-translators@freebsd.org>`.
11.3.	Werden noch Übersetzer benötigt?
	Ja. Je mehr Leute an der Übersetzung arbeiten, desto schneller wird diese fertig, und umso schneller sind Änderungen im englischen Original auch in den übersetzten Dokumenten vorhanden. Sie müsssen kein professioneller Dolmetscher sein, um dabei zu helfen.
11.4.	Welche Sprachen muss ich dafür kennen/können?
	Idealerweise haben Sie gute Kenntnisse in geschriebenem Englisch, außerdem sollten Sie natürlich fit in der Sprache sein, in die Sie übersetzen wollen. Englisch ist allerdings nicht unbedingt nötig. Sie könnten beispielsweise auch die FAQ vom Spanischen ins Ungarische übersetzen.
11.5.	Welche Software wird benötigt?
	Es ist sehr empfehlenswert, eine lokale Kopie des FreeBSD Subversion-Repository (als Minimum den Dokumentationsteil) anzulegen. Dazu geben Sie den folgenden Befehl ein: `%` `svn checkout https://svn.FreeBSD.org/doc/head/ head` Anmerkung: svn.FreeBSD.org ist ein öffentlicher Server. Überprüfen Sie das Serverzertifikat, bevor Sie erstmals auf den Server zugreifen. Anmerkung: Damit dieser Befehl funktioniert, muss der Port devel/subversion installiert sein. Sie sollten außerdem mit svn vertraut sein. Damit ist es möglich, festzustellen, was sich zwischen einzelnen Versionen eines Dokuments geändert hat. Wenn Sie beispielsweise wissen wollen, was sich zwischen den Revisionen `r33733` und `r33734` der Datei `en_US.ISO8859-1/books/fdp-primer/book.xml` geändert hat, geben Sie den folgenden Befehl ein: `%` `svn diff -r33733:33734 en_US.ISO8859-1/books/fdp-primer/book.xml` Lesen Sie bitte das FreeBSD Handbook, um sich darüber zu informieren, wie FreeBSD Subversion einsetzt.
11.6.	Wie finde ich heraus, ob noch jemand Teile der Dokumentation in die gleiche Sprache übersetzt?
	Die Übersetzungsseite des Documentation Projects listet alle Übersetzungs-Teams auf, die derzeit aktiv sind. Arbeitet bereits jemand an der Übersetzung in Ihre Sprache, so kontaktieren Sie dieses Team, damit Dokumente nicht unnötigerweise mehrfach übersetzt werden. Wenn Ihre Sprache nicht aufgeführt ist, senden Sie bitte eine E-Mail an das FreeBSD documentation project. Vielleicht denkt ja jemand über eine Übersetzung nach, hat sich aber noch nicht dafür entschieden.
11.7.	Niemand übersetzt in meine Sprache. Was soll ich machen?
	Gratulation, Sie haben gerade das „FreeBSD `Ihre-Sprache` Documentation Translation Project“ gestartet. Willkommen. Entscheiden Sie zuerst, ob Sie die dafür nötige Zeit zur Verfügung haben. Da Sie als Einziger an der Übersetzung in Ihre Sprache arbeiten, sind Sie dafür verantwortlich, Ihre Arbeit zu veröffentlichen und die Arbeit von Freiwilligen, die Ihnen dabei helfen wollen, zu koordinieren. Senden Sie eine E-Mail an die Mailingliste des Documentation Projects, in der Sie bekanntgeben, dass Sie an der Übersetzung der Dokumentation arbeiten, damit die Internetseiten aktualisiert werden können. Gibt es in Ihrem Land einen FreeBSD-Spiegelserver, so sollten Sie den dafür Zuständigen kontaktieren und nachfragen, ob er Ihnen Speicherplatz oder E-Mailadressen für Ihr Projekt zur Verfügung stellen würde. Danach wählen Sie ein Dokument aus und beginnen mit der Übersetzung. Am besten beginnen Sie mit kleineren Dateien, beispielsweise den FAQ oder einem der Artikel.
11.8.	Ich habe ein Dokument übersetzt. Wo soll ich es hinschicken?
	Das kommt darauf an. Wenn Sie bereits in einem Übersetzer-Team arbeiten (etwa dem japanischen oder dem deutschen Team), dann sollten Sie deren Richtlinien zum Umgang mit neuer Dokumentation folgen, die auf deren Internetseiten beschrieben werden. Wenn Sie die einzige Person sind, die an der Übersetzung in eine Sprache arbeitet, oder wenn Sie für ein Übersetzungsprojekt verantwortlich sind, und Ihre Aktualisierungen an das FreeBSD Project übermitteln wollen, sollten Sie Ihre Übersetzungen dorthin senden (lesen Sie dazu auch die nächste Frage).
11.9.	Ich arbeite als einziger an der Übersetzung in diese Sprache, wie versende ich meine Übersetzungen? oder Wir sind ein Übersetzer-Team, und wollen Dokumente versenden, die unsere Mitglieder übersetzt haben.
	Stellen Sie zuerst sicher, dass Ihre Übersetzungen korrekt organisiert sind. Sie sollte sich also im existierenden Dokumentationsbaum befinden, und ohne Fehler bauen lassen. Zurzeit wird die FreeBSD Dokumentation unterhalb des Verzeichnisses `head/` gespeichert. Die direkten Unterverzeichnisse werden entsprechend der Sprachkodierung benannt, in der sie geschrieben sind. Diese Kodierung nach ISO639 finden Sie auf einem FreeBSD-System unter `/usr/share/misc/iso639`, vorausgesetzt, das System wurde nach dem 20. Januar 1999 gebaut. Wenn in Ihrer Sprache mehrere Kodierungen (wie dies etwa für Chinesisch der Fall ist) vorhanden sind, existiert für jede Kodierung ein eigenes Unterverzeichnis. Zuletzt existieren auch noch Verzeichnisse für die einzelnen Dokumente. Die Verzeichnishierarchie für eine hypothetische schwedische Übersetzung könnte etwa so aussehen: head/ sv_SE.ISO8859-1/ Makefile htdocs/ docproj/ books/ faq/ Makefile book.xml Bei `sv_SE.ISO8859-1` handelt es sich um den Namen der Übersetzung in der Form `lang.encoding`. Beachten Sie auch, dass zum Bauen der Dokumentation zwei Makefiles notwendig sind. Komprimieren Sie Ihre Übersetzungen mit tar(1) und gzip(1) und senden Sie sie an das FreeBSD Project. `%` `cd doc` `%` `tar cf swedish-docs.tar sv_SE.ISO8859-1` `%` `gzip -9 swedish-docs.tar` Legen Sie das Archiv `swedish-docs.tar.gz` irgendwo ab. Wenn Sie keinen eigenen Webspace haben (etwa weil Ihr Internetprovider Ihnen keinen zur Verfügung stellt), können Sie auch eine E-Mail an das Documentation Engineering Team `<doceng@FreeBSD.org>` schicken, um abzuklären, ob Sie die Datei auch als E-Mail schicken können. In beiden Fällen sollten Sie mit Bugzilla einen Bericht über den Versand der Dokumentation erstellen. Es ist sehr hilfreich, wenn Sie Ihre Übersetzung vorher korrekturlesen lassen und überprüfen, da es unwahrscheinlich ist, dass der Committer Ihre Sprache sehr gut beherrscht. Danach wird jemand (meistens der Documentation Project Manager, derzeit ist dies das Documentation Engineering Team `<doceng@FreeBSD.org>`) überprüfen, ob sich Ihre Übersetzungen problemlos bauen lassen. Dabei wird besonders auf folgende Punkte geachtet: Verwenden alle Dateien RCS-Strings (wie "ID")? Arbeitet `make all` im Verzeichnis `sv_SE.ISO8859-1` korrekt? Funktioniert `make install` ohne Probleme? Gibt es dabei Probleme, so wird die Person, die Ihren Beitrag durchsieht, sich wieder an Sie wenden, damit Sie das Problem beheben. Treten keine Probleme auf, wird Ihre Übersetzung so rasch als möglich committed.
11.10.	Kann ich landes- oder sprachspezifische Informationen in meine Übersetzung aufnehmen?
	Wir bitten Sie, dies nicht zu tun. Nehmen wir an, dass Sie das Handbuch ins Koreanische übersetzen und einen Abschnitt mit Händlerinformationen in das Handbuch aufnehmen wollen. Es gibt keinen Grund, warum diese Information nicht auch in der englischen (oder der deutschen, oder der spanischen, oder der japanischen oder der …) Version vorhanden sein sollte. Es ist etwa denkbar, dass sich jemand mit englischer Muttersprache während eines Aufenthalts in Korea eine FreeBSD-Kopie kaufen möchte. Außerdem wird dadurch die weltweite Präsenz von FreeBSD verdeutlicht, was natürlich ebenfalls von Vorteil ist. Wenn Sie also länderspezifische Informationen ergänzen wollen, sollten Sie dies zuerst in der englischen Version (über Bugzilla) tun, und die Änderung anschließend in Ihre Sprache übersetzen. Vielen Dank.
11.11.	Wie lassen sich sprachspezifische Zeichen darstellen?
	Nicht-ASCII-Zeichen innerhalb der Dokumentation werden durch SGML-Entities dargestellt. Diese bestehen aus: Kaufmännischem Und (&), den Namen der Entity, und einem Strichpunkt (;). Die Namen der Entities sind in ISO8879 definiert, die als Port textproc/iso8879 installiert werden kann. Dazu einige Beispiele: Entity: é Darstellung: é Beschreibung: Kleines „e“ mit (akutem) Akzent Entity: É Darstellung: É Beschreibung: Großes „E“ mit (akutem) Akzent Entity: ü Darstellung: ü Beschreibung: Kleines Umlaut-„u“ Nachdem Sie den iso8879-Port installiert haben, ist die vollständige Liste unter `/usr/local/share/xml/iso8879` vorhanden.
11.12.	Wie spricht man den Leser an?
	In englischen Dokumenten wird der Leser mit „you“ angesprochen, es wird nicht zwischen formeller/informeller Anrede unterschieden, wie dies in manchen anderen Sprachen der Fall ist. Wenn Sie in eine Sprache übersetzen, die diese Unterscheidung trifft, verwenden Sie die Form, die auch in den anderen technischen Dokumentationen dieser Sprache verwendet wird. Für deutsche Versionen ist dies die dritte Person Plural („Sie“).
11.13.	Muss ich zusätzliche Informationen in meine Übersetzungen einbauen?
	Ja. Der Header der englischen Version jedes Textes sieht in etwa so aus: <!-- The FreeBSD Documentation Project $FreeBSD: head/en_US.ISO8859-1/books/faq/book.xml 38674 2012-04-14 13:52:52Z $ Das exakte Aussehen kann unterschiedlich sein, die Zeile mit $FreeBSD$ sowie der Ausdruck `The FreeBSD Documentation Project` sind allerdings immer enthalten. Beachten Sie, dass die Zeile mit $FreeBSD von Subversion automatisch expandiert wird, daher sollte an dieser Stelle in Ihren neuen Dokumenten nur $FreeBSD$ stehen. Ihre übersetzten Dokumente sollten eine eigene $FreeBSD$-Zeile enthalten. Zusätzlich sollten Sie die Zeile mit `The FreeBSD Documentation Project` in `The FreeBSD Ihre-Sprache-hier-einfügen Documentation Project`. Außerdem sollten Sie eine weitere Zeile einfügen, die festlegt, auf welcher Version des englischen Originals Ihre Übersetzung basiert. Die spanische Version dieser Datei könnte etwa so beginnen: <!-- The FreeBSD Spanish Documentation Project $FreeBSD: head/es_ES.ISO8859-1/books/faq/book.xml 38826 2012-05-17 19:12:14Z hrs $ Original revision: r38674 -->

Sprache	Region	Übersetzungsverzeichnis	PODateiname	Zeichensatz
Englisch	Vereinigte Staaten von Amerika	`en_US.ISO8859-1`	`en_US.po`	ISO 8859-1
Bengalisch	Bangladesch	`bn_BD.UTF-8`	`bn_BD.po`	UTF-8
Dänisch	Dänemark	`da_DK.ISO8859-1`	`da_DK.po`	ISO 8859-1
Deutsch	Deutschland	`de_DE.ISO8859-1`	`de_DE.po`	ISO 8859-1
Griechisch	Griechenland	`el_GR.ISO8859-7`	`el_GR.po`	ISO 8859-7
Spanisch	Spanien	`es_ES.ISO8859-1`	`es_ES.po`	ISO 8859-1
French	France	`fr_FR.ISO8859-1`	`fr_FR.po`	ISO 8859-1
Ungarisch	Ungarn	`hu_HU.ISO8859-2`	`hu_HU.po`	ISO 8859-2
Italienisch	Italien	`it_IT.ISO8859-15`	`it_IT.po`	ISO 8859-15
Japanisch	Japan	`ja_JP.eucJP`	`ja_JP.po`	EUC JP
Koreanisch	Korea	`ko_KR.UTF-8`	`ko_KR.po`	UTF-8
Mongolisch	Mongolien	`mn_MN.UTF-8`	`mn_MN.po`	UTF-8
Holländisch	Niederlande	`nl_NL.ISO8859-1`	`nl_NL.po`	ISO 8859-1
Polnisch	Polen	`pl_PL.ISO8859-2`	`pl_PL.po`	ISO 8859-2
Portugisisch	Brasilien	`pt_BR.ISO8859-1`	`pt_BR.po`	ISO 8859-1
Russisch	Russland	`ru_RU.KOI8-R`	`ru_RU.po`	KOI8-R
Türkisch	Türkei	`tr_TR.ISO8859-9`	`tr_TR.po`	ISO 8859-9
Chinesisch	China	`zh_CN.UTF-8`	`zh_CN.po`	UTF-8
Chinesisch	Taiwan	`zh_TW.UTF-8`	`zh_TW.po`	UTF-8

	Übergibt den Parameter `nochunks` an die Stylesheets. Dadurch wird die gesamte Ausgabe in die Standardausgabe geschrieben (bei der Benutzung von Norm Walshs Stylesheets).
	Legt die von Jade zur Verarbeitung benötigten drei Kataloge fest. Der erste Katalog enthält Informationen zu den DSSSL-Stylesheets, der zweite zur DocBook DTD und der dritte Jade-spezifische Informationen.
	Übergibt den vollen Pfad zum DSSSL-Stylesheet, das von Jade zur Verarbeitung des Dokuments benutzt wird.
	Weist Jade an, eine Transformation von einer DTD zu einer anderen DTD vorzunehmen. In diesem Falle, von der DocBook DTD zur HTML DTD.
	Legt fest, welche Datei Jade verarbeiten soll und leitet die Ausgabe in die Datei `datei.html` um.

	Weist die Stylesheets an, verschiedene TeX-spezifische Optionen zu benutzen.
	Legt die von Jade zur Verarbeitung benötigten drei Kataloge fest. Der erste Katalog enthält Informationen zu den DSSSL-Stylesheets, der zweite zur DocBook DTD und der dritte Jade-spezifische Informationen.
	Übergibt den vollen Pfad zum DSSSL-Stylesheet, das von Jade zur Verarbeitung des Dokuments benutzt wird.
	Weist Jade an, die Ausgabe in eine TeX-Datei umzuwandeln.

Die Fibel für neue Mitarbeiter des FreeBSD-Dokumentationsprojekts

The FreeBSD Documentation Project

Wichtig:

Benutzungshinweise

1. Die Eingabeaufforderungen

2. Typographische Festlegungen

3. Anmerkungen, Tipps, wichtige Hinweise, Warnungen und Beispiel

Anmerkung:

Tipp:

Wichtig:

Warnung:

4. Danksagungen

Kapitel 1. Überblick

1.1. Die FreeBSD-Dokumentationsreihe

1.2. Schnellstart

Kapitel 2. Die Werkzeuge

2.1. Verpflichtende Werkzeuge

2.1.1. Die DTDs und die Entitäten

2.2. Optionale Werkzeuge

2.2.1. Software

Kapitel 3. Die Arbeitskopie

3.1. Die Dokumentation und Manualpages

3.2. Einen Spiegelserver wählen

3.3. Ein Verzeichnis für die Arbeitskopie wählen

3.4. Die Arbeitskopie auschecken

3.5. Die Arbeitskopie aktualisieren

3.6. Änderungen an der Arbeitskopie zurücknehmen

3.7. Eine Differenzdatei erstellen

3.8. Referenzen zu Subversion

Kapitel 4. Dokumentation-Verzeichnisstruktur

4.1. doc/ als höchste Ebene

4.2. Die Verzeichnisse Sprache.Kodierung/

4.3. Dokumentenspezifische Informationen

4.3.1. Das Handbuch

books/handbook/

4.3.1.1. Physikalische Organisation

Anmerkung:

4.3.1.1.1. Makefile

4.3.1.1.2. book.xml

4.3.1.1.3. Verzeichnis/chapter.xml

Wichtig:

Kapitel 5. Die Erzeugung der Zieldokumente

5.1. DocBook in verschiedene Ausgabeformate konvertieren

5.2. Für den Bau der FreeBSD-Dokumentation benötigte Werkzeuge

5.3. Die Makefiles des Dokumentationsbaums verstehen

5.3.1. Unterverzeichnis-Makefiles

5.3.2. Dokument-Makefiles

5.4. make(1)-Includes des FreeBSD Documentation Projects

5.4.1. doc.project.mk

5.4.1.1. Variablen

Anmerkung:

5.4.1.2. Bedingungen

5.4.2. doc.subdir.mk

5.4.2.1. Variablen

5.4.2.2. Targets und Makros

5.4.2.2.1. Vorhandene Targets

5.4.2.3. Weitere Bedingungen

5.4.2.4. Schleifenkonstrukte in make (.for)

Kapitel 6. Die Webseite

6.1. Umgebungsvariablen

Tipp:

6.2. Die Webseiten bauen

Tipp:

Kapitel 7. Die XML-Fibel

7.1. Überblick

Anmerkung:

7.2. Von Elementen, Tags und Attributen

Wichtig:

7.2.1. Was dafür getan werden muss;…

7.3. Die DOCTYPE-Deklaration

7.3.1. Formale Öffentliche Bezeichner

Anmerkung:

7.3.1.1. Die catalog-Dateien

7.3.1.2. Die Variable SGML_CATALOG_FILES

7.3.2. Alternativen zu Formalen Öffentlichen Bezeichnern

7.4. Die Rückkehr zu SGML

7.5. Kommentare

7.5.1. Fingerübungen…

7.6. Entitäten

7.6.1. Allgemeine Entitäten

4.1. `doc/` als höchste Ebene

4.2. Die Verzeichnisse `Sprache.Kodierung/`

`books/handbook/`

4.3.1.1.1. `Makefile`

4.3.1.1.2. `book.xml`

4.3.1.1.3. `Verzeichnis/chapter.xml`

5.3. Die `Makefile`s des Dokumentationsbaums verstehen

5.3.1. Unterverzeichnis-`Makefile`s

5.3.2. Dokument-`Makefile`s

5.4.1. `doc.project.mk`

5.4.2. `doc.subdir.mk`

5.4.2.4. Schleifenkonstrukte in `make (.for)`

7.3.1.1. Die `catalog`-Dateien

7.3.1.2. Die Variable `SGML_CATALOG_FILES`

7.8.1.1. `CDATA` und `RCDATA`

7.8.1.2. `INCLUDE` und `IGNORE`

12.5.4. $FreeBSD$ -Strings

A.1. DocBook-Buch (`book`)