Dokumentation über Org Mode

Unicorn

Emacs Org-Mode hat einen enormen Leistungsumfang. I nutze Org-Mode vor allem um Dokumentation zu erstellen, besonders für Soft- und Hardware-Projekte.

Als ich Org-Mode gelernt habe, habe ich die folgenden Zeilen aufgeschrieben über Dinge, die mir am wichtigsten erschienen. Diese können vielleicht für Andere nützlich sein, die ähnliche Anforderungen haben.

Es gibt hier weitere Information

wie man HTML-Dateien aus Org-Mode-Dateien erzeugt
wie man PowerPoint-Folien erzeugt, mittels des Pandoc-Werkzeugs
wie man Beamer-PDF-Folien erzeugt, mittels LaTeX

Struktur festlegen/ändern

Überschriften

Stern (ein oder mehrere) plus ein Leerzeichen

Einrücken/Ausrücken

M-← oder M-→

den ganzen Ast:

M-S-← oder M-S-→

Aufzählungs-Typ und -Art umschalten

S-← oder S-→

Das geht aber nur, wenn der Cursor auf dem Aufzählungs-Zeichen steht. Bei 1. oder 1) kann er sowohl auf der Ziffer als auch auf dem . oder ) stehen.

Bei Überschriften wird hiermit von normal auf TODO oder DONE umgeschaltet. D.h: nur Überschriften können TODO-Items sein.

Ast nach oben oder unten verschieben

M-↑ oder M-↓

Textausrichtung

M-q geht in Org-Mode nur, wenn der Aufzählungspunkt schon korrekt eingerückt ist!

Datum einfügen

Mit C-c ! fügt man ein Datum ein (genauer: ein "inactive date", das nicht in die Agenda kommt)

C-c . dagegen, fügt ein "active date" ein

Feste neue Zeile in einer Tabellen-Zelle

In einer org-mode Tabellen-Zelle kann man eine feste neue Zeile erzwingen mit

line1 @<br/> line2

Das funktioniert aber nur beim HTML-Export.

Text-Literale

Um Text genauso auszugeben, wie er im Org-Mode-Datei steht, schreibt man entweder vor jede Zeile ein ":" (Colon) gefolgt von einem Leerzeichen:

: Literal text

oder man nutzt folgende Syntax

#+BEGIN_EXAMPLE -i
Literal text
#+END_EXAMPLE

Der "-i" Schalter bewahrt Einrückungen.

Caveats

Org-Mode ist sehr gefräßig bei Keyboard-Befehlen. Z.b. muss ich C-TAB ‑ mit dem ich den sichtbaren Buffer umschalten will ‑ extra in my init.el wieder umwidmen.

Meine Org-Mode-Voreinstellungen (via Emacs Customize)

Zusammenspiel mit CUA-Mode

Damit org-mode nicht mit CUA-Mode kollidiert, setze ich die Variable org‑replace‑disputed‑keys auf TRUE (gefunden im org-mode FAQ unter "15.10.2 Packages that conflict with Org mode")

Damit "Shift-Select" geht (was ich oft nutze), muss die Variable org‑support‑shift‑select gesetzt werden.

Lange Zeilen anzeigen

Setze org‑startup‑truncated auf "off", damit lange Zeilen auch sichtbar sind und nicht nur mit einem Pfeil rechts abgeschnitten erscheinen.

Bilder beim Start anzeigen

Org, Customize Group: Org Startup, Org Startup With Inline Images und setze auf non-nil. Das schreibt

 '(org-startup-with-inline-images t)

in init.el

Das gleiche kann auch pro Datei forciert werden, indem man

#+STARTUP: inlineimages

an den Beginn der Datei schreibt. Siehe https://www.orgmode.org/manual/In_002dbuffer-settings.html