Dokumentationen mit DocBook-XML

Einführung in die Erstellung und Publikation von DocBook-Dokumenten

Lars Trieloff

Versionsgeschichte
Version 1.014. November 2002LT

Erste Vorstellung des Dokuments im Hasso-Plattner-Institut für Softwaresystemtechnik

Version 1.105. Juni 2003LT

Hinzufügen des Hinweises auf DocMan und Beheben eines Fehlers, auf den ich von Jörg Schnur aufmerksam gemacht wurde.

Zusammenfassung

Dieses Buch behandelt die Erstellung von DocBook-Dokumenten sowie die Umwandlung von DocBook in publikationsfähige Ausgabeformate.

DocBook. 

Bei DocBook handelt es sich um eine XML/SGML-Sprache, die besonders geeignet ist, um technische Dokumentationen, aber auch andere Dokumente zu erstellen. DocBook ist frei, plattformunabhängig und leicht zu erlernen. Dokumente, die mit DocBook erstellt wurden, können leicht in viele Ausgabeformate umgewandelt werden.


Inhaltsverzeichnis

Vorwort
Hinweis in eigener Sache
1. Einführung in strukturierte Daten, XML und DocBook
Was ist DocBook?
Motivation - Warum DocBook?
Die Historie von DocBook
HaL & O'Reilly
Davenport
OASIS
Einführung in XML
XML-Wohlgeformtheit
Elemente
XML-Attribute
Erweiterte XML-Bestandteile
Kommentare
XML-Gültigkeit
Einbindung von DTDs
XML-Namespaces
XML-Transformationen
Modularisierung von XML-Dokumenten
Modularisierung mit externen Entitäten
Modularisierung über XInclude
Software für DocBook
XML-Parser
Apache Xerces-J
LibXML2
Microsoft MSXML
DocBook-Editoren
Emacs mit PSGML
jEdit mit XML-Plugin
XMLmind XXE XML Editor
Morphon XML-Editor
epcEdit
Corel XMetaL
Altova XMLSpy
Oxygen XML editor
Topology Collaborative Markup Editor
Transformationswerkzeuge
MSXML
LibXSLT
Apache Xalan
Michael Kay's Saxon
Formatting Objects-Prozessoren
PassiveTeX
Apache FOP
RenderX XEP
jFor
XMLmind FO Converter
Workflow-Tools
xmlto
e-novative DocBook environment
DocMan
2. Erstellung von DocBook-Dokumenten
Dokumenttypen
Erstellung eines Buches
Erstellung eines Artikels
Erstellung einer Sammlung
Dokumentteile
Widmung
Navigationskomponenten
Inhaltsverzeichnisse
Ressourcenverzeichnisse
Stichwortverzeichnisse
Komponenten
Vorworte, Kapitel und Anhänge
Erstellung eines Literaturverzeichnisses
Abschnitte
Typische Absatzelemente
Absätze
Listen
Angestrichene Listen
Geordnete Listen
Unterteilte Listen
Variablenlisten
Anmerkungen
Beispiele und Abbildungen
Beispiele
Grafiken und Medien
Abbildungen
Tabellen
Der Tabellenkörper
Verbinden von Zeilen und Spalten
Ausrichtung von Inhalten und Formatierung von Tabellen
Fragen und Antworten
Weitere Absatzelemente
Typische Inline-Elemente
Fußnoten
Referenzen
Texthervorhebungen
Metainformationen
Software-spezifische Elemente
Programmcode
Benutzerschnittstellen
Programmierkonstrukte
Betriebssysteme
Profilieren von DocBook: Teil 1
3. Ausgabe von DocBook-Dokumenten in verschiedene Ausgabeformate
Ausgabeformate
Verarbeitung von XInclude
Auflösung von XInclude mit xmllint
Auflösung von XInclude mit Java-Programmen
HTML
XHTML
Windows Hilfe
Java Hilfe
PDA-optimierte Inhalte
iSilo
Plucker
Zum Ausdrucken
Profilieren von DocBook: Teil II
4. DocBook für Dokumentationen und Anderes
DocBook ganz einfach
Webseiten erstellen mit DocBook
Definition der Navigationsstruktur
Erstellung der Seiten
Umwandlung in HTML
Präsentationen erstellen mit DocBook
Ausgabeformate für Präsentationen
Formeln einbinden in DocBook
MathML
Weitere Module
DocBook anpassen und erweitern
DTD anpassen und erweitern
XSL-Stylesheets anpassen und erweitern
Glossar
Stichwortverzeichnis
Bibliographie

Abbildungsverzeichnis

1.1. Screenshot von jEdit
1.2. Screenshot von XXE Standard Edition
1.3. Screenshot von Morphon
1.4. Screenshot von epcEdit
1.5. Screenshot von XMetaL 3.0
1.6. Screenshot von XMLSpy
1.7. Screenshot von Oxygen
1.8. Screenshot vom Collaborative Markup Editor
1.9. Screenshot von DocMan
2.1. Die Titelseite von DocBook: The Definite Guide
3.1. Verarbeitungsmöglichkeiten von DocBook

Tabellenverzeichnis

1.1. Übersicht über grundlegende XML-Entitäten
1.2. Umlaute in der DocBook-DTD
2.1. DNS-Tabelle
2.2. DNS-Tabelle
2.3. DNS-Tabelle

Beispiele

1.1. Ein XML-Element
1.2. Ein leeres XML-Element
1.3. Hallo Welt als XML-Dokument
1.4. Unzulässige Überlappung von Elementen
1.5. Zulässige Schachtelung von Elementen
1.6. Elemente mit Attributen
1.7. XML-Dokumentenkopf mit Verarbeitungsanweisungen
1.8. Externe Entities
1.9. Kommentare in XML
1.10. DTD-Deklaration für XHTML 1.0
1.11. Verkürzte DTD-Deklaration
1.12. Deklaration externer Entitäten
1.13. Namespace-Deklaration bei XHTML 1.0
1.14. XHTML 1.0 & MathML mit Namespace-Prefix
1.15. Ein modularisiertes XML-Dokument
1.16. Registrierung des XInclude-Namespaces
1.17. Einbindung externer Dateien
1.18. Benutzung von xmlto
1.19. Installation von eDE
2.1. Ein sehr kurzes Buch
2.2. Ein etwas längeres Buch
2.3. Ein sehr kurzer Artikel
2.4. Eine Sammlung zweier Bücher
2.5. Inhaltsverzeichnis für ein Kapitel
2.6. Ein explizites Tabellenverzeichnis
2.7. Ein Stichwortverzeichnis mit Einleitung
2.8. Markieren von Stichworten
2.9. Ein Kapitel mit eigenem Inhaltsverzeichnis
2.10. Ein Literaturverzeichnis mit rohen Einträgen
2.11. Ein Literaturverzeichnis mit vorgekochten Einträgen
2.12. explizite Schichtung von Abschnitten
2.13. implizite Schichtung von Abschnitten
2.14. Ein ganz gewöhnlicher Absatz
2.15. formalpara und simpara im Einsatz
2.16. Einfache Listen in allen Variationen
2.17. Angestrichene Liste
2.18. Geordnete Liste
2.19. Die Beneluxländer als unterteilte Liste
2.20. Variablenliste
2.21. Verschiedene Beispiele für Anmerkungen
2.22. Ein beispielhaftes Beispiel
2.23. Hallo Welt in HTML
2.24. Medien in verschiedenen Formaten
2.25. Abbildungen in der Praxis
2.26. Eine einfache Tabelle
2.27. Zeilenübergreifende Verbindung
2.28. Spaltenübergreifende Verbindungen
2.29. Ein kurzes Philosophisches FAQ
2.30. ein kurzes Zitat
2.31. Notiz eines Vorgangs
2.32. Fußnoten und Referenzen
2.33. Referenz auf einen Abschnitt
2.34. Verweis auf eine URL
2.35. Das Programm Hello World
2.36. Ein etwas längeres Programm
2.37. Und eine kurze Erklärung
2.38. Der Befehl cd
2.39. Ein Verzeichnisinhalt anzeigen
2.40. Einige GUI-Befehle
2.41. Profilierung eines Absatzes
3.1. Installation der Docbook-Extensions für Saxon
3.2. Auflösung von XInclude mit xmllint
3.3. Auflösung von XInclude mit XInclude Engine
3.4. Umwandlung von DocBook in HTML mit Saxon
3.5. Umwandlung von DocBook in XHTML mit Saxon
3.6. Umwandlung von Docbook in Windows Hilfe
3.7. Umwandlung von DocBook in Java Hilfe mit Saxon
3.8. Generierung von XSL:FO mit Saxon
3.9. Erstellung von PDF mit FOP
3.10. Erstellung von RTF mit XFC
3.11. Profilierung vom Saxon
4.1. Ein Simplified DocBook-Dokument
4.2. Ein Website-Layout
4.3. Eine einzelne Webseite
4.4. Erzeugung einer Website
4.5. Eine kurze Präsentation
4.6. Slides in PDF wandeln
4.7. Slides in HTML wandeln
4.8. Grafische Formeln in DocBook
4.9. XSL-Customization-Layer für XSL:FO

Gleichungen

4.1. Fermats Letzter Satz