Dokumentation wird Open Source

vorhergehende Artikel in: dWb+ OpenSource Markup
04.11.2021

Ich habe im Zuge der Aktualisierung der Dokumentation für meinen Static Site Generator dessen Dokumentation wie auch die für dWb+ und Aviator unter der bekannten Lizenz als Open Source zur Verfügung gestellt.

Für die sQLshell habe ich mich bei Projektbeginn für JavaHelp als Dokumentationsmedium entschieden - das wird sich auch nicht ändern.

Danach stieß ich auf DocBook und habe seither größere Dokumentationen immer damit erstellt. Ich bin zwar erfreut über die Vielseitigkeit von Markdown und werde auch wo immer es geboten ist weiterhin TeX einsetzen - aber für die Erstellung größerer Dokumentationen ist nach wie vor DocBook mein Mittel der Wahl.

Daher überlegte ich neulich (und wegen der Tatsache, dass mir die Erstellung der Dokumentationen aus den DocBook-Quellen mittels ANT schon immer ein wenig sperrig und unhandlich erschien), ob es nicht ein entsprechendes Maven-Plugin gäbe, das diese Aufgabe eventuell mit weniger Schmerzen erledigen könnte.

Nach kurzer Suche stieß ich auf docbkx, das alle meine Erwartungen übertraf.

Dadurch wurde mein Entschluss bestärkt, die bestehenden Dokumentationen für meinen Static Site Generator dessen Dokumentation wie auch die für dWb+ und Aviator als Open Source Projekte zu veröffentlichen. Die entsprechenden Repositories sind für die Dokumentation des Static Site Generator wie auch die Dokumentation für dWb+ und die Dokumentation für den Aviator verfügbar.

Artikel, die hierher verlinken

Annotation Processing zur leichteren Erstellung von Modulen für dWb+

28.07.2024

Nach meinem letzten Artikel zum Thema dWb+ habe ich dieses Jahr wieder einmal die Dokumentation kritisch gelesen und festgestellt, dass ein in den letzten Jahren immer mehr ausgebautes Feature dort noch nicht auftauchte.

Neuigkeiten zu dWb+

16.07.2022

Nach meinem letzten Artikel zum Thema dWb+ ist bereits einige Zeit vergangen - daher hier ein kurzes Update mit einem Ausblick auf die nächste Version.

CI/CD Pipelines für DocBook-Dokumentationen

28.12.2021

Nachdem ich neulich die Handbücher für die Anwendungen dWb+ und EBCMS sowie für das Framework dmcc, das beispielsweise im Aviator und auch in dWb+ zum Einsatz kommt veröffentlicht habe, habe ich entsprechende CI/CD Pipelines eingerichtet, die dafür sorgen, dass die aktuelle Version der jeweiligen Handbücher immer als PDF und EPUB abgerufen werden kann.

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


Vor 5 Jahren hier im Blog

  • Docker auf Raspberry Pi Model 3B+

    07.06.2020

    Nachdem ich neulich über neues in meinem Docker-Zoo berichtete und überneulich eine Idee zur Aufwertung und Beschleunigung meines Raspberry erfolgreich in die Tat umsetzte, war der nächste Schritt klar...

    Weiterlesen

Neueste Artikel

  • LinkCollections 2025 V

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

    Weiterlesen
  • Neues Plugin für die sQLshell: Pivot

    Es gibt ein neues Plugin für die sQLshell, das die Erstellung von Pivot-Tabellen enorm vereinfacht - alles, was dazu benötigt wird ist eine bereits erfolgte Abfrage.

    Weiterlesen
  • Generator für Sticker mit abstrakten Mustern

    Ich wurde wieder einmal durch einen Trööt auf Mastodon inspiriert...

    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.