DocBook

(Auszug aus "XML in a Nutshell" von Elliotte Rusty Harold & W. Scott Means)

DocBook ist eine SGML-Anwendung, die für neue Dokumente, nicht für alte entworfen wurde. Sie ist besonders bei Computer-Dokumentationen gebräuchlich. Verschiedene O'Reilly-Bücher wurden in DocBook geschrieben, einschließlich Norm Walshs und Leonard Muellners DocBook: The Definitive Guide. Es sind keine besonderen Werkzeuge notwendig, um Dokumente in diesem Format zu schreiben. Ein Großteil des Texts des Linux Documentation Projects (LDP) ist in DocBook geschrieben. Die aktuelle Version von DocBook, 4.3, gibt es sowohl als SGML- als auch als XML-Anwendung (Anmerkung der data2type-Redaktion: mittlerweile gibt es DocBook 5.0, Stand 2010). Das folgendes Code-Beispiel zeigt ein einfaches DocBook-XML-Dokument, das auf diesem Werk, "XML in a Nutshell", aufbaut. Wir brauchen wohl nicht zu betonen, dass die komplette Version dieses Dokuments viel länger wäre.

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "docbook/docbookx.dtd">
<book>
  <title>XML in a Nutshell</title>
  <bookinfo>
    <author>
      <firstname>Elliotte Rusty</firstname>
      <surname>Harold</surname>
    </author>
    <author>
      <firstname>W. Scott</firstname>
      <surname>Means</surname>
    </author>
  </bookinfo>

  <toc>
    <tocchap><tocentry>Einführung in XML</tocentry></tocchap>
    <tocchap><tocentry>XML als Dokumentformat</tocentry></tocchap>
    <tocchap><tocentry>XML im Web</tocentry></tocchap>
  </toc>

  <chapter>
    <title>Einführung in XML</title>
    <para></para>
  </chapter>

  <chapter>
    <title>XML als Dokumentformat</title>
    <para>XML ist vor allen Dingen ein Dokumentformat. Es war immer für Webseiten, Bücher, wissenschaftliche Artikel, Gedichte, Kurzgeschichten, Referenzhandbücher, Anleitungen, Lehrbücher, Plädoyers, Verträge, Gebrauchsanweisungen und andere Dokumente gedacht, die von Menschen gelesen werden. Sein Einsatz als Syntax für Computerdaten in Anwendungen wie Bestellabwicklung, Objektserialisierung, Datenbanken sowie elektronischen Datenaustauschsystemen ist eigentlich nur ein glücklicher Zufall.</para>

    <sect1>
      <title>Das Vermächtnis von SGML</title>
      <para></para>
    </sect1>

    <sect1>
      <title>TEI</title>
      <para></para>
    </sect1>

    <sect1>
      <title>DocBook</title>
      <para><ulink url="http://www.docbook.org/">DocBook</ulink> ist eine SGML-Anwendung, die für neue Dokumente, jedoch nicht für alte entworfen wurde. Es ist besonders bei Computer-Dokumentationen gebräuchlich. Verschiedene O'Reilly-Bücher wurden in DocBook geschrieben, einschließlich <citation>Norm Walshs and Leonard Muellners <title>DocBook: The Definitive Guide</title></citation>. Ein Großteil des Texts des <ulink url="http://www.linuxdoc.org/">Linux Documentation Projects (LDP)</ulink> wurde in DocBook geschrieben.</para>
    </sect1>

  </chapter>

  <chapter>
    <title>XML im Web</title>
    <para></para>
  </chapter>

  <index>
    <indexentry>
      <primaryie>SGML, 8, 89</primaryie>
    </indexentry>
    <indexentry>
      <primaryie>DocBook, 95-98</primaryie>
    </indexentry>
    <indexentry>
      <primaryie>TEI (Text Encoding Initiative), 92-95</primaryie>
    </indexentry>
    <indexentry>
      <primaryie>Text Encoding Initiative</primaryie>
      <seeie>TEI</seeie>
    </indexentry>
  </index>

</book>

Code-Beispiel: Ein DocBook-Dokument

DocBook bietet technischen Autoren viele Vorteile. Vor allem ist es offen, nicht proprietär, und kann mit jedem beliebigen Text-Editor erstellt werden. Es wäre sicher auch ein bisschen komisch, wenn man eine Open Source-Dokumentation für Open Source-Software in einem geschlossenen und proprietären Werkzeug wie beispielweise Microsoft Word schreiben würde (was nicht heißt, dass es auch dies nicht schon gab). Falls Ihre Dokumente in DocBook verfasst sind, sind sie nicht an bestimmte Plattformen, Hersteller oder Anwendungssoftware gebunden. Sie können auf jede vorstellbare Umgebung portiert werden.

DocBook lässt sich nicht nur theoretisch mit normalen Text-Editoren bearbeiten; es ist so einfach, dass seine Bearbeitung sogar ausgesprochen praktisch ist. Einer von uns (Harold) hat ein komplettes 1.200-Seiten-Buch mit JEdit per Hand in DocBook geschrieben (Processing XML with Java, Addison Wesley, 2002). Natürlich gibt es, falls Sie doch gern etwas Unterstützung hätten, zahlreiche freie Werkzeuge einschließlich eines Emacs-Major-Mode. Außerdem ist DocBook wie viele gute XML-Anwendungen modular. Sie können die Teile benutzen, die Sie brauchen, und den Rest ignorieren. Wenn Sie Tabellen benötigen, gibt es ein sehr vollständiges Tabellenmodul. Falls Sie keine Tabellen brauchen, müssen Sie dieses Modul nicht kennen oder einsetzen. Andere Module sind für die verschiedenen Entity-Sätze und Gleichungen zuständig.

DocBook ist ein Format zum Erstellen von Dokumenten, kein Format für fertige Präsentationen. Bevor ein DocBook-Dokument gelesen wird, wird es in eines von mehreren möglichen Formaten konvertiert. Dazu zählen:

  • HTML
  • XSL Formatting Objects
  • Rich Text Format (RTF)
  • TEX

Falls Sie beispielsweise eine qualitativ hochwertige, gedruckte Dokumentation für ein Programm haben wollen, könnten Sie ein DocBook-Dokument nach TEX konvertieren, die TEX-Datei dann mit Hilfe der üblichen TEX-Werkzeuge nach DVI und/oder PostScript konvertieren und diese Datei dann ausdrucken. Wenn Sie das Dokument lediglich auf Ihrem Computer lesen wollen, könnten Sie es nach HTML konvertieren und in Ihren Webbrowser laden. Für andere Aufgaben nehmen Sie etwas anderes. Mit DocBook sind diese ganzen Formate für Sie im Prinzip kostenlos. Es ist sehr einfach, mehrere Dokumente in verschiedenen Formaten aus einem einzigen DocBook-Quelldokument zu erzeugen. Tatsächlich beschränkt sich dieser Vorteil nicht nur auf DocBook. Die meisten gut durchdachten XML-Eingabeformate lassen sich ebenso einfach in anderen Formaten veröffentlichen.

  

<< zurück vor >>

 

 

 

Tipp der data2type-Redaktion:
Zum Thema XML bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

  


Copyright © 2005 O'Reilly Verlag GmbH & Co. KG
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "XML in a Nutshell" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

O’Reilly Verlag GmbH & Co. KG, Balthasarstraße 81, 50670 Köln, kommentar(at)oreilly.de