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 Github Repositories Gitlab Repositories Mastodon Über mich home xmpp


Vor 5 Jahren hier im Blog

  • Certstream, InfluxDB, Grafana und Netflix

    16.04.2019

    Nachdem ich vor kurzem über mein erstes Spielen mit dem certstream berichtete, habe ich weitere Experimente gemacht und die Daten zur besseren Auswertung in eine InfluxDB gepackt, um sie mit Grafana untersuchen zu können.

    Weiterlesen...

Neueste Artikel

  • Die sQLshell ist nun cloudnative!

    Die sQLshell hat eine weitere Integration erfahren - obwohl ich eigentlich selber nicht viel dazu tun musste: Es existiert ein Projekt/Produkt namens steampipe, dessen Slogan ist select * from cloud; - Im Prinzip eine Wrapperschicht um diverse (laut Eigenwerbung mehr als 140) (cloud) data sources.

    Weiterlesen...
  • LinkCollections 2024 III

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

    Weiterlesen...
  • Funktionen mit mehreren Rückgabewerten in Java

    Da ich seit nunmehr einem Jahr bei meinem neeun Arbeitgeber beschäftigt und damit seit ungefähr derselben Zeit für Geld mit Python arbeite, haben sich gewisse Antipathien gegenüber Python vertieft (ich kann mit typlosen Sprachen einfach nicht umgehen) - aber auch einige meiner Gründe, Python zu lieben sind ebenso stärker geworden. Einer davon ist der Fakt, dass eine Methode in Python mehr als einen Wert zurückgeben kann.

    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, muß 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 GitHub-Repositories findet man hier - meine öffentlichen GitLab-Repositories finden sich dagegen hier.