Die Org-Mode-Syntax ist eine der vernünftigsten Markup-Sprachen für Text (2017)

• Die Org-Mode-Syntax wird als intuitive und konsistente leichtgewichtige Markup-Sprache vorgestellt, die sich auch außerhalb von Emacs nutzen lässt
• Grundlegende Syntax für Überschriften, Listen, Formatierung und Links ist einfach aufgebaut und leicht zu merken, mit höherer Ausdruckskonsistenz als bei anderen Sprachen
• Anders als die vielen Ableger von Markdown bewahrt Org Mode rund um eine Implementierung (Emacs Org-mode) eine vergleichsweise standardisierte Form
• Mit verschiedenen Werkzeugen wie Pandoc konvertierbar und auch ohne Emacs leicht in gewöhnlichen Texteditoren zu schreiben
• Selbst unter leichtgewichtigen Markup-Sprachen hebt es sich durch Lesbarkeit, Wartbarkeit und Tool-Unterstützung hervor und wird als Alternative für textbasierte Dokumenterstellung betont

---

Überblick über die Org-Mode-Syntax

• Die Org-Mode-Syntax ist nicht an Emacs gebunden und kann in vim, Atom, Notepad usw. in jedem Texteditor verwendet werden
  • Überschriften drücken Hierarchien mit *, **, ** * aus
  • Textformatierung hat die Formen *bold*, /italic/, _underlined_, +strikethrough+, =monospaced=
  • Links sind im einfachen Format [[URL][설명]] gehalten
  • Unterstützt auch Listen (-, 1.), Checkboxen ([ ], [X]) und Code-Blöcke (#+BEGIN_SRC ... #+END_SRC)
• Tabellen sind manuell schwer auszurichten, aber die Syntax wird auch ohne Ausrichtung erkannt
• Nutzer können die Syntax ohne separates Cheatsheet natürlich erlernen

Standardisierung und die Probleme von Markdown

• Bei Markdown entstehen durch zahlreiche abgeleitete Standards (Original, Extra, MultiMarkdown, GitHub Flavored, CommonMark usw.) Kompatibilitätsprobleme
  • Selbst bei demselben „Markdown“ unterscheidet sich die Syntax je nach Tool, was zu Datenverlust und schlechterer Nutzbarkeit führt
• Bei Org Mode ist die gesamte Syntax anhand der einen Implementierung Emacs Org-mode definiert, wodurch eine konsistente Interpretation möglich ist
  • Abgeleitete Werkzeuge arbeiten als Teilmenge (subset) des Originals
  • Die Dateiendung ist einheitlich immer .org
• Es gibt zwar kein offizielles Standarddokument, aber die Emacs-Implementierung fungiert faktisch als golden standard

Vergleich von Konsistenz und Nutzbarkeit

• Überschriften-Syntax: Org Mode verwendet nur das Präfix * und stellt Hierarchien dadurch einfach dar
  • Markdown, AsciiDoc, reStructuredText usw. haben komplexe und inkonsistente Strukturen mit Präfix-/Suffix- oder Unterstreichungsstilen
  • Manche Sprachen erlauben gemischte Stile, was die Verwirrung verstärkt
• Link-Syntax: [[URL][텍스트]] in Org Mode ist einfach, aber
  • [텍스트](URL) in Markdown oder `텍스트 <URL>`_ in reStructuredText haben kompliziertere und inkonsistentere Symbolkombinationen
• Formatierungs-Syntax: Org Mode nutzt /italic/, *bold*, ~monospace~, +strikethrough+ mit einer konsistenten Struktur aus Symbolpaaren
  • Markdown nutzt _italic_, **bold**, ~~strike~~ usw. mit uneinheitlicher Symbolanzahl und Regeln

Eingabekomfort und Tool-Unabhängigkeit

• Org Mode erfordert weniger unnötige Zeicheneingaben und kennt keine manuelle Ausrichtung oder komplizierte Syntax
• Auch außerhalb von Emacs lässt sich in Org-Mode-Syntax geschriebener Text mit Pandoc in viele Formate wie HTML, PDF oder Word konvertieren
• GitHub und GitLab können Org-Dateien ebenfalls rendern, und sie sind auch in einfachen Textumgebungen effizient
• Es wird betont, dass „die Org-Mode-Syntax umso nützlicher ist, je weniger Tool-Unterstützung eine Umgebung bietet“

Tool-Unterstützung innerhalb von Emacs

• In Emacs lässt sich beim Schreiben im Org Mode die Struktur mit TAB, Alt+Pfeiltasten, Ctrl+Return usw. bearbeiten
  • Unterstützung für Automatisierung wie Überschriften ein-/ausklappen, Listen verschieben oder Tabellenzeilen und -spalten bewegen
• Auch ein menübasiertes Vorgehen ist möglich, und effizientes Schreiben ist selbst ohne das Lernen von Tastenkürzeln möglich
• Emacs ist nicht erforderlich, bietet aber bei Nutzung die leistungsfähigste Bearbeitungserfahrung für Markup
• Markdown, AsciiDoc und reStructuredText verfügen nicht über eine vergleichbare Tool-Unterstützung

Fazit und Vorschlag für Orgdown

• Das Ziel leichtgewichtiger Markup-Sprachen ist Kompaktheit und Effizienz, und Org Mode besitzt in dieser Hinsicht das vernünftigste Design
• Markdown, AsciiDoc und reStructuredText leiden unter mangelnder Konsistenz und komplexer Syntax, was die Nutzbarkeit senkt
• Org Mode hat eine geringe Lernkurve, ist tool-unabhängig und hoch kompatibel bei Konvertierungen
• Seit 2021 ist aus dieser Diskussion mit Orgdown ein neuer Standardisierungsversuch hervorgegangen
  • Vorgestellt als unabhängiges Standardisierungsprojekt für leichtgewichtiges Markup auf Basis der Org-Mode-Syntax

Weitere Diskussionen und Feedback

• Einige Nutzer weisen auf das Fehlen eines offiziellen Standards für Org Mode hin
  • Zwischen Emacs und Pandoc gibt es Interpretationsunterschiede, doch die Emacs-Implementierung gilt faktisch als Maßstab
• Es gab auch Feedback zur Link-Referenzfunktion von reStructuredText,
  • der Autor bewertet Org Mode aber weiterhin als das logischste und am leichtesten zu merkende leichtgewichtige Markup
• Insgesamt wird Org Mode als vernünftige Alternative für die Erstellung allgemeiner Textdokumente über das Emacs-Ökosystem hinaus vorgestellt

[GN⁺]

Hacker-News-Kommentare

• Ich habe 2016, als ich von Evernote zu org-mode gewechselt bin, angefangen, Emacs zu benutzen
  Inzwischen nutze ich org-mode für alle Projekte, Aufgaben und mein Wissensmanagement. Manche Dateien sind über 15 MB groß
  Anfangs habe ich nur einfache Überschriften verwendet, aber immer wenn ich etwas brauchte, war die Funktion schon da. Ich finde, es gibt nur selten Werkzeuge, die zugleich leicht zu benutzen sind und stark erweiterbar bleiben
  • Ich frage mich, wie ihr mit Rich Text wie PDFs, Bildern oder HTML umgeht. Evernote unterstützt das gut, deshalb komme ich davon noch nicht los
  • Ich nutze org-mode auch schon seit einigen Jahren, verwende aber nur grundlegende Überschriften, Formatierung, Links und Code-Blöcke
    Falls es fortgeschrittene Funktionen gibt, in die man sich tiefer einarbeiten sollte, würde ich mich über Empfehlungen freuen
  • 15 MB dürften ungefähr 3 Millionen Wörter sein. Das entspricht fast 60 Romanen, erstaunlich
• Das org-Format selbst ist intuitiv, aber die eigentliche Stärke kommt aus der Integration mit Emacs
  Man kann es für persönliche Informationsverwaltung (PIM), Dokumente, Notizen, automatisierte Shortcuts und vieles mehr nutzen
  Statt es nur als Ersatzformat für Markdown zu sehen, entfaltet es seinen Wert vor allem innerhalb des Emacs-Ökosystems
  • Ich glaube, der Wert wäre noch größer, wenn das org-Format auch außerhalb von Emacs so breit wie Markdown übernommen würde
    Karl Voits Artikel argumentiert, dass die org-Syntax konsistenter und kompakter als Markdown ist
    In der Technikwelt setzt sich nicht immer das bessere Format durch, aber ich finde, es lohnt sich weiterhin, dafür zu werben
  • Ich benutze Markdown auch täglich, aber tatsächlich fühlt sich orgdown praktischer an
    Dieser Artikel betont genau diesen Punkt
• Ich schreibe alle meine Bücher in Markdown
  Früher habe ich XML verwendet, bin aber wegen des Aufwands davon weggegangen. Mit einem Pandoc-basierten Workflow erzeuge ich HTML und PDF
  In letzter Zeit nutze ich Typst, um PDFs schneller zu erstellen.
  Ich habe das Projekt xml2typ gebaut, um PDFs viel schneller als mit Pandoc/LaTeX zu erzeugen
  • Man kann doch mit Typst direkt PDFs erzeugen; ich frage mich, warum man überhaupt noch über docbook und xsltproc gehen sollte
  • Ich habe mir das Repository angesehen. Es wäre schön, wenn auch das finale PDF-Ergebnis von test.md enthalten wäre
• Ich habe org schon lange als Austauschformat zwischen Produktivitätstools vorgeschlagen
  org kann Lesezeichen, PKM und Aufgabenverwaltung zusammenführen
  Im Zeitalter von AI wird jedoch Markdown zum Standardformat für das Training von LLMs
  Trotzdem verarbeiten LLMs auch org gut, daher gibt es Raum dafür, dass beide koexistieren
  Siehe auch diesen Vorschlagsartikel
  • Der Schwerpunkt meines Artikels liegt auf der Syntax von org-mode (orgdown). Tools wie Sharepoint oder Jira sind ein anderes Thema
  • Ich finde, ConnectedText war org bei Durchsuchbarkeit und Stabilität immer noch überlegen
    Schade, dass es nicht Open Source geworden ist. Das zeigt die Grenzen eines Einzelentwicklerprojekts als SPOF
  • Meiner Erfahrung nach kommen LLMs auch mit org-mode gut zurecht. Es gibt im Internet genug org-Daten zum Trainieren
• Ich organisiere mein Leben seit 10 Jahren mit org-mode
  Dank Beorg für iOS funktioniert das auch mobil gut
  Mit org-ql und org-super-agenda habe ich meine Produktivität gesteigert
  Ich halte jeden Tag Arbeitsprotokolle in org-Dateien fest, und das hilft enorm bei der Jahresbeurteilung
  • Ich empfehle meine Browser-Erweiterung BrainTool
    Sie synchronisiert Lesezeichen und Tabs mit org-Dateien, sodass man sie als TODOs verwalten kann
  • Ich überlege auch gerade, wie ich mein Journal strukturieren soll. Ich bevorzuge kontextbezogene Überschriften statt einer datumszentrierten Struktur
    Mich würde interessieren, wie du Links zwischen Dateien organisierst. Ich ziehe auch denote in Betracht
• Komplexes HTML oder LaTeX in org-mode auszudrücken, finde ich eher schwieriger
  Deshalb schreibe ich komplexe Dinge einfach direkt im HTML- oder LaTeX-Original
  Das org-mode-Programm selbst ist hervorragend, aber wenn man nur auf die Syntax schaut, ist Markdown praktischer
  Als ich meinen Blog von org auf Markdown umgestellt habe, wurde der Code kompakter und 50-mal schneller
  • Bei mir war es umgekehrt: Ich bin von Markdown zu org gewechselt
    Mit dem Projekt shite habe ich einen Bash-basierten Site-Builder gebaut und HTML-Blöcke direkt in org eingebettet
    Die Funktion org-edit-special, mit der man nur das HTML bearbeiten kann, war extrem nützlich
  • Wenn man Code-Blöcke (#+BEGIN_SRC html) nutzt, bekommt man auch sprachspezifisches Highlighting
    Mit yasnippet angelegte Shortcuts sind praktisch
  • In org kann man HTML/LaTeX leicht einfügen
    Ich schreibe seit 2009 alle meine Beamer-Dokumente in org
    Für meinen Pelican-Blog habe ich per Python-Plugin Unterstützung für org ergänzt
  • Ich habe meinen Blog ebenfalls von org auf Markdown umgestellt
    org ist eine tolle Idee, aber das Problem ist die mangelnde Kompatibilität. Markdown wird überall unterstützt und ist deshalb die realistischere Wahl
• Markdown hat sich bereits als standardmäßiges leichtgewichtiges Markup etabliert
  So vernünftig org-mode auch sein mag, in der Praxis ist es realistischer, Markdown als Standard zu verwenden, weil es populär ist
  • Man sollte Markdown als Substantiv und Org-mode als Verb (System) verstehen
    Es geht nicht nur um einen Formatvergleich, sondern um Werkzeuge mit einer völlig anderen Funktionsweise
    Markdown enthält nur Struktur, Org dagegen auch Zustand und Ausführungslogik
    Deshalb ist die Debatte über die „Standardwahl“ sinnlos. Man sollte einfach verwenden, was zum eigenen Zweck passt
  • Soll man bei persönlichen Dateiformaten wirklich nach Popularität entscheiden?
    Es gibt keinen Grund, jemandem vom org-mode-Gebrauch abzuraten
  • Letztlich ist es eine Frage des Geschmacks. Wie bei LaTeX vs. Typst sollte man die Umgebung wählen, die zu einem passt
  • Ich finde, Markdown sieht im Rohtext besser aus
    Die Sternchen-Überschriften von org wirken visuell unruhig. Die Schreibweise für Kursivschrift gefällt mir aber
  • Markdown hat viele Mehrdeutigkeiten und Kompatibilitätsprobleme
    Es ist je nach Implementierung unterschiedlich, und Dinge wie Tabellen oder Fußnoten existieren oft nur als Erweiterungen
    Der einzige wirkliche Vorteil ist die Allgegenwärtigkeit
• Ich habe vor Kurzem angefangen, statt Markdown Geminis gemtext (.gmi) zu verwenden
  Es hat weniger Funktionen, ist dafür aber einfach und leicht zu parsen. Links beginnen mit =>, und auch die Absatztrennung ist klar
  Mein Parser hat etwa 70 Zeilen und deckt 95 % der Funktionen ab, die ich von Markdown brauche
  • Ich mag gemtext auch. Einfache Überschriften und Links reichen völlig aus
    Allerdings ist es unpraktisch, dass Zeilenumbrüche als Absatztrennung behandelt werden.
    So wie in Pandoc-Markdown doppelte Zeilenumbrüche für Absätze zu verwenden, wäre besser
• Die größte Stärke von org-mode ist für mich die Makrofunktion
  Ich schreibe Online-Lehrmaterial in org-mode und exportiere es jedes Semester als HTML
  Mit Makros automatisiere ich Texterweiterungen, elisp-Auswertung und Ähnliches
  Zum Beispiel wird {{{NOUN-C}}} je nach Kontext zu „Clause“ oder „Rule“
  Auch das Datum oben auf der Seite wird per elisp automatisch erzeugt.
  Ich nutze das mit Dropbox integrierte Hosting von site44.com, sodass Speichern sofort im Web sichtbar wird
• Für org-mode gibt es noch keine offizielle Spezifikation (spec)
  Deshalb unterstützen es andere Tools kaum. CommonMark ist dagegen standardisiert
  Ich werde weiter CommonMark verwenden
  • Dass eine Spezifikation fehlt, ist nicht unbedingt das Problem von org. Markdown war auch wegen Einfachheit und Integrationsfähigkeit erfolgreich
    Dass Websites wie Reddit Markdown übernommen haben, war eher eine gute Entscheidung
  • Das Dokument org-syntax erfüllt gewissermaßen die Rolle einer inoffiziellen Spezifikation
  • Auch Python hat keine formale Spezifikation, aber CPython ist de facto der Standard. Eine ähnliche Situation
  • Es gibt viele Apps, die org unterstützen. Mobile Apps, Vim-Plugins, GitHub, Codeberg und mehr bieten Unterstützung
    Im Vergleich zu Markdown gibt es viele Open-Source-Lösungen mit starkem Fokus auf lokale Synchronisierung
    Markdown-basierte Notiz-Apps sind dagegen oft stärker von der Cloud abhängig
  • Auch Codeberg unterstützt org in READMEs. Einige andere Git-Forges unterstützen es ebenfalls teilweise