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.

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

Sonderzeichen einfügen

Um Sonderzeichen zu verwenden, empfehle ich UTF-8 als Datei-Kodierung. Das ist nicht Org-Mode-spezifisch, sondern gilt für EMACS allgemein. Ich führe das trotzdem hier auf:

Ein beliebiges Unicode-Zeichen kann mittels

C-x 8 RET code RET

eingegeben werden. Für code kann eine Hexadezimalzahl angegeben werden oder auch ein Name, der mit Tab auch vervollständigt werden kann. Achtung: nachdem es sehr viele UTF-8/Unicode-Zeichen gibt, sollte man die Suche schon etwas eingrenzen.

Beispiele:

Meine Beschreibung	Glyph	Hexadez.	Name
Einfacher, kurzer, dünner Pfeil nach links	←	2190	LEFTWARDS ARROW
Einfacher, kurzer, dünner Pfeil nach oben	↑	2191	UPWARDS ARROW
Einfacher, kurzer, dünner Pfeil nach rechts	→	2192	RIGHTWARDS ARROW
Einfacher, kurzer, dünner Pfeil nach unten	↓	2193	DOWNWARDS ARROW
Einfacher, kurzer, dünner Pfeil nach rechts und links	↔	2194	LEFT RIGHT ARROW
Festes Leerzeichen		00A0	NO-BREAK SPACE
Festes Minus	‑	2011	NON-BREAKING HYPHEN
Bedarfstrennstrich		00AD	SOFT HYPHEN
Minus das zu + passt	−	2212	MINUS SIGN
Plus-minus	±	00B1	PLUS-MINUS SIGN
Ungefähr	≈	2248	ALMOST EQUAL TO
Punkt-Operator	⋅	22C5	DOT OPERATOR
Mal-Zeichen	×	00D7	MULTIPLICATION SIGN
Kleiner-gleich	≤	2264	LESS-THAN OR EQUAL TO
Größer-gleich	≥	2265	GREATER-THAN OR EQUAL TO
Mikro	µ	00B5	MICRO SIGN
Grad	°	00B0	DEGREE SIGN
EUR Währungssymbol	€	20AC	EURO SIGN

Festes Leerzeichen, festes Minus und Bedarfstrennstrich habe ich mir auf Funktionstasten gelegt (siehe mein init.el), damit ich sie rasch einfügen kann.

Wenn man UTF-8/Unicode-Zeichen nutzt, kann man mit C-u C-x = überprüfen, welchen Font EMACS nimmt um ein Zeichen (Glyph) darzustellen. Der Cursor muss auf dem Zeichen stehen.

Mir fiel auf, dass EMACS v25.1 lahm wurde, wenn man bestimmte Zeichen nutzte. Unter Windows 10 waren die Fonts die EMACS nutzt zum Beispiel "MS Gothic" und "Malgun Gothic", obwohl ich "Consolas" als Default-Font gesetzt hatte. Mit anderen Worten: wenn EMACS das fragliche Glyph in Consolas findet, ist die Geschwindigkeit normal. Wenn EMACS auf die anderen Fonts zugreifen musste, war die Geschwindigkeit schlecht.

Unter Windows kann man sich die Glyphen, die ein Font bereitstellt, mit dem Zeichentabelle-Programm (Character Map) anzeigen lassen

Unter Linux, sind z.B. "Inconsolata" und "DejaVu Sans Mono" Alternativen zu "Consolas".

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