Docbook Template

vorhergehende Artikel in: Markup
27.04.2014

Da ich immer wieder mal Dokumentationen mittels Docbook verfasse, jedoch nicht oft genug, damit ich mir merke, wies geht - habe ich mir ein Template geschaffen, das zum einen die korrekte Projektstruktur vorgibt und zum anderen Beispiele für verschiedene Konstrukte wie Tabellen, Querverweise, Abbildungen enthält.

Das Template enthält eine komplette Projektstruktur einschließlich eines Build-Skriptes. Das Projekt erzeugt sowohl HTML- wie auch PDF-Versionen. Das Projekt ist angelegt als Set - also als Menge mehrerer Bücher oder Buchreihe. Es enthält ein Buch.

Das Template zeigt exemplarisch

  • Aufteilen eines Docbook-Projektes in verschiedene Dateien
  • Abbildungen
  • Tabellen
  • Querverweise (nicht nur auf Abschnitte, sondern auch Tabellen, Abbildungen, Beispiele,...)
  • Callouts und Programm-Listings

Voraussetzungen

Voraussetzungen sind vier Softwarepakete:
Docbook Stylesheets
erlauben die Transformation von Docbook-XML-Dateien in andere Formate
XSLT-Prozessor Saxon
Führt die Transformation von Docbook-XML-Dateien in andere Formate durch
Formatting Objects Prozessor FOP
PDF-Erzeugung läuft über ein Zwischenformat: fo - FOP transformiert dieses Format in ein PDF
ANT
Dieses Werkzeug dient der Erstellung der Ausgabedokumente - es wird ohne weitere Parameter in dem Verzeichnis ausgeführt, das auch die Datei build.xml enthält

Konfiguration

Zur Inbetriebnahme des Projektes genügt es, eine Konfigurationsdatei namens build.properties in das Verzeichnis zu legen, welches auch die Datei build.xml enthält. Diese Datei muß folgenden Inhalt aufweisen:
docbook-xsl=<Pfad zu den Stylesheets>
saxon.dir=<Verzeichnis, das die Datei saxon9he.jar enthält>
fop.executable=<Name des ausführbaren FOP-Programms einschließlich absoluter Pfadangabe>

Aktualisierung vom 27. April 2014

Das Beispielprojekt kann nun auch zur Erzeugung des Formates EPUB benutzt werden. Dadurch haben sich die Voraussetzungen ein wenig geändert: Dazu word zwingend ein XSLT-1.0-Prozessor benötigt, daher: ändert sich die Datei build.properties wie folgt:
docbook-xsl=<Pfad zu den Stylesheets>
saxon1.dir=<Verzeichnis, das die Datei saxon.jar enthält> (saxon bis maximal Version 6.5.5);
saxon2.dir=<Verzeichnis, das die Datei saxon9he.jar enthält>
fop.executable=<Name des ausführbaren FOP-Programms einschließlich absoluter Pfadangabe>
Das Archiv wurde ebenfalls aktualisiert.

Lizenz
docbooktemplate

Alle Artikel rss Wochenübersicht Monatsübersicht Codeberg Repositories Mastodon Über mich home xmpp


Vor 5 Jahren hier im Blog

  • Trojan Source mit SQL und Postgres

    12.11.2021

    Nachdem ich das hochinteressante Paper Trojan Source: Invisible Vulnerabilities gelesen hatte kam ich durch einen Post auf Mastodon (leider nicht öffentlich einsehbar) auf Ideen... auf Ideen...

    Weiterlesen

Neueste Artikel

  • Offscreen Rendering für Moduleworkspaces

    Es ist nicht ganz einfach, eine Hierarchie von Swing-Komponenten offscreen zu rendern. Ich wollte aber genau dies für meine zentrale Komponente moduleworkspace umsetzen, die zum Beispiel die Grundlage für Lösungen wie den Visuellen Abfrageeditor in der sQLshell oder dWb+ darstellt.

    Weiterlesen
  • LinkCollections 2026 XIII

    Nach der letzten losen Zusammenstellung (für mich) interessanter Links aus den Tiefen des Internet von 2026 folgt hier gleich die nächste:

    Weiterlesen
  • sQLshell Version 7.9pre5 build 11394

    Eine neue Version der sQLshell ist verfügbar!

    Weiterlesen

Manche nennen es Blog, manche Web-Seite - ich schreibe hier hin und wieder über meine Erlebnisse, Rückschläge und Erleuchtungen bei meinen Hobbies.

Wer daran teilhaben und eventuell sogar davon profitieren möchte, muss damit leben, daß ich hin und wieder kleine Ausflüge in Bereiche mache, die nichts mit IT, Administration oder Softwareentwicklung zu tun haben.

Ich wünsche allen Lesern viel Spaß und hin und wieder einen kleinen AHA!-Effekt...

PS: Meine öffentlichen Codeberg-Repositories findet man hier.