Hilfe:Forum/Bedienung
Markdown ist eine vereinfachte Auszeichnungssprache, die häufig auf Plattformen im Programmiererumfeld, wie Twitter, Discord, GitHub oder StackOverflow verwendet wird.
Im SELFHTML-Forum kommt ebenfalls Markdown, hier in dem Dialekt kramdown zum Einsatz.
Zeichen, die in kramdown eine besondere Bedeutung haben, müssen maskiert werden, wenn sie im Text verwendet werden sollen. Das Maskierungszeichen ist der Backslash (\).
Inhaltsverzeichnis
Block- vs. Inline-Elemente
Alle Blockelemente wie Absätze, Überschriften oder Listen müssen von Leerzeilen eingeschlossen werden.
Hervorhebung
Hervorhebungen erreichen Sie, indem Sie den hervorzuhebenden Abschnitt in Asteriske oder Unterstriche einschließen. Beachten Sie, dass Sie zwischen dem hervorzuhebenden Text und den Formatierungszeichen keine Leerzeichen setzen dürfen.
| Ziel | Kramdown |
|---|---|
| Hervorhebung | *Hervorhebung*_Hervorhebung_
|
| starke Hervorhebung | **starke Hervorhebung**__starke Hervorhebung__
|
| starke Hervorhebung | ***starke Hervorhebung***___starke Hervorhebung___
|
| Die Sonderzeichen müssen Sie maskieren, wenn Sie sie im Fließtext verwenden wollen. | |
| *wichtig* _wichtig_ |
\*wichtig\*\_wichtig\_
|
| **sehr wichtig** __sehr wichtig__ |
\*\*sehr wichtig\*\*\_\_sehr wichtig\_\_
|
Im Forum gibt es oberhalb des Antwortformulars Buttons um diese Darstellung zu erzielen.
Durchstreichung
Sie können einen Text durchstreichen, indem sie ihn in jeweils zwei Tilden einschließen.
| Ziel | Kramdown |
|---|---|
| durchgestrichen | ~~durchgestrichen~~
|
Links
| Ziel | Kramdown |
|---|---|
| http://example.com | <http://example.com>
|
| Linktext | [Linktext](http://example.com)
|
Für die zweite Variante gibt es im Forum einen Button oberhalb des Antwortfeldes.
Absätze und Zeilenumbrüche
Absätze und andere Blockelemente werden in Leerzeilen eingeschlossen, für einen einfachen Zeilenumbruch setzen Sie zwei Leerzeichen an das Zeilenende.
| Ziel | Kramdown |
|---|---|
|
Absatz1 Absatz2 |
|
| Zeile1 Zeile2 |
Zeile1 Zeile2
|
Überschriften
| Ziel | Kramdown |
|---|---|
| Überschrift | # Überschrift # |
Überschrift === | |
| Überschrift | ## Überschrift ## |
Überschrift --- |
In Forumsbeiträgen sind die Überschriften letztlich dritter bzw. vierter Ordnung.
Fußnoten
Die Kombination aus [^Zahl] und [^Zahl]: erzeugt eine Fußnote. Die Nummerierung der Fußnoten beginnt bei 1, unabhängig von den gewählten Zahlen, die eigentlichen Fußnoten können als eigene Zeile in beliebiger Reihenfolge an eine beliebige Stelle des Textes gesetzt werden.
| Ziel | Kramdown |
|---|---|
Text[1]
|
Text[^1]
[^1]:Erläuterung |
Bilder
Die Syntax für Bilder ähnelt sehr der für Links.
| Ziel | Kramdown |
|---|---|
|
|
|
Für die zweite Variante gibt es im Forum einen Button oberhalb des Antwortfeldes, die Angabe für das title-Attribut kann man auch entfernen.
Code
Inline-Code wird in Backticks eingeschlossen.
| Ziel | Kramdown |
|---|---|
<html>
|
`<html>`
|
<html>
|
`<html>`{: .language-html}
|
Mehrzeilige Codebeispiele werden in drei Tilden eingeschlossen, eine optionale Sprachangabe legt Regeln für das Syntax-Highlighting fest. Dieser Codeblock wiederum muss (wie jedes Blockelement) in Leerzeilen eingeschlossen werden.
| Ziel | Kramdown |
|---|---|
<html> <head> |
~~~ <html> <head> ~~~ |
<html> <head> |
~~~ html <html> <head> ~~~ |
Die farbliche Gestaltung des Quelltextes übernimmt dabei das Tool Prism, eine Liste der möglichen Sprachen finden Sie unter https://prismjs.com/#supported-languages.
Sie können Codebespiele, die so nicht verwendet werden sollten, auszeichnen. Dazu fügen Sie der Sprachangabe das Schlüsselwort bad hinzu; für besonders gelungene Codebeispiele können Sie das Schlüsselwort good verwenden.
| Ziel | Kramdown |
|---|---|
<html> <header> |
~~~ html, bad <html> <header> ~~~ |
Der Button oberhalb des Antwortblockes schlägt situationsbedingt einen ein- oder mehrzeiligen Codeabschnitt vor. Befindet sich der Cursor unterhalb einer Leerzeile, so wird ein mehrzeiliger Codeabschnitt angeboten (3 Tilden, optionale Eingabe einer Sprache), anderenfalls wird ein einzeiliger Codeabschnitt vorgeschlagen (Backticks).
ASCII-Art
Die Auszeichnung als Code erlaubt auch die Darstellung von ASCII-Art oder Tabellen, falls die Kramdown-Umsetzung ungeeignet erscheint.
| Ziel | Kramdown |
|---|---|
| ><o(((°> | ~~~ ><o(((°> ~~~ |
Listen
Listen sind Blockelemente und müssen als solche oberhalb und unterhalb von Leerzeilen eingeschlossen sein.
ungeordnete Listen
| Ziel | Kramdown |
|---|---|
|
* Listenpunkt * Listenpunkt |
Als Aufzählungszeichen dürfen Sie den Asterisk (*), das Pluszeichen (+) sowie das Minuszeichen (-) verwenden. Die Zeichen können auch innerhalb einer Liste beliebig gewechselt werden.
Im Forum gibt es einen Button oberhalb des Antwortfeldes.
geordnete Listen
| Ziel | Kramdown |
|---|---|
|
1. Listenpunkt 2. Listenpunkt |
Die Kombination [Zahl][Punkt][Leerzeichen] erzeugt eine geordnete Liste. Möchten Sie mit einer anderen Zahl beginnen, verwenden Sie das start-Attribut {: start="4"} vor oder nach der Liste.
Möchte man einen Absatz mit einer Zahl und einem Punkt beginnen, so muss der Punkt maskiert werden.
| Ziel | Kramdown |
|---|---|
|
1995. Ein guter Jahrgang. |
1995\. Ein guter Jahrgang. |
Um zwei aufeinander folgende Listen zu erstellen, müssen Sie die erste Liste ausdrücklich beenden - dafür ist in kramdown der End-Of-Block Marker ^ vorgesehen:
* foo * bar ^ * foo * bar
Beschreibungslisten
Den dd-Elementen wird ein Doppelpunkt vorangestellt.
| Ziel | Kramdown |
|---|---|
|
Vokabel : Beschreibung |
Bei Verwendung mehrerer zusammengehörender dt-Elemente muss man wieder den Zeilenumbruch berücksichtigen, mehrere dd-Elemente kann man „einfach so“ einfügen.
| Ziel | Kramdown |
|---|---|
|
Vokabel 1
Vokabel 2
: Beschreibung
|
|
Vokabel : Beschreibung 1 : Beschreibung 2 |
Tabellen
Durch die Verwendung von Pipes (|) werden einfache Tabellen erstellt. Eine Tabelle besteht immer aus einem Tabellenkopf und einem -körper.
| Ziel | Kramdown | ||||
|---|---|---|---|---|---|
|
|th|th |---|--- |td|td |
Mit Doppelpunkten innerhalb der Trennlinien regeln Sie die Ausrichtung in der entsprechenden Spalte.
| Ziel | Kramdown | ||||||
|---|---|---|---|---|---|---|---|
|
|linksbündig | zentriert | rechtsbündig | |:-----------|:---------:|---:| |Dieser Text … | ein längerer Text | … was rechtsbündiges. |
horizontale Linien
Enthält eine Zeile ausschließlich Minus- und Leerzeichen oder ausschließlich Asteriske und Leerzeichen, so wird eine horizontale Linie erzeugt. Allerdings darf die Zeile nicht mit mehr als 4 Leerzeichen beginnen, weil sonst der folgende Text als Codeblock interpretiert wird.
| Ziel | Kramdown |
|---|---|
| |
---
|
* ** *** ** *
|
LaTeX (Mathematische Formeln)
TeX ermöglicht unter anderem das Erstellen mathematischer Formeln. Sie können die zu erstellende Formel in Dollarzeichenpaare einschließen um die Formel darzustellen.
$$ \mathrm e^{\mathrm i \pi} + 1 = 0 $$
Eine Übersicht über die LaTeX-Befehle finden Sie in der Wikipedia: de.wikipedia.org/wiki/Hilfe:TeX
\\ tun. Manche LaTeX-Konstrukte (wie \align) benötigen sogar explizit Zeilenumbrüche.
Im Selfhtml Forum interagiert allerdings der Markdown-Interpreter mit dem Mathematik-Interpreter, wodurch die Notwendigkeit entsteht, für einen Zeilenumbruch fünf Backslashes \\\\\ setzen zu müssen.Auszeichnung von Text in einer abweichenden Sprache
Um eine Textphrase als anderssprachig zu kennzeichnen, verwenden Sie im HTML das lang-Attribut.
| Ziel | Kramdown |
|---|---|
<em lang="fr">Salut!</em>
|
**Salut!**{: @fr}
|
Sie können auch ganze Absätze als anderssprachig kennzeichen.
| Ziel | Kramdown |
|---|---|
<p lang="fr">Salut!</p>
|
Salut!
|
Emojis
Durch die Eingabe eines Doppelpunktes nach einem Whitespace-Zeichen öffnet sich eine Auswahl von Emojis.
| Ziel | Kramdown |
|---|---|
| 😉 | :wink
|
Die vollständige Liste unterstützer Emojis finden Sie unter github.com/felixrieseberg/.
