Mit der Auskopplung des Emacs Org-mode in die Syntax der vereinfachten Auszeichnungssprache Orgdown, soll ein besserer Standard als Markdown gesetzt werden. Was Orgdown ist und ob das mit dem neuen Standard etwas werden kann, lest ihr in diesem Artikel.>
Ihr alle kennt Markdown und nutzt es wahrscheinlich auch. Markdown ist eine vereinfachte Auszeichnungssprache, die von John Gruber entworfen und im Dezember 2004 mit Version 1.0.1 spezifiziert wurde. Ein Ziel von Markdown ist eine leicht lesbare Ausgangsform bereits vor der Konvertierung. Als Auszeichnungselemente wurden daher vor allem Auszeichnungsarten verwendet, die in ASCII-Texten und E-Mails üblich sind.
Leider ist die Spezifikation von Markdown unzureichend, weshalb sich über die Zeit diverse Implementierungen der Auszeichnungssprache entwickelt haben. Über die damit verbundenen Probleme habe ich bereits 2022 einen Artikel geschrieben: Warum Markdown nicht ganz richtig ist.
Neben den verschiedenen Ausprägungen der Markdown-Syntax und -Implementierung (Tools), gibt es weitere populäre vereinfachte Auszeichnungssprachen, wie AsciiDoc, WikiText und reStructuredText. Nicht zu vergessen, die Org-Erweiterung für den Emacs-Editor namens Org-Modus. Und genau dieser Org-Mode ist der Ausgangspunkt dieses Artikels.
Auf der EmacsConf 2021 hat der Entwickler Karl Voit die Löslösung der Org-mode Syntax von der Implementierung in Emacs vorgeschlagen. Um eine Namensverwirrung zu vermeiden, schlug er als Namen für die Syntax der Auszeichnungssprache Orgdown vor. In einem lesenswerten Artikel legt Voit die Gründe und Vorteile dar, nämlich:
- Bessere Unterstützung des Org-Modus in Nicht-Emacs-Werkzeugen
- Die schön gestaltete Org-Syntax einer größeren Anzahl von Menschen zugänglich machen
- Bessere Unterstützung für die Zusammenarbeit von Emacs und Nicht-Emacs-Benutzern bei der Verwendung von textbasierten Dokumenten vorantreiben
- Vergleich der Orgdown-Unterstützung verschiedener Werkzeuge
- Die irritierende Verwechslung der Syntax der Auszeichnungssprache und der Elisp-Implementierung beheben
An dieser Stelle fällt euch vielleicht der bekannte XKCD-Streifen zu Standards ein:
Syntax von Orgdown-Level 1
Da Karl Voit die Syntax auf den oben genannten Seiten gut dokumentiert hat, erspare ich mir, diese in meinem Artikel abzutippen. Schaut euch die ersten beiden Links an, dann bekommt ihr einen guten Eindruck.
Die Seite der Werkzeuge mit Orgdown1-Unterstützung lässt mich etwas ratlos zurück. Die OD1-Kompatibilität ist entweder unbekannt oder liegt unter 100 %, ausser bei Emacs. Von den Werkzeugen kenne ich nur Logseq, worüber es bei uns Artikel gibt. Ich hätte Orgdown gerne in einem (dafür gedachten) Editor ausprobiert oder zumindest mit einem CLI-Converter in eine gerenderte Ausgabe umgewandelt – allein die Mittel dafür finde ich nicht.
Vermutlich genügt dafür ein gewöhnlicher Org-mode-Parser, wie man sie auf dieser Seite findet. In meiner Verzweiflung habe ich das Schweizer Taschenmesser unter den Konvertierern installiert: Pandoc (Achtung: 226 Pakete an Abhängigkeiten). Damit kann man einen Orgdown-Quelltext z. B. in html umwandeln. Hier seht ihr mein Beispiel:
https://gitlab.com/publicvoit/orgdown
Quellen:
https://de.wikipedia.org/wiki/Markdown
https://gnulinux.ch/warum-markdown-nicht-ganz-richtig-ist
https://karl-voit.at/2021/11/27/orgdown/
