Dokumentationen mit DocBook

Empfohlene Schulungsdauer: 1 Tag, insgesamt 6 Zeitstunden

Kursziele

DocBook ist ein XML-Standard zur Erstellung von Dokumentationen und setzt keine Programme bestimmter Hersteller voraus. DocBook basiert auf XML und ist dadurch einfach zu erlernen und anzuwenden. Über XSLT und verwandte Technologien können DocBook-Dokumentationen problemlos in beliebige Datenformate, wie HTML- oder PDF-Dokumente konvertiert werden, was eine einfache Aktualisierung unterschiedlicher Dokumente wie Webseiten oder Whitepapers gewährleistet. In diesem Seminar lernen Teilnehmer den grundlegenden Aufbau von DocBook-Dateien und wichtige XML-Tags kennen und erfahren, wie sie eine DocBook-Dokumentation in HTML- und PDF-Dateien transformieren können.

Zielgruppe

Software-Entwickler

Voraussetzungen

Der Kurs ›XML Grundlagen‹ oder vergleichbare Kenntnisse.

Seminarinhalte

Einführung in DocBook und Simplified DocBook
- XML-basierter Standard
- XML-Gerüst jeder DocBook-Datei
- Besonderheiten der aktuellen Version 5.0
- DocBook Editoren (XML-Editoren, OpenOffice)
- XSLT-Prozessoren
- DocBook DTD, DocBook Schema zur Validierung
Top-Level-Strukturen
- Band
- Buch
- Kapitel
- Artikel
- Abschnitt
- Inhaltsverzeichnis
- Index
- Glossar
- Bibliografie
Ausgesuchte XML-Tags
- Meta-Informationen
- Links
- Listen
- Tabellen
- Grafiken: Bitmap und SVG-Grafiken
- Quellcode
- Screenshots
- Fehlermeldungen
- GUI-Elemente
- Fragen und Antworten
- Mathematische Ausdrücke, MathML
DocBook XSL
- XSLT-Skripte zum Umwandeln von DocBook-Dateien
- Stylesheet-Parameter
- Unterstützte Dateiformate
- Generieren von HTML-Dateien, CSS anpassen
- Generieren von PDF-Dateien, Seitenlayout, Bookmarks
- Generieren von HTML Help
Anpassen von DocBook XSL
- Grundsätzlicher Aufbau von DocBook XSL
- Customization Layer
- Ersetzen von Templates
- Neue Templates hinzufügen
Tipps und Tricks
- Unterteilen einer DocBook-Dokumentation in Dateien
- XInclude
- Verlinken compilierbarer Quellcode-Beispiele
- Bedingter Text
- Versionierung von DocBook-Dokumenten