Forum: PC-Programmierung einfacher Textsetzer


von A. S. (Gast)


Lesenswert?

Wir machen Embedded-Software, die wir für Sonderanlagen, sehr 
individuell konfigurieren (1000e Schalter, Parameter, IO, Module).

Weil die Doku-Abteilung keine Austauschformat definiert, werden die 
Betriebsanleitungen manuell gepflegt, zudem sehr grob. Beim Auto ist das 
ja vielleicht akzeptabel ("... nur wenn Klimaanlage verbaut ...").

Als interne Doku möchte ich nun im Build-Prozess ein PDF, Doc oder HTML 
generieren und dazu ein plain-Text-Auszeichnungsformat wählen,

A) dass unter Windows per *Kommandozeile*/*Batch* konvertiert werden 
kann ("z.B. txt2pdf doc.txt doc.pdf")
B) dessen Konverter keine Installation braucht (also direkt aus einem 
Tool-Ordner aufgerufen werden kann)
C) wo Unicode-Zeichen im Klartext möglich sind (also z.B. utf8-Dateien 
mit Notepad)
D) dass Bilder (per Fileangabe) einbinden kann
E) dass Tabellen und einfache Hervorhebungen (Italic, Bold) ermöglicht
F) dass Modulbeschreibungen in plain Text einfach sind.
G) gerne auch Gliederung/Index, wäre aber nicht unbedingt notwendig.

Etwa wie TeX, Texinfo, HTML, RTF, groff, ...

Die Kollegen schreiben also Modul-Dokus mit möglichst wenigen Markups. 
Im Build-Prozess werden diese je nach Konfiguration zusammenkopiert, mit 
generierten Tabellen etc. ergänzt und in pdf gewandelt.

Welche Format empfehlt ihr?

HTML halte ich für zu viel Overhead bei den Beschreibungstexten. Gibt es 
für Tex oder Texinfo einfache Windows-Pakete, die nicht installiert 
werden müssen (einfache Kopie des Ordners irgendwo hinlegen)?

von Wilhelm M. (wimalopaan)


Lesenswert?

Schau Dir mal asciidoctor an:

http://asciidoctor.org

Ich schreibe (fast) alles damit.

Geht sehr schnell, weil WkikMarkup. Kann Html, pdf, ... als output.

Dazu habe ich mir einen Code-Snippet-Extraktor geschrieben, was es 
unheimlich komfortable macht.

von A. S. (Gast)


Lesenswert?

Wilhelm M. schrieb:
> Schau Dir mal asciidoctor an:

Das sieht gut aus! WIKI-Formatierungen gefallen mir.

von Wilhelm M. (wimalopaan)


Lesenswert?

Das sollte alle Deine Anforderungen abdecken. Bei Fragen gerne direkt 
fragen...

von A. S. (Gast)


Lesenswert?

Nur, wie bekommt man daraus ein natives Windows.exe, dass man (ohne 
Installation von Ruby oder so) z.B. folgendes aufrufen kann:
1
C:\tools\asciidoc\txt2pdf ba.txt ba.pdf
Also quasi, so wie man z.B. den mingw-gcc verwenden kann ohne 
Systemvariablen zu setzen oder gar irgendwas zu installieren.

von Wilhelm M. (wimalopaan)


Lesenswert?

Ups ... Windows ... was ist das ;-)

Warum ein natives executable?

Der Ruby-Interpreter wird doch direkt gestartet, so dass Du den 
Unterschied zu einem nativen executable nicht merkst.

von Fluppi die taffe Tischrollbürste (Gast)


Lesenswert?

Wilhelm M. schrieb:
> Ups ... Windows ... was ist das ;-)
>
> Warum ein natives executable?
>
> Der Ruby-Interpreter wird doch direkt gestartet, so dass Du den
> Unterschied zu einem nativen executable nicht merkst.

"ohne Installation von Ruby oder so"

Er darf/will ja nicht einmal Umgebungsvariablen setzen (wie RUBY_HOME). 
Keine Ahnung, ob das dann überhaupt funktioniert.

von Wilhelm M. (wimalopaan)


Lesenswert?

Also ich denke mal, dass der Build-Prozess als CI abläuft oder mit einem 
Build-Tool wie make, cmake, bjam, etc.

Und das Build-Tool muss ja auch irgendwie auf der Maschine vorhanden 
sein.

Asciidoctor braucht im engeren Sinn keine Installation (im Sinne von 
root/admin-Rechten, RegEdit, etc.). Allerdings muss ein Ruby-Interpreter 
da sein.

von JJ (Gast)


Lesenswert?

was ACSIIDoctor betrifft kann ich nur zustimmen! Es gibt noch die 
Variante ASCIIDoctor-PDF [1], die ich persönlich bevorzuge, weil das 
Theming deutlich einfacher ist.

Allerdings ist die Anforderung eine statische Umgebung zu haben ein 
echtes Problem. Eventuell kannst du mit Traveling Ruby [2] eine 
entsprechende Umgebung zusammenbauen.



[1] https://github.com/asciidoctor/asciidoctor-pdf
[2] http://phusion.github.io/traveling-ruby/

von Wilhelm M. (wimalopaan)


Lesenswert?

Ja, das theming ist bei asciidoctor-pdf einfach. Ich nehme einfach 
beide, um die Formate html und pdf zu generieren. Der Weg über docbook 
ist viel zu umständlich.

Man sollte vielleicht auch noch asciidoctor-diagramm erwähnen, mit dem 
man dann schön z.B. UML-Diagramme oder Block-Diagramme oder auch 
Signalverläufe zeichnen / generieren kann.

von Stefan S. (Gast)


Lesenswert?

Wilhelm M. schrieb:
> Ich schreibe (fast) alles damit.

Kennst Du Dich damit auch aus?

Ich hatte mit AsciiDoc bzw. AsciiDoctor vor ca. einem Jahr mal 
angefangen, als Alternative zu LaTeX -- also wenn es mehr um Text geht, 
und weniger um mathematische Formeln. Gut, ein einfaches Dokument wie 
https://github.com/ngtk3/NEd/blob/master/README.adoc hat man damit ja 
schnell gemacht. Aber ich glaube dann wollte ich mal eine zentrierte 
Überschift machen, und da kam ich dann nicht weiter. Daher wollte ich 
eigentlich noch mal nach Alternativen suchen...

von Wilhelm M. (wimalopaan)


Lesenswert?

Stefan S. schrieb:
> Wilhelm M. schrieb:
>> Ich schreibe (fast) alles damit.
>
> Kennst Du Dich damit auch aus?

Mmh, so gut ich es muss ... ja, schon.

> Ich hatte mit AsciiDoc bzw. AsciiDoctor vor ca. einem Jahr mal
> angefangen, als Alternative zu LaTeX -- also wenn es mehr um Text geht,
> und weniger um mathematische Formeln. Gut, ein einfaches Dokument wie
> https://github.com/ngtk3/NEd/blob/master/README.adoc hat man damit ja
> schnell gemacht. Aber ich glaube dann wollte ich mal eine zentrierte
> Überschift machen, und da kam ich dann nicht weiter. Daher wollte ich
> eigentlich noch mal nach Alternativen suchen...

Layout geht in html über css und bei asciidoctor-pdf über die themes.

Im .adoc machst Du (kaum) direkte Formatierung. Die styles sind im css 
zu definieren.

von Stefan S. (Gast)


Lesenswert?

Wilhelm M. schrieb:
> auch noch asciidoctor-diagramm erwähnen,

Ach, das kannte ich noch gar nicht. Aber nur mit einem m.

von Stefan S. (Gast)


Lesenswert?

Wilhelm M. schrieb:
> Layout geht in html über css und bei asciidoctor-pdf über die themes.
>
> Im .adoc machst Du (kaum) direkte Formatierung. Die styles sind im css
> zu definieren.

Und wüsstest Du da ein Beispiel, wie man etwa zentrierten Text erzeugen 
kann? Nicht dass ich jetzt Zentrierung benötige, aber ich frage mich, 
wie einfach man da etwas anpassen kann, wenn es nötig ist. CSS kann ja 
ganz schön schwierig sein, das weiss ich etwa von GTK3. Mit LaTeX 
bekommt man die meisten Wünsche ja selber hin, und notfalls kann man 
nachfragen -- na ja früher jedenfalls in NewsGroup de.comp.tex usw. Ob 
das jetzt noch geht weiss ich nicht :-(

von Wilhelm M. (wimalopaan)


Lesenswert?

Suche im asciidoctor-css einfach nach (o.ä.)
1
h2{font-size:1.6875em}

und ersetze das durch
1
h2{font-size:1.6875em; text-align:center}

Schau hier:

https://wiki.selfhtml.org/

: Bearbeitet durch User
von Stefan S. (Gast)


Lesenswert?

OK, danke, das ist schon mal ein guter Anfang! Werde ich demnächst mal 
probieren.

von blubb (Gast)


Angehängte Dateien:

Lesenswert?

Danke für dieses Topic. Sowas interessiert mich auch immer :)


Auch danke für den Hinweis auf AsciiDoc(tor). Kannte das noch gar nicht.

Habe heute auch direkt mal damit rumgespielt (bin noch Ruby-Unerfahren). 
klappte aber auf Anhieb :p

Nun ist mir ja wichtig, dass Dokumente als PDF erstellt werden können. 
Das habe ich auch direkt mal erfolgreich testen können. Man kann sogar 
viele Dateien zu einem Dokument erstellen lassen - toll.

An diesen Punkt habe ich gedacht, dass ich was für die Zukunft gefunden 
habe, ABER ...

... dann habe ich mich mit mathematischen Formeln beschäftigt. Und die 
kann man anscheinen nicht bequem mittels asciidoctor-pdf zu einem PDF 
umwandeln, oder doch?

Ich habe folgenden Mathecode getestet:
(Als html klappt das wunderbar)
1
:doctype: book
2
:reproducible:
3
:math:
4
:imagesoutdir: generated_images
5
:imagesdir: images
6
:stem: latexmath
7
8
== Equations!
9
10
[latexmath]
11
++++
12
k_{n+1} = n^2 + k_n^2 - k_{n-1}
13
++++
14
15
Some useful text! Formula for quadratic root:
16
17
[stem]
18
++++
19
x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
20
++++
21
22
Inline equation works too! latexmath:[a^2+b^2=c^2]. Or as stem
23
stem:[a^2+b^2=c^2]. Pretty nice, huh?


Beim asciidoctor-pdf werden [latexmath] und [stem] völlig ignoriert und 
die stem:-Anweisungen können einfach nicht umgesetzt werden.

Die Fehlermeldung lautet
1
asciidoctor: WARNING: conversion missing in backend pdf for stem

Hat da jemand eine Idee?

Ich hab auch mal die Ergebnisse der HTML-Seite und des PDFs als Bilder 
angehangen.

von Wilhelm M. (wimalopaan)


Lesenswert?

blubb schrieb:

>
> Die Fehlermeldung lautet
>
1
asciidoctor: WARNING: conversion missing in backend pdf for 
2
> stem
>
> Hat da jemand eine Idee?
>

Bitte poste das in die bug-liste von asciidoctor/...-pdf. Dan Allen ist 
eigentlich ziemlich schnell. Habe jetzt nicht geschaut, aber ich denke, 
den request gibt es dort schon, bin aber grad unsicher.

Workaround: html generieren und mit wkhtmltopdf in pdf konvertieren. So 
hatte ich das immer gemacht, bevor es asciidoctor-pdf gab.

von Wilhelm M. (wimalopaan)


Lesenswert?


von Sheeva P. (sheevaplug)


Lesenswert?

Wilhelm M. schrieb:
> Schau Dir mal asciidoctor an:
>
> http://asciidoctor.org
>
> Ich schreibe (fast) alles damit.

Was ist der Vorteil gegenüber dem (IMHO) weiter verbreiteten Markdown?

von Wilhelm M. (wimalopaan)


Lesenswert?

Ich hatte mir vor Jahren einige Systeme als Ersatz für LaTeX angesehen: 
MarkDown, RestructuredText, PanDoc, ... und eben Asciidoc und danach 
Asciidoctor. Für meine Zwecke (technische Doku ...) erschien es einfach 
das flexibelste. Aber das sollte jeder selber werten.

von blubb (Gast)


Lesenswert?

Wilhelm M. schrieb:
> Habs gefunden:
>
> https://github.com/asciidoctor/asciidoctor-pdf/issues/45

Hatte das auch schon gesehen.

Wenn ich das richtig deute, benötige ich asciidoctor-mathematics. Das 
bekommt der aber nicht kompiliert, weil mir die build tools fehlen. Also 
habe ich jetzt das Ruby-DevKit installiert. Nun fehlt mir cmake... Das 
ist auch Windows alles seeeehr doof, muss ich sagen.

Überhaupt nervt es ein wenig, dass AsciiDoctor nicht alles inkludiert 
hat, sondern noch Zusatz"plugins" benötigt. Und diese müssen dann 
anscheinend auch noch kompiliert werden (was auch immer Ruby mit Sourcen 
macht)

Zuhause, auf meinen Linux-Rechnern, wird das wohl alles aus dem Stand 
heraus funktionieren. Ist aber doof, wenn man auf Windows-Rechnern so 
einen riesen Aufwand betreiben muss. Evtl könnte man in der Firma für 
soetwas eine VM mit Linux nutzen.

Wilhelm M. schrieb:
> Ersatz für LaTeX

Ich wollte mich eigentlich immer mal mit Latex beschäftigen. Das scheint 
ja doch die beste Lösung zu sein?? Warum hast du nach einen Ersatz 
gesucht?

Wilhelm M. schrieb:
> MarkDown, RestructuredText, PanDoc, ... und eben Asciidoc

Und genau hier kommen wir der Sache näher. Es gibt ein Überangebot an 
"Sprachen" ( wie nennt man das? :D ) Und keine scheint alles zu 
erschlagen? Ich glaube MultiMarkdown (mmd) ist auch ziemlich toll.

AsciiDoctor gefällt mir eigentlich ganz gut, die Alternativen scheinen 
für den Menschen aber "schöner lesbar" zu sein. (Ist wahrscheinlich ein 
subjektives empfinden)

von blubb (Gast)


Angehängte Dateien:

Lesenswert?

Wilhelm M. schrieb:
> Workaround: html generieren und mit wkhtmltopdf in pdf konvertieren. So
> hatte ich das immer gemacht, bevor es asciidoctor-pdf gab.

Gute Idee, aber klappt nicht.
Der hängt schon seit einer Weile auf 31% (siehe Bild) :(

Den wkhtml hatte ich auch mal für einen ähnlichen Zweck benutzen wollen. 
Da habe ich dann auch gemerkt, dass der manchmal Schwierigkeiten hat, 
HTML zu PDF zu wandeln. Da hätte der AsciiDoctor eine schöne Alternative 
werden können. Haben wir also eine "Marktlücke" gefunden :D

von JJ (Gast)


Lesenswert?

Du hast recht, unter Windows macht das alles sehr begrenzt Spaß; selbst 
wenn es einmal funktioniert geht es vermutlich beim nächsten Update 
nicht nachvollziehbar kaputt.

Für den Unternehmenseinsatz würde ich einen Linuxserver mit z.B. GitLab 
als Frontend fürs editieren und die Versionsverwaltung verwenden, der 
nach jedem Commit über CI einen Build der PDFs startet.

von Wilhelm M. (wimalopaan)


Lesenswert?

blubb schrieb:
> Wilhelm M. schrieb:
>> Habs gefunden:
>>
>> https://github.com/asciidoctor/asciidoctor-pdf/issues/45
>
> Hatte das auch schon gesehen.
>
> Wenn ich das richtig deute, benötige ich asciidoctor-mathematics. Das
> bekommt der aber nicht kompiliert, weil mir die build tools fehlen. Also
> habe ich jetzt das Ruby-DevKit installiert. Nun fehlt mir cmake... Das
> ist auch Windows alles seeeehr doof, muss ich sagen.
>
> Überhaupt nervt es ein wenig, dass AsciiDoctor nicht alles inkludiert
> hat, sondern noch Zusatz"plugins" benötigt. Und diese müssen dann
> anscheinend auch noch kompiliert werden (was auch immer Ruby mit Sourcen
> macht)

Das macht aber gerade die Flexibilität von Asciidoctor aus. Man sich 
selbst ganz schnell solche Extension schreiben. Neben dem 
asciidoctor-diagram, was ich sehr stark nutze. Und es ist super, wenn 
man auf die Art den Quelltext(!) seiner Diagramme / Graphen auch in VCS 
versioniert bekommt.

> Zuhause, auf meinen Linux-Rechnern, wird das wohl alles aus dem Stand
> heraus funktionieren. Ist aber doof, wenn man auf Windows-Rechnern so
> einen riesen Aufwand betreiben muss.

Windoofs eben ...

> Evtl könnte man in der Firma für
> soetwas eine VM mit Linux nutzen.

Würde ich empfehlen.

> Wilhelm M. schrieb:
>> Ersatz für LaTeX
>
> Ich wollte mich eigentlich immer mal mit Latex beschäftigen. Das scheint
> ja doch die beste Lösung zu sein?? Warum hast du nach einen Ersatz
> gesucht?

Wenn man wirklich sehr (!) mathematische Texte schreibt - etwa ein Buch 
über elektrische Systemtheorie, indem es vor Integralen nur so wimmelt - 
ist LaTeX sich immer noch erste Wahl. Und Typografisch ein Traum.

Bei Dokumenten in Richtung SW-Entwicklung, ggf. SW-Dokumentation 
schwächelt LaTeX. Es ist dann einfach zu umständlich zu schreiben.

> Wilhelm M. schrieb:
>> MarkDown, RestructuredText, PanDoc, ... und eben Asciidoc
>
> Und genau hier kommen wir der Sache näher. Es gibt ein Überangebot an
> "Sprachen" ( wie nennt man das? :D ) Und keine scheint alles zu
> erschlagen? Ich glaube MultiMarkdown (mmd) ist auch ziemlich toll.

Die Asciidoc-Language war für mich im ersten Ansatz einfacher zu merken. 
Auch fand ich die Ergebnisse ansprechender (erst mal ohne customizing), 
die asciidoc oder besser auch asciidoctor produzieren. Und das 
Inkludieren von Source-Code-Snippets bzw. Teilen anderer Files allgemein 
fand ich für meine Anwendung auch sehr praktisch. Ja, und viele 
Kleinigkeiten mehr.

Die Installation unter Linux besteht einfach daraus, dass man die 
passenden Ruby-Gems installiert: gem install ...

Dann gibt es noch Live-Editoren, damit man das Ergebnis sofort sieht, 
...

Aber wie gesagt: man muss sich damit beschäftigen, und dann entscheiden. 
Und ich glaube, ich habe mich richtig entschieden. Ausserdem ist die 
Community sehr nett.

von blubb (Gast)


Lesenswert?

Wilhelm M. schrieb:
> Windoofs eben ...

Ich bin im Maschinenbau tätigt.
Da bevorzugen die Entwickler tatsächlich Windows :D Unverständlich.

Linux bietet ja eigentlich nur Vorteile :)

Da müsste man dann mit einen Raspberry an die Maschine rangehen, wenn 
man eine solche Funktionalität benötigt. Der RPi ist zwar toll und 
günstig, aber meiner Meinung nach falsch im industriellen Umfeld :(

Man dreht sich irgendwie ständig im Kreis ...


Wilhelm M. schrieb:
> Wenn man wirklich sehr (!) mathematische Texte schreibt

Das mathematische steht bei mir noch nicht mal im Mittelpunkt. Ich 
versuche bei solchen Entscheidungen aber immer so weit wie möglich, 
mögliche Funktionswünsche abdecken zu können. Man sucht ja irgendwo die 
eierlegende Wollmilchsau ..

von pro vs. "frickel" (Gast)


Lesenswert?

> Das
> ist auch Windows alles seeeehr doof, muss ich sagen.
:
> Zuhause, auf meinen Linux-Rechnern, wird das wohl alles aus dem Stand
> heraus funktionieren. Ist aber doof, wenn man auf Windows-Rechnern so
> einen riesen Aufwand betreiben muss.

Das ist nun mal der Unterschied:
- Professionell = man wird fürs Rumeiern bezahlt, ggfs. liefert der 
verträgliche Lieferant/Hersteller "Support" aka man kann (rechtlich) 
vermeintlich jemandem die Schuld geben
Eben.
vs.
+ "frickeln" = man findet (ggfs. selbst) rationelle Lösungen

So wollen es leider zu viele schlipstragende Cheffelfurzerln ...

von MaWin (Gast)


Lesenswert?

Vorab: Ob LaTeX für Software-Dokumentation geeignet ist, muss jeder für
sich entscheiden. Ich habe die Frage für mich mit "ja" beantwortet. ;)

Also, falls LaTeX auch weiterhin eine Option ist und es nur darum geht,
eine "richtige" Installation zu vermeiden, ist TeXLive eine Möglichkeit.
Das verwende ich an Stelle der fertigen Pakete meines Betriebssystems,
weil ich dann nur eine einzige Installation auf einem Netzwerk-Share
abzulegen brauche. So steht allen Rechnern im Netzwerk ein komplettes
TeX-System zur Verfügung, ohne dass ich auf jedem Rechner zig GB 
installieren (und updaten!) muss.

Allerdings entwickele ich nicht unter Windows (wer kommt denn auf solche
Ideen?), von daher kann ich nicht 100%ig sicher sagen, ob TeXLive dort
ebenso reibungslos funktioniert. Sollte aber eigentlich gehen.

von Clemens L. (c_l)


Lesenswert?

Sheeva P. schrieb:
> Wilhelm M. schrieb:
>> Schau Dir mal asciidoctor an
>
> Was ist der Vorteil gegenüber dem (IMHO) weiter verbreiteten Markdown?

Wikipedia sagt:
> There is no clearly defined Markdown standard, apart from the original
> writeup and implementation by John Gruber, which some consider
> abandonware. This has led to fragmentation as different vendors write
> their own variants of the language to correct flaws or add missing
> features.

Ein allgemeines "Markdown" gibt es nicht; du machst dich immer von einer 
Implementation abhängig.

AsciiDoc hat eine ordentliche Spezifikation, und erlaubt alle Features 
von DocBook und eigene Erweiterungen, ist also flexibler.

: Bearbeitet durch User
von Wilhelm M. (wimalopaan)


Lesenswert?

Clemens L. schrieb:
> Sheeva P. schrieb:
>> Wilhelm M. schrieb:
>>> Schau Dir mal asciidoctor an
>>
>> Was ist der Vorteil gegenüber dem (IMHO) weiter verbreiteten Markdown?
>
> Wikipedia sagt:
>> There is no clearly defined Markdown standard, apart from the original
>> writeup and implementation by John Gruber, which some consider
>> abandonware. This has led to fragmentation as different vendors write
>> their own variants of the language to correct flaws or add missing
>> features.
>
> Ein allgemeines "Markdown" gibt es nicht; du machst dich immer von einer
> Implementation abhängig.

Das stimmt.

> AsciiDoc hat eine ordentliche Spezifikation, und erlaubt alle Features
> von DocBook und eigene Erweiterungen, ist also flexibler.

Wobei das mit DocBook mit Vorsicht zu genießen ist. Wer hier den Output 
anpassen will, der muss halt XSLT schreiben: und das macht keinen Spaß!

Die präferierten Formate sind html (nativ) und pdf via asciidoctor-pdf 
(ohne docbook, ohne xsltproc und saxxon)

von Sheeva P. (sheevaplug)


Lesenswert?

blubb schrieb:
> Zuhause, auf meinen Linux-Rechnern, wird das wohl alles aus dem Stand
> heraus funktionieren. Ist aber doof, wenn man auf Windows-Rechnern so
> einen riesen Aufwand betreiben muss.

Für Windows10 soll es mittlerweile die Möglichkeit geben, Ubuntu-Pakete 
zu installieren und laufen zu lassen, soll aber noch "experimental" 
sein. Hab das aber noch nicht ausprobiert, YMMV.

> Ich wollte mich eigentlich immer mal mit Latex beschäftigen. Das scheint
> ja doch die beste Lösung zu sein?? Warum hast du nach einen Ersatz
> gesucht?

Naja, LaTeX erzeugt hervorragend gesetzte Dokumente, hat aber eine recht 
steile Lernkurve. Für technische Dokumentationen, bei denen es in der 
Regel ja nicht auf perfekten Textsatz und besonders hübsches Aussehen 
geht, ist LaTeX vielleicht ein bisschen überdimensioniert. ;-)

> Und genau hier kommen wir der Sache näher. Es gibt ein Überangebot an
> "Sprachen" ( wie nennt man das? :D )

Das nennt man "IT-Standards": https://xkcd.com/927/

von Sheeva P. (sheevaplug)


Lesenswert?

Clemens L. schrieb:
> Wikipedia sagt:
>> There is no clearly defined Markdown standard, apart from the original
>> writeup and implementation by John Gruber, which some consider
>> abandonware. This has led to fragmentation as different vendors write
>> their own variants of the language to correct flaws or add missing
>> features.
>
> Ein allgemeines "Markdown" gibt es nicht;

Die Version von Gruber und Swartz ist mittlerweile in RFC7763, 
erweiterte Versionen wie Multimarkdown, Pandoc etc in RFC7764 
standardisiert.

> du machst dich immer von einer Implementation abhängig.

Auf der Kommandozeile benutze ich pandoc [1], unter Python das Modul von 
[2]. Bisher bin ich nicht über Inkompatibilitäten gestolpert, aber das 
will nichts heißen: für kompliziertere Sachen oder solche, die wirklich 
hübsch aussehen sollen, benutze ich ohnehin lieber LaTeX.

[1] http://pandoc.org/
[2] https://pythonhosted.org/Markdown/

: Bearbeitet durch User
von A. S. (Gast)


Lesenswert?

Vielen Dank für die vielen guten Vorschläge!

Windows geben IT und Embedded Prozessor vor. Die Kollegen haben zudem 
keine Erfahrung mit Linux/Ruby/git/Virtuelle-Maschine/etc. Nichtmal 
Administratorrechte und manchmal auch kein Netz.

Unsere Beschreibungen sind trivial. Keine Formeln, einfache Markups und 
Fließtext-Bilder reichen. Ich mag es, wenn die Quellen.txt störungsarm 
lesbar sind. Das gefallen mir Asciidoc & Co, und TeX, HTML, RTF und 
Groff sind (als Quelle) raus.

UTF-8 wäre hilfreich, da unser Steuergerät die komplette BMP nutzt 
(incl. chinesisch & japanisch).

Die Doku wird überwiegend generiert (Parameter-Tabellen, Compilate, 
bedingte Textpassagen). Darum sind verbindlicher Standard oder Pflege 
nicht notwendig. Wenn es heute funktioniert, läuft es 10 Jahre so 
weiter (never touch ...). Und wenn doch, wird halt der Generator 
angepasst.

Ich würde meine Frage somit reduzieren auf:
Wer kennt eine txt2pdf.exe für utf8-Texte mit einfachem Markup? Oder 
alternativ 2html, 2rtf, 2odt oder 2doc? Unter Windows 7, ohne 
Installation und ohne Laufzeitumgebung.


Schönes Wochenende

von Wilhelm M. (wimalopaan)


Lesenswert?

Mit asciidoctorJ gibt es eine Java-Implementierung. Hilft das? Ist zwar 
keine .exe ... Aber eine JVM musst Du dann auch installieren. Genauso 
kompliziert wir Ruby. Fällt also wohl raus ...

(Als es Asciidoctor noch nicht gab, sondern nur die Python-Variante 
namens AsciiDoc, hatte ich mal angefangen, das in C++ zu 
reimplementieren, weil AsciiDoc so langsam war. Bin aber nicht weit 
gekommen, denn kurz danach war auf einmal asciidoctor da.)

von blubb (Gast)


Lesenswert?

blubb schrieb:
> Wenn ich das richtig deute, benötige ich asciidoctor-mathematics. Das
> bekommt der aber nicht kompiliert, weil mir die build tools fehlen. Also
> habe ich jetzt das Ruby-DevKit installiert. Nun fehlt mir cmake... Das
> ist auch Windows alles seeeehr doof, muss ich sagen.

Das lässt sich auch nicht ohne weiteres auf Arch Linux installieren. Ein 
Workaround hat zumindest die Installation letztendlich zugelassen (ob 
der auch beim Windows funktioniert?) aber die Programmausführung geht 
schon wieder nicht.

Da muss jemand bockmist gebaut haben :(

So beginnt jedenfalls keine Freundschaft :D

von Wilhelm M. (wimalopaan)


Lesenswert?

blubb schrieb:
> blubb schrieb:
>> Wenn ich das richtig deute, benötige ich asciidoctor-mathematics. Das
>> bekommt der aber nicht kompiliert, weil mir die build tools fehlen. Also
>> habe ich jetzt das Ruby-DevKit installiert. Nun fehlt mir cmake... Das
>> ist auch Windows alles seeeehr doof, muss ich sagen.
>
> Das lässt sich auch nicht ohne weiteres auf Arch Linux installieren. Ein
> Workaround hat zumindest die Installation letztendlich zugelassen (ob
> der auch beim Windows funktioniert?) aber die Programmausführung geht
> schon wieder nicht.
>
> Da muss jemand bockmist gebaut haben :(

Das kommt in den besten Familien vor.

> So beginnt jedenfalls keine Freundschaft :D

F/OSS lebt davon, dass Leute sich aktiv und konstruktiv beteiligen. 
Also, wenn Du dieses feature wirklich brauchst, dann

1) berichte den Fehler an die Entwickler
2) unterhalte Dich mit den Entwicklern
3) falls der Entwickler keine Lösung hat oder grad dafür keine Zeit, 
weil er für andere Nutzer seiner Software weiterentwickelt
3a) beseitige das Problem selbst und ertselle einen Patch
3b) sende einen Patch an den Entwickler

von A. S. (Gast)


Lesenswert?

Hallo nochmal, vielen Dank für die wertvollen Tipps. Ich habe mich 
(vorläufig) für txt2tags (http://txt2tags.org) entschieden.

* Python ist bei uns prinzipiell verfügbar (für einen anderen Prozess)
* der ganze Konverter ist ein einziges 5000-Zeilen Script. Also 
einfacher Kommandozeilen-Aufruf und Anpassungen "einfach";-)
* Problemlose Verarbeitung von UTF-8!

Was mich ein wenig wundert: Markdown, AsciiDoc(tor) und selbst 
reStructuredText scheinen UTF-8 nicht direkt verarbeiten zu können. Wie 
macht Ihr das dann z.B. mit chinesischen Zeichen oder Symbolen? Oder 
stelle ich mich nur zu dusselig an?

Kennt Ihr weiter leichte Auszeichnungssprachen, die UTF-8-Texte 
konvertieren? (zu HTML oder Tex)

Herzliche Grüße

achim

von Wilhelm M. (wimalopaan)


Lesenswert?

Achim S. schrieb:

> Was mich ein wenig wundert: Markdown, AsciiDoc(tor) und selbst
> reStructuredText scheinen UTF-8 nicht direkt verarbeiten zu können. Wie
> macht Ihr das dann z.B. mit chinesischen Zeichen oder Symbolen? Oder
> stelle ich mich nur zu dusselig an?

Ist bei mir (Linux) kein Thema ... ;-)

von Wilhelm M. (wimalopaan)


Lesenswert?

Achim S. schrieb:
> Hallo nochmal, vielen Dank für die wertvollen Tipps. Ich habe mich
> (vorläufig) für txt2tags (http://txt2tags.org) entschieden.
>
> * Python ist bei uns prinzipiell verfügbar (für einen anderen Prozess)
> * der ganze Konverter ist ein einziges 5000-Zeilen Script. Also
> einfacher Kommandozeilen-Aufruf und Anpassungen "einfach";-)
> * Problemlose Verarbeitung von UTF-8!

Der kann aber kein SourceCode-Highlighting, oder?

von Frank E. (Firma: Q3) (qualidat)


Lesenswert?

Wenns auch ein par Euro kosten darf, ist eigentlich Adobe Framemaker das 
professionelle und zertifizierte Tool für technische Dokumentationen.

http://www.adobe.com/de/products/framemaker.html

https://www.youtube.com/watch?v=l4141WkPIg8
https://www.youtube.com/watch?v=M9zN0XmS1ds
https://www.youtube.com/watch?v=03IFxMj2jAo

: Bearbeitet durch User
Bitte melde dich an um einen Beitrag zu schreiben. Anmeldung ist kostenlos und dauert nur eine Minute.
Bestehender Account
Schon ein Account bei Google/GoogleMail? Keine Anmeldung erforderlich!
Mit Google-Account einloggen
Noch kein Account? Hier anmelden.