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

  • Ticketsysteme sind lebende Wesen

    29.03.2020

    Hier zunächst wieder eine Triggerwarnung: Dieser Artikel wird meine Meinung abbilden. es kann sein, dass sie dem einen oder anderen nicht gefällt - das ist mir aber egal. Und wenn hier irgendwelche Schneeflocken mitlesen, dann sind die selber schuld.

    Weiterlesen...

Neueste Artikel

  • Weitere Experimente mit dem Clifford-Attractor

    Ich berichtete hier bereits über Experimente mit dem Clifford-Attractor, allerdings war ich noch Experimente unter geringfügig geänderten Parametern schuldig...

    Weiterlesen
  • Neues Feature in meinem Static Site Generator: externe URLs

    Es wurde wieder einmal Zeit für ein neues Feature in meinem Static Site Generator mittels dessen ich ja auch meine Heimatseite im Zwischennetz gestalte und verwalte...

    Weiterlesen
  • Eine Bestandsaufnahme

    Es kamen mehrere Faktoren zusammen: die Tatsache, dass ich nicht mehr ganz so kürzlich die 50 überschritten habe hatte ebenso darauf Einfluss wie das heutige trübe Wetter und auch der Fakt, dass ich bereits beinahe alle Wochenendpflichten erledigt habe. Der letzte Stein des Anstoßes war dann aber, dass sich heute zum 125. Mal der Geburtstag von Erich Fromm jährt.

    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.