Jupyterbook

Jupyterbook#

Die Website jbusse.de/dtt2023 experimentiert für einen Vortrag auf dem DTT 2023 mit der Open Source X-Media-Publishing Technologie Jupyterbook, die erst seit Version v0.08 vom Sept 2020 in der hier eingesetzten Implementierung verfügbar ist.

Herausforderungen dieses Experimentes:

  • Die Dateien in Jupyterbook verwenden den Commonmark-Markdowndialekt MyST-Markdown. Der Autor dieses Textes editiert solche Texte in einem Plaintext-Editor unter Linux. Die Herausgeber des Tagungsbandes erbitten allerdings eine Datei gemäß einem Template in MS Word. Mit welchen Tools gelingt die Übersetzung so, dass die händische Nacharbeit mit akzeptablem Aufwand und wenig Fehlern realisiert werden kann?

  • Ein Text in einem Tagungsband ist ein Printtext. Ein Jupyterbook ist eine Menge von Markdown-Dateien, die in eine Website übersetzt werden. Nicht nur das Format, sondern auch die Publikations-Technik - und tatsächlich die gesamte Dokumentations-Philosophie - könnten unterschiedlicher nicht sein.

  • Die Bezüge zwischen Terminologie und Ontologie sind fachlich anspruchsvoll. Ein Printtext in einem Tagungsband kann die Komplexität der Themen höchstens andeuten. Wenn es bei Andeutungen nicht bleiben soll, benötigen wir Platz für Vertiefungen, die den erlaubten Seitenumfang im Druck deutlich sprengen.

  • Ein konventioneller Printtext verweist typischerweise auf Literatur, die in einem Literaturverzeichnis genauer aufgeführt wird. Texte im Web enthalten z.T. sehr viele Links, die das Literaturverzeichnis sehr aufblähen würden. Auch sind einige Links nicht in engerem Sinn “zitierfähig”, andere nicht wirklich formal zitierbedürftig.

  • Aus terminologischer sicht interessant: Manche Hyperlinks in Online-Dokumenten haben gar nicht die Aufgabe, auf Webseiten i.S. von Dokumenten zu verweisen (die man ggf. zitieren will). Statt dessen wollen manche Hyperlinks - oft z.B. solche auf Wikipedia - nur als ein Hinweis verstanden werden, dass hier ein bestimmter Terminus als ein Fachwort in einem bestimmten Zusammenhang zu verstehen ist.

Wir gehen diese Herausforderungen so an:

  • Die Übersetzung von Markdown nach MS Word geschieht über die Schritte Markdown -> html -> LibreOffice -> MS Word. Der genaue Ablauf ist beschrieben unter Build.

  • Der Printtext im Tagungsband ist eine knappe Zusammenfassung der wesentlichen Inhalte. Parallel zum Printtext wird online eine erweiterte Fassung der Inhalte vorgehalten und bei Bedarf aktualisiert. Die Online-Seite enthält inbesondere ein erweitertes Angebot zu einzelnen Vertiefungsthemen.

  • Verweise auf Printtexte und als Website referenzierte Websites werden in einem konventionellen Verzeichnis vorgehalten, das allerdings Quellen-Verzeichnis genannt wird.

  • Verweise auf Fachbegriffe werden über ein Glossar realisiert.

  • Ursprünglich waren im Literaturverzeichnis alle Quellen konventionell aufgeführt - mit der Folge, dass dieses 3 Seiten lang wurde. Lösung jetzt: Im Quellenverzeichnis der Druckfassung sind nur wiss. Aufsaätze angeführt, für alle anderen Nachweise ist die Web-Fassung geeigneter.