Text formatieren mit Markdown

In vielen Textfeldern lässt sich der Text mit Markdown gliedern und formatieren: mit Überschriften, Listen, Tabellen, Links und hervorgehobenen Stellen. Markdown wird als gewöhnlicher Text geschrieben und beim Anzeigen automatisch umgesetzt.

Diese Seite zeigt links die Schreibweise und rechts das Ergebnis. Beschrieben ist genau das, was in unseren Anwendungen unterstützt wird. Im Internet finden sich viele Markdown-Übersichten, die zusätzliche Schreibweisen zeigen. Ein Teil davon funktioniert hier nicht, siehe Was nicht unterstützt wird.

Hervorhebungen

So schreiben Sie	So sieht es aus
`fett`	fett
`kursiv`	kursiv
`*fett und kursiv*`	*fett und kursiv*
`~~durchgestrichen~~`	~~durchgestrichen~~
`feste Zeichenbreite`	`feste Zeichenbreite`

Absätze und Zeilenumbrüche

Ein einzelner Zeilenumbruch (einmal Enter) wird als Zeilenumbruch dargestellt. Eine Leerzeile (zweimal Enter) beginnt einen neuen Absatz mit etwas mehr Abstand.

So schreiben Sie So sieht es aus

Erste Zeile
Zweite Zeile

Erste Zeile
Zweite Zeile

Erster Absatz

Zweiter Absatz

Erster Absatz

Zweiter Absatz

Mehrfaches Enter hilft nicht

Drei oder mehr Leerzeilen wirken genau wie eine einzelne. Der Abstand lässt sich also nicht durch wiederholtes Drücken der Eingabetaste vergrössern.

Überschriften

Überschriften beginnen mit einem oder mehreren Rautezeichen, gefolgt von einem Leerzeichen. Es gibt sechs Ebenen.

So schreiben Sie	So sieht es aus
`# Ebene 1`	Ebene 1
`## Ebene 2`	Ebene 2
`### Ebene 3`	Ebene 3
`#### Ebene 4`	Ebene 4
`###### Ebene 6`	Ebene 6

Ab der vierten Ebene bleibt die Schriftgrösse gleich wie im Fliesstext. Die Ebenen unterscheiden sich dann über Schriftschnitt und Farbe.

Listen

Aufzählungen beginnen mit einem Bindestrich, nummerierte Listen mit 1.. Untereinträge werden eingerückt.

So schreiben Sie	So sieht es aus
`- Erster Punkt - Zweiter Punkt - Untereintrag`	Erster Punkt Zweiter Punkt Untereintrag
`1. Erster Schritt 2. Zweiter Schritt 1. Teilschritt`	Erster Schritt Zweiter Schritt Teilschritt

Bei nummerierten Listen wechselt die Zählweise pro Ebene: Ziffern, dann kleine römische Zahlen, dann Buchstaben.

Wie weit einrücken?

Ein Untereintrag muss so weit eingerückt sein, wie das Listenzeichen des übergeordneten Eintrags samt folgendem Leerzeichen breit ist: bei - sind das zwei Leerzeichen, bei 1. drei und bei zweistelligen Nummern wie 10. vier. Wird zu wenig eingerückt, entsteht keine Unterebene, sondern ein weiterer Eintrag auf derselben Ebene.

Aufgabenlisten

So schreiben Sie	So sieht es aus
`- [x] erledigt - [ ] offen`	☑ erledigt ☐ offen

Die Kästchen dienen der Darstellung und lassen sich nicht anklicken. Der Status wird im Text gepflegt, also durch Setzen oder Entfernen des x.

Links und Bilder

So schreiben Sie	So sieht es aus
`[Byron Informatik](https://www.byron.ch)`	Byron Informatik
`https://www.byron.ch`	https://www.byron.ch
`![Grundriss](bild.png)`

Eine Adresse, die direkt im Text steht, wird ebenfalls automatisch zu einem Link. Bilder werden auf die verfügbare Breite verkleinert.

Zitate

Zitate beginnen mit einem Grösserzeichen. Sie eignen sich, um fremde Aussagen oder Auszüge aus einer Meldung abzusetzen.

So schreiben Sie	So sieht es aus
`> Rückmeldung vom Freitag. > > Zweiter Absatz im Zitat.`	Rückmeldung vom Freitag. Zweiter Absatz im Zitat.
`> Meldung des Kunden. > > > Antwort des Hauswarts.`	Meldung des Kunden. Antwort des Hauswarts.

Zitate lassen sich schachteln, indem ein weiteres Grösserzeichen vorangestellt wird. Das eignet sich, um einen Verlauf abzubilden, etwa eine Meldung und die Antwort darauf. Jede Ebene wird etwas blasser dargestellt, tiefer als zwei Ebenen wird es deshalb schwer lesbar.

Tabellen

Spalten werden mit senkrechten Strichen getrennt, die zweite Zeile trennt Kopf und Inhalt.

So schreiben Sie So sieht es aus

| Gerät    | Status |
| -------- | ------ |
| BY-HE-01 | Fehler |
| BY-NE-02 | OK     |

Gerät	Status
BY-HE-01	Fehler
BY-NE-02	OK

Die Striche müssen nicht bündig untereinander stehen, das erleichtert aber das Lesen im Eingabefeld. Ist eine Tabelle breiter als der verfügbare Platz, lässt sie sich seitlich scrollen.

Code und feste Zeichenbreite

Für einzelne Ausdrücke im Fliesstext genügen Rückwärts-Anführungszeichen. Für mehrzeilige Abschnitte werden drei davon als Klammer verwendet. Folgt nach den öffnenden Zeichen eine Sprache, werden Schlüsselwörter farbig hervorgehoben.

So schreiben Sie	So sieht es aus
Der Wert `3.14.2` ist neu.	Der Wert `3.14.2` ist neu.
```sql SELECT Id FROM Reader; ```	`SELECT Id FROM Reader;`
``` C:\Temp\ablage ```	`C:\Temp\ablage`

Ohne Sprachangabe bleibt der Abschnitt farblos, behält aber die feste Zeichenbreite. Das ist die richtige Wahl für Pfade, Protokollauszüge und alles, wo Leerzeichen erhalten bleiben sollen.

Trennlinie

So schreiben Sie	So sieht es aus
`Text davor --- Text danach`	Text davor Text danach

Weitere Formatierungen mit HTML

Einige Formatierungen kennt Markdown nicht. Dafür lässt sich HTML direkt in den Text schreiben.

So schreiben Sie	So sieht es aus
`<kbd>Strg</kbd> + <kbd>C</kbd>`	`Strg` + `C`
`m<sup>2</sup>`	m²
`H<sub>2</sub>O`	H₂O
`<abbr title="Zutrittskontrollsystem">ZKS</abbr>`	ZKS
`<details> <summary>Mehr</summary> Inhalt </details>`	Mehr Inhalt
`<mark>hervorgehoben</mark>`	hervorgehoben
`<span class="colorWarn">dringend</span>`	dringend

HTML ist auf einen sicheren Teil beschränkt

Aus Sicherheitsgründen wird eingebettetes HTML gefiltert. Erlaubt sind Formatierungen wie die oben genannten sowie Links, Tabellen und Bilder. Entfernt werden Skripte und eigene Formatierungen über das Attribut style. Eine fest eingetragene Farbe wie style="color: red" wird also nicht übernommen.

Text einfärben über Klassen

Das Attribut class bleibt erhalten. Damit stehen die Gestaltungsklassen der jeweiligen Anwendung zur Verfügung, zum Beispiel colorWarn für eine Warnfarbe oder colorPrimary für die Hauptfarbe:

<span class="colorWarn">dringend</span>

Das ist einer fest eingetragenen Farbe vorzuziehen, denn die Darstellung folgt dem Farbschema der Anwendung und bleibt im hellen wie im dunklen Modus lesbar. Welche Klassen verfügbar sind, hängt von der Anwendung ab.

Was nicht unterstützt wird

Verbreitete Markdown-Übersichten führen unter „Extended Syntax" Schreibweisen auf, die hier nicht umgesetzt werden. Die mittlere Spalte zeigt, was stattdessen erscheint, die rechte den Weg, der hier zum Ziel führt.

So schreiben Sie	So sieht es aus	Besser so
`==hervorgehoben==`	==hervorgehoben==	`<mark>hervorgehoben</mark>` hervorgehoben
`X^2^`	X^2^	`X<sup>2</sup>` X²
`H~2~O`	H2O	`H<sub>2</sub>O` H₂O
`Lustig :joy:`	Lustig :joy:	Das Zeichen direkt einfügen Lustig 😀
`Begriff : Erklärung`	Begriff : Erklärung	Fetter Begriff mit Umbruch, oder eine Tabelle Begriff Erklärung
`Text[^1] [^1]: Die Fussnote.`	Text[^1] [^1]: Die Fussnote.	Von Hand, mit hochgestellter Ziffer und einer Zeile am Schluss Text¹
`### Titel {#id}`	Titel {#id}	Kein Ersatz, Sprungmarken gibt es hier nicht