Von Ehemaliger VMS Benutzer am Do, 9. März 2017 um 18:11 #
Denn Doku habe ich schon immer mit selber gestrickten Werkzeugen gemacht. In der „Computer Steinzeit“ hatten wir auf den VAX oder Alpha Rechnern nämlich (Gott sei Dank) keine Textverarbeitung.
Wir hatten DIGITAL Standard Runoff http://h20565.www2.hpe.com/hpsc/doc/public/display?docId=emr_na-c04623260
Das haben wir rege genutzt und mit eigenen Tools angereichert. Z.B. gab es da ein „atops“ (Ascii to Postscript), mit dem man das Ergebnis von DSR auf postscriptfähigen Druckern ausgeben konnte (und nebenbei noch EPS Bilder mit reinziehen konnte). Zur Programm Dokumentation hatten wir ein „pdoku“ gebaut, etwa so etwas wie Doxygen nur mit Output für DSR. Da Doxygen besser ist und besonders HTML erzeugen kann, hat das heute den Vorzug.
Zwischenzeitlich habe ich auch viel mit LaTeX + eigene Tools hantiert. Aber mein Ziel geht dahin mit 1 Quelltext sowohl HTML als auch PDF für den Drucker zu erzeugen.
Deshalb habe ich mir ein „rlbb2html“ gebastelt. Das macht aus von mir selber ausgedachtem „Mark Down“ (oder BB Code oder wie das heisst) HTML als Ausgabe. Das HTML kann ich Alles als 1 Seite bekommen oder als Serie von HTML Seiten zum durchblättern.
Dabei wird auch CSS genutzt, besonders für die Optimierung des PDF für die Druckausgabe.
Die HTML Version, wo das gesamte Dokument in 1 Seite enthalten ist, öffne ich dann mit Firefox und Drucke die in eine PDF Datei. (Andere Browser gehen auch. Die einzelnen Browser liefern aber unterschiedliche Ergebnisse.)
Mal sehen, ob man statt eines Browsers auch http://doc.qt.io/qt-5/qwebenginepage.html#printToPdf sinnvoll nutzen kann.
Momentan setze ich mit dem obigen Tool eine „Dorfzeitung“.
Von Multimarkdown+ReText+Pandoc am Fr, 10. März 2017 um 19:34 #
YES! Pandoc empfinde ich als die Speerspitze der Konvertierungsprogramme für Markupsprachen!
Ich nutze gerne Markdown (Multimarkdown) mit dem Markdown-Editor ReText (ReST kann der übrigens auch), weil man in ReText Pandoc direkt einbinden kann. Siehe: https://sourceforge.net/p/retext/wiki/Export%20Extensions/
Denn Doku habe ich schon immer mit selber gestrickten Werkzeugen gemacht.
In der „Computer Steinzeit“ hatten wir auf den VAX oder Alpha Rechnern nämlich (Gott sei Dank) keine Textverarbeitung.
Wir hatten DIGITAL Standard Runoff
http://h20565.www2.hpe.com/hpsc/doc/public/display?docId=emr_na-c04623260
Das haben wir rege genutzt und mit eigenen Tools angereichert.
Z.B. gab es da ein „atops“ (Ascii to Postscript), mit dem man das Ergebnis von DSR auf postscriptfähigen Druckern ausgeben konnte (und nebenbei noch EPS Bilder mit reinziehen konnte). Zur Programm Dokumentation hatten wir ein „pdoku“ gebaut, etwa so etwas wie Doxygen nur mit Output für DSR. Da Doxygen besser ist und besonders HTML erzeugen kann, hat das heute den Vorzug.
Zwischenzeitlich habe ich auch viel mit LaTeX + eigene Tools hantiert.
Aber mein Ziel geht dahin mit 1 Quelltext sowohl HTML als auch PDF für den Drucker zu erzeugen.
Deshalb habe ich mir ein „rlbb2html“ gebastelt. Das macht aus von mir selber ausgedachtem „Mark Down“ (oder BB Code oder wie das heisst) HTML als Ausgabe. Das HTML kann ich Alles als 1 Seite bekommen oder als Serie von HTML Seiten zum durchblättern.
Dabei wird auch CSS genutzt, besonders für die Optimierung des PDF für die Druckausgabe.
Die HTML Version, wo das gesamte Dokument in 1 Seite enthalten ist,
öffne ich dann mit Firefox und Drucke die in eine PDF Datei.
(Andere Browser gehen auch. Die einzelnen Browser liefern aber unterschiedliche Ergebnisse.)
Mal sehen, ob man statt eines Browsers auch
http://doc.qt.io/qt-5/qwebenginepage.html#printToPdf
sinnvoll nutzen kann.
Momentan setze ich mit dem obigen Tool eine „Dorfzeitung“.
Danke für den Artikel, dem man nur zustimmen kann.
Hier noch eine (weitaus mächtigere) Alternative bzw. ein Schweitzer Taschenmesser für (wirklich alle möglichen) Formate: http://pandoc.org/
Und als Markdown-Alternative: http://pandoc.org/MANUAL.html#pandocs-markdown
:-)
YES! Pandoc empfinde ich als die Speerspitze der Konvertierungsprogramme für Markupsprachen!
Ich nutze gerne Markdown (Multimarkdown) mit dem Markdown-Editor ReText (ReST kann der übrigens auch), weil man in ReText Pandoc direkt einbinden kann. Siehe: https://sourceforge.net/p/retext/wiki/Export%20Extensions/
Ja, Sphinx ist schon ein geiles Teil und kann auch aus Quellcode Kommentare bzw. Dokumentationen extrahieren.
Mein Problem ist bloß, dass man irgendwann nicht mehr weiß, welche Referenzen ich oder andere Dokumenteure in den Quelltext eingebaut haben:
.. _ach_diese_referenz_existierte_auch_noch:
oder
.. _mist_hier_drinnen_ist_ein_tpyo:
Gibt es da was praktikableres als
grep -r "^.. _" *