Um was geht es

DocBook ist ein (XML-)Datenformat speziell für die Erstellung von Publikationen.

Dokumente im DocBook Format besitzen keine Angaben über ihre Darstellung. Die Informationen im Dokument sind aber mit einer Typangabe gekennzeichnet: Ist es ein Titel, ein Kapitel, ein Abschnitt, ein eingebetteter Screenshot, sonst eine Graphik, ein Literaturverzeichnis, etc. Die Anzahl der möglichen Elemente ist ziemlich gross und für den Einsteiger etwas unübersichtlich.

Der Vorteil solch standartisierter Dokumente ist die nachträgliche Verarbeitung. Mittels Generatoren und Style-Sheets ist es nämlich möglich, die verschiedensten Arten von Dokumentationen aus dem einen Ursprungsdokument zu generieren (Single-Source-Documentation). Wenn Sie also eine Hilfsdokumentation schreiben, können Sie ohne Änderungen aus dieser Dokumentation eine HTML-Hilfedatei, Java- oder Windows-Hilfe erzeugen lassen. Weitere Formate sind Postscript, PDF, etc.

Beispieldokument

Ein einfaches Beispiel eines Artikels im DocBook-Format ist der vorhergehende Abschnitt. Er sieht so aus

<?xml version="1.0" encoding="ISO-8859-1"?>
<article lang="de">
   <articleinfo>
      <title>DocBook</title>
      <subtitle>Information, Links</subtitle>
      <date>2005-04-30</date>
      <corpauthor>Tangarena Engineering</corpauthor>
      <abstract>
         <para>
            Dieses Dokument bietet eine Einleitung in DocBook 
            und verweist auf die relevanten Stellen im Web. 
         </para>
      </abstract>
   </articleinfo>
   
   <section>
      <title>Um was geht es</title>
      <para>
         DocBook ist ein (XML-)Datenformat speziell für die Erstellung von Publikationen. 
      </para>
      <para>
         Dokumente im DocBook Format besitzen keine Angaben über ihre Darstellung.
         Die Informationen im Dokument sind aber mit einer Typangabe gekennzeichnet:
         Ist es ein Titel, ein Kapitel, ein Abschnitt, ein eingebetteter Screenshot,
         sonst eine Graphik, ein Literaturverzeichnis, etc. Die Anzahl der möglichen
         Elemente ist ziemlich gross und für den Einsteiger etwas unübersichtlich.
      </para>
      <para>
         Der Vorteil solch standartisierter Dokumente ist die nachträgliche 
         Verarbeitung. Mittels Generatoren und Style-Sheets ist es nämlich 
         möglich, die verschiedensten Arten von Dokumentationen aus dem einen 
         Ursprungsdokument zu generieren (Single-Source-Documentation).
         Wenn Sie also eine Hilfsdokumentation schreiben, können Sie ohne
         Änderungen aus dieser Dokumentation eine HTML-Hilfedatei,
         Java- oder Windows-Hilfe erzeugen lassen. Weiter Formate sind Postscript,
         PDF, etc.               
      </para>
   </section>
</article>
          

Einführungen

Ein paar einführende Artikel zum Thema DocBook:

Editoren

Als DocBook Editor eignet sich jeder TextEditor. Man schreibt ja nichts anderes als XML-formatierte Textdokumente. Natürlich gibt es auch einige speziellere Editoren und auch mit OpenOffice soll man DocBook-Dokumente erstellen können. Ein interessantes Open Source Projekt ist das XML-Editor-Plugin für Eclipse VEX, welches die DocBook-Elemente kennt.

Generatoren

DocBook Dateien werden von zwei Arten von Generatoren in publizierbare Dokumente umgeformt. Die eine Gruppe von Generatoren (Jade) verwendet DSSSL-StyleSheets, die andere Gruppe (XSL-Transformation) verwendet XSL-StyleSheets.

Ein sehr praktisches Werkzeug ist der XMLMind FO Converter von XMLMind. Das für den privaten Gebrauch (Workstation) freie Tool erlaubt die Erzeugung von HTML, PDF und auch RTF über ein graphische Benutzeroberfläche. Es werden alle benötigten Werkzeuge in einem Packet mitgeliefert.

Für einen Java-Entwickler eignet sich vorallem die XSLT-Generation, kann dann doch mittels eines einfachen ANT-Targets die Dokumentation erzeugt werden. Das folgende Ant-Script zeigt eine Erzeugung einer HTML-Datei:

 
<!-- Create a tutorial.html document -->     
<target name="html">
   <xslt 
      in="${basedir}/tutorial.xml" 
      out="${basedir}/tutorial.html"
      style="c;/prog/docbook/docbook-xsl/html/docbook.xsl">
      <outputproperty name="method" value="xml"/>
      <outputproperty name="standalone" value="yes"/>
      <outputproperty name="encoding" value="iso8859_1"/>
      <outputproperty name="indent" value="yes"/>  
   </xslt>
</target>
            

Downloads

Folgende Links sind für die Erstellung von Dokumenten von Nutzern

Wichtige Webseiten

Weitere Informationen finden Sie auf diesen spezialisierten Webseiten: