Static Site Generator für Docbook

vorhergehende Artikel in: Markup
15.03.2022

Mein eigener Static Site Generator hat jetzt einen Modus, der es gestattet, die Inhalte nicht nur als HTML-Seiten für die Publikation mittels eines HTTP-Servers zu erzeugen, sondern auch als Docbook zur Erzeugung eines PDF-Dokumentes oder E-Book im Format EPUB.

Für die Umsetzung musste ich relativ große Anstrengungen ins Refactoring des bestehenden Codes investieren, da der bisherige Code an vielen Stellen die Erzeugung von HTML als Zielformat annahm, bzw. voraussetzte. Im Zuge dieser Arbeiten konnte ich den Code dramatisch entflechten und modularisieren.

Ein besonders großes Hindernis war die Tatsache, dass ich in den Inputdateien - den eigentlichen Artikeln - HTML-Markup erlaubte. Bei der Erstellung von HTML-Seiten aus diesen Inputdaten war das kein großes Problem, da ich solches Markup ungeändert als Text betrachten konnte, der im Zielformat automatisch gültig war. Bei Docbook war das etwas anderes: Dieses Format erlaubt/versteht HTML-Markup nicht.

Aus diesem Grund erweiterte ich die normale Pipeline

Input -> XML (Docbook) -> XML (Formatting Objects) -> Zielformat (PDF, EPUB, ...)

und fügte zwischen Docbook und Formatting Objects (FO) einen weiteren Transformationsschritt ein: Diese Transformation geschieht per Extensible Stylesheet Language Transformation und ersetzt HTML-Tags durch ihr entsprechendes Docbook Äquivalent.

Nachdem diese Herausforderung adressiert war, konnte ich an die eigentliche Umsetzung gehen: Die Transformation nach Docbook geschieht so, dass jeder Artikel in ein Docbook-Fragment überführt wird, das eine section darstellt, die dann als Entity in ein Docbook-Dokument eingebunden wird. Dadurch entsteht in der Transformation eine FO-Datei, aus der wiederum die benötigten Zieformate erzeugt werden können.

Interessant war dabei, dass ich auf einen sehr alten Bug stieß, der mich eine Stunde Recherche kostete: Da ich alle übrigen Docbook-Projekte auf Maven als Build-Tool umgestellt hatte, dieses Projekt aber zum Test noch mit Ant und einem externen Apache FOP umsetzte, funktionierte die Einbindung von Bildern als PNG-Dateien nicht. Ursache dafür war eine inkompatible Änderung zwischen den Java-Versionen 9 und 11, die für die seltsamen NullPointerExceptions sorgte. Von den zwei möglichen Lösungsstrategien - Aktualisieren der Apache FOP Version (bei mir eine 0.93) und Downgrading der Java-Version - entschied ich mich für das Downgrading, da ich final natürlich auch hier Maven als Build-Tool zum Einsatz bringen will und Apache FOP nur im Prototyp-Stadium benutzen wollte.

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


Vor 5 Jahren hier im Blog

  • Strange Attractors im Lorenz System

    10.05.2020

    Das Lorenz System kann in einem Jupyter-Notebook interaktiv erkundet werden:

    Weiterlesen...

Neueste Artikel

  • Anpassungen für GraphViz und PlantUML

    Ich habe hier schon verschiedentlich über die Anwendung des PlantUML- oder GraphViz- Formats geschrieben. Beide sind extrem vielseitig - sowohl für eher traditionelle Darstellungen von Graphen oder Entity-Relationship-Diagrammen als auch für zum Beispiel die Dokumentationen von Public Key Infrastrukturen

    Weiterlesen
  • Origami - Inspirationen und Anleitungen

    Videos und Bastelanleitungen - meistenteils Origami

    Weiterlesen
  • SBOMs für alte Java-Projekte

    Ich habe neulich wieder einmal über Software Bill Of Materials oder SBOMs nachgedacht - inspiriert nicht nur, aber auch von meinem $dayjob...

    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.