Wider die Topics: DocBook

(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)

DocBook ist eine Auszeichnungssprache für Dokumente aus dem technischen Umfeld. Die DTDs, die sowohl für XML als auch für SGML vorliegen, bilden eine Buchstruktur ab, wie sie für Handbücher in der Technischen Dokumentation und für Fachbücher benötigt werden. Der Schwerpunkt der semantischen Auszeichnungen liegt auf Software- und Hardware-Dokumentation.

Die Entwicklung von DocBook begann im Jahr 1991 als ein gemeinsames Projekt von HaL Computer Systems und dem Verlag O'Reilly & Associates. Von 1994 bis 1998 zeichnete die Davenport Group für die Entwicklung von DocBook verantwortlich. Ab 1998 schließlich wurde DocBook unter die Schirmherrschaft von OASIS gestellt, dessen DocBook Technical Committee seitdem DocBook betreut und weiterentwickelt.

Für DocBook stehen DSSSL- und XSLT-Stylesheets zur Verfügung, um Ausgabemedien wie PDF oder HTML erzeugen zu können. Die Stylesheets können über einen ausgefeilten Anpassungsmechanismus modifiziert werden, um die Stylesheets gemäß den eigenen Anforderungen verändern zu können.

Alle Elemente von DocBook sind in einer einzigen DTD definiert. Dabei werden die Elemente zur Auszeichnung folgender Informationen verwendet:

  • Dokumentenstruktur: Für die Auszeichnung der Dokumentenstruktur beziehungsweise der Dokumentenhierarchie stehen in DocBook ca. 50 Elemente zur Verfügung. Mit Elementen wie <book>, <preface>, <chapter> usw. kann eine Hierarchie für ein Buch aufgebaut werden.
  • Meta-Daten: Es stehen in DocBook über 100 Elemente zur Auszeichnung von Meta-Daten zur Verfügung. Das entspricht ca. einem Drittel aller DocBook-Elemente.
  • Informationen: Ca. 150 Elemente können verwendet werden, um Informationen auszuzeichnen. Dazu gehören Elemente für Absätze, Listen, Tabellen usw. und Elemente für die semantische Auszeichnung von Inhalten. Die thematischen Bereiche für die semantische Auszeichnungen umfassen das User Interface, die Programmierung, verschiedene Betriebssysteme und die Hardware.

Bei der Strukturierung der DocBook-DTD wurde darauf geachtet, dass Elementdefinitionen sowohl leicht hinzugefügt als auch gelöscht werden können. Soll die DocBook-DTD angepasst werden, so wird zunächst eine neue DTD angelegt, der so genannte Driver File. In dieser DTD können neue Elemente definiert und bestehende Parameter-Entitäten überschrieben werden. Die Anpassung erfolgt dadurch, dass der Driver File in die originale DocBook-DTD importiert wird.

Durch die Anpassung der DocBook-DTD können Teilmengen definiert werden, das heißt, die Anzahl der Elemente kann auf einen Anwendungsfall hin beschränkt werden. So wurde bei Sun Microsystems eine solche Teilmenge definiert, dort als SolBook bezeichnet, und als DTD für die Technische Dokumentation verwendet. Eine weitere Teilmenge ist Simplified DocBook, dessen DTD gegenüber der originalen DocBook-DTD nur 100 anstatt der 350 verfügbaren Elemente enthält.

Die große Anzahl der Elemente bei DocBook ist unter anderem auch darauf zurückzuführen, dass bei der Entwicklung von DocBook oftmals keine Einigung zwischen den beteiligten Organisationen erzielt werden konnte, welche Elemente für bestimmte Auszeichnungen definiert werden sollten. Zum Beispiel konnte keine Übereinkunft darüber getroffen werden, ob eine Zusammenfassung (abstract) zu den Meta-Daten eines Buchs gehört oder schon zum eigentlichen Dokumentenkörper. Das Ergebnis in solchen Fällen war häufig, dass Elemente für beide Varianten definiert wurden.

Die Schwierigkeiten bei der Entwicklung der DocBook-DTD spiegeln die Probleme wider, wie sie bei der Entwicklung von monolithischen DTDs auftreten. Wenn sehr viele Gruppen mit unterschiedlichen Anforderungen mit der DTD arbeiten wollen/müssen, wird es umso schwieriger, alle diese Anforderungen unter einen Hut zu bekommen. Selbstredend erweisen sich Erweiterungen in diesem Fall ebenfalls als ein äußerst hürdenreicher Weg.

DocBook und die Bücher

Ziel von DocBook war es, eine DTD zu entwickeln, mit der vor allem Bücher für die Technische Dokumentation erstellt werden können. Bei DocBook wird das Handbuch als das zentrale Medium für die Vermittlung von technischen Informationen betrachtet. Mit der Schaffung einer DTD, die die Produktion eines Buchs ermöglicht, werden implizit Annahmen darüber getroffen, wie Inhalte zu erstellen sind, nämlich in einer für ein Buch passenden Form.

Dies ist durchaus wünschenswert, solange wirklich nur ein Buch erstellt werden soll. Allerdings stößt man unweigerlich an seine Grenzen, wenn die Inhalte auch für andere Ausgabemedien verwendet werden sollen.

Die zu DocBook entwickelten Stylesheets ermöglichen die Produktion von Ausgabemedien wie Microsoft HTML Help, JavaHelp oder sogar Webseiten. Jedoch ist es in den wenigsten Fällen sinnvoll, eine Buchstruktur unverändert in ein Ausgabemedium wie zum Beispiel in eine Microsoft HTML Help zu überführen. Hier ist dann oft ein Eingriff mit XPath erforderlich, um die Elemente herauszufiltern, deren Inhalte für die Ausgabemedien bereitgestellt werden sollen. Selbst dann ist zu berücksichtigen, dass die Inhalte für ein Buch geschrieben wurden, also stilistisch und vom Kontext her nicht so ohne Weiteres für ein anderes Medium übernommen werden können.

Da bei DocBook die Erstellung eines einzelnen Buchs das Ziel ist, wurden bei DocBook auch so gut wie keine Mechanismen zur Wiederverwendung von Inhalten entwickelt. Allein schon das Abspeichern von einzelnen Kapiteln in einzelnen Dateien erfordert bei DocBook einen hohen Aufwand. Nachdem ein Buch fertiggestellt ist, wird es gedruckt und der Lebenszyklus des Buchs ist damit beendet. So zumindest ist es bei DocBook vorgesehen. Dieser Lebenszyklus für Informationen ist in der Technischen Dokumentation kaum anwendbar.

Somit ist DocBook für die Technische Dokumentation nur im eingeschränkten Maße einsetzbar. Denn Technische Dokumentation bedeutet nicht nur das Schreiben von Handbüchern, sondern vor allem die Bereitstellung von Informationen in unterschiedlichen Medien. Zudem müssen häufig die verfügbaren Informationen für unterschiedliche Zielgruppen zur Verfügung gestellt werden.

Eine DTD, der eine Buchstruktur zugrunde liegt, kann diesen Anforderungen nicht genügen. Ein Buch stellt nur einen Aspekt in der reichhaltigen Palette der Informationsprodukte in der Technischen Dokumentation dar. Ein Buch und die Informationen in einem Buch bieten nur eine der vielfältigen Möglichkeiten, wie ein Nutzer Informationen aufnehmen kann. Wie die Entwicklung von DITA zeigt, muss mehr und mehr der Tatsache Rechnung getragen werden, dass Bücher ihren Stellenwert in der Technischen Dokumentation verlieren.

DocBook im Vergleich mit DITA

Gerade in der Anfangszeit von DITA wurden zahlreiche Vergleiche bemüht, um zu zeigen, dass entweder DITA oder DocBook der „bessere“ Standard ist. Tatsächlich ist mit solchen Vergleichen nicht viel gewonnen. Vielmehr kommt es darauf an zu untersuchen, ob der jeweilige Standard für das angestrebte Anwendungsgebiet passt. Will ein Technischer Redakteur beispielsweise ein Fachbuch für den O'Reilly Verlag schreiben, so ist er mit DocBook mit Sicherheit besser bedient als mit DITA.

Die folgende Tabelle listet einige Merkmale auf, die bei der Evaluierung der Standards herangezogen werden können.

DocBook DITA
Paradigma Buch Topic
DTD/DTDs monolithisch modular
Erweiterung von DTDs über Driver File über Spezialisierung
Mögliche Informationsprodukte Buch (primär), Online-Hilfen Buch, Online-Hilfen, Webseiten, Wikis
Wiederverwendung von Informationen nicht vorgesehen über Maps und conref-Mechanismus
Filtern konditionaler Elemente möglich möglich
Meta-Daten für das gesamte Buch für einzelne Topics; für Maps
Stylesheets für praktisch alle Ausgabemedien verfügbar für praktisch alle Ausgabemedien verfügbar
Anpassung der Stylesheets für alle Stylesheets möglich; sehr gut dokumentiert für alle Stylesheets möglich
Dokumentation sehr ausführlich noch immer in der Entwicklung

Tabelle: Vergleich von DITA mit DocBook

DocBook kann im Gegensatz zu DITA eine über 15-jährige Entwicklungsgeschichte aufweisen. Das wirkt sich vor allem darin aus, dass die bei DocBook zur Verfügung stehende Dokumentation sehr umfangreich und ausführlich ist. Auch sind bei DocBook die Stylesheets und deren Anpassungsmechanismen inzwischen sehr ausgereift. Hier befindet sich bei DITA noch sehr viel in der Entwicklung, was sich zum Beispiel bei den Stylesheets zur Produktion von PDF-Dateien bemerkbar macht. Daher kann beim Einsatz von DITA im Gegensatz zu DocBook manchmal auch Pionierarbeit erforderlich sein.

  

<< zurück vor >>

 

 

 

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

Copyright © 2008 XLcontent Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DITA - Der neue Standard für Technische Dokumentation" 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.

XLcontent Verlag, Pflegerstraße 40, 81247 München