Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
wiki:syntax [21.09.2015 12:18] – Michael Wegener | wiki:syntax [02.07.2025 05:40] (aktuell) – Mermaid Plugin Syntax-Dokumentation hinzugefügt Jane Alesi | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | < | + | ====== |
- | ====== | + | |
- | [[DokuWiki]] zeichnet sich u. a. durch einfache Textformatierungen aus. Dadurch bleiben die Dateien, die den Inhalt enthalten, gut lesbar. | + | **Basierend auf DokuWiki |
- | In den nachfolgenden Abschnitten sind die möglichen Formatierungsarten aufgelistet, | + | |
- | Ein erstes Beispiel, wie der Aufbau einer Seite aussehen kann, findest du, wenn du dir diese Seite im Quelltext-Modus anzeigen lässt. Klicke dazu auf den Button | + | |
- | Zum Ausprobieren oder Üben kann die [[playground: | + | ---- |
+ | ===== Systemkonfiguration ===== | ||
+ | * **DokuWiki Version:** 2024-02-06b " | ||
+ | * **Template: | ||
+ | * **Installierte Plugins:** 25+ aktive Erweiterungen | ||
+ | * **PHP-Kompatibilität: | ||
- | ====== 1 Texte ====== | + | ---- |
- | ===== 1.1 Formatierungen ===== | + | |
- | DokuWiki unterstützt **fetten**, // | + | ===== 1. Grundlegende Textformatierung ===== |
- | | + | ==== Textauszeichnung ==== |
- | Natürlich | + | < |
+ | DokuWiki unterstützt **fett**, //kursiv//, __unterstrichen__ | ||
+ | Natürlich | ||
+ | </ | ||
- | Ebenso gibt es < | + | **Ergebnis: |
+ | DokuWiki unterstützt **fett**, | ||
+ | Natürlich können Sie **__//'' | ||
- | Ebenso gibt es <sub>tiefgestellten</ | + | ==== Hoch- und Tiefstellung ==== |
+ | < | ||
+ | Sie können | ||
+ | Beispiel: H< | ||
+ | </ | ||
- | Text kann als <del>gelöscht</del>((wer das Tag " | + | **Ergebnis: |
+ | Beispiel: H< | ||
- | | + | ==== Durchgestrichener |
+ | < | ||
+ | Sie können etwas als < | ||
+ | </ | ||
- | ===== 1.2 Absätze ===== | + | **Ergebnis: |
- | Ein Absatz wird durch eine leere Zeile erzeugt. Eine neue Zeile (Zeilenumbruch) kann durch zwei "Backslashes" (umgekehrte Schrägstriche: | + | ==== Zeilenumbrüche und Absätze ==== |
+ | < | ||
+ | Dies ist Text mit Zeilenumbrüchen\\ | ||
+ | Beachten Sie, dass die zwei Backslashes | ||
+ | oder gefolgt von\\ einem Leerzeichen | ||
+ | </ | ||
- | Dies ist ein Beispieltext | + | **Ergebnis: |
- | werden nur erkannt, wenn sie am Zeilenende | + | Dies ist Text mit Zeilenumbrüchen\\ |
- | oder wenn ihnen ein\\ Leerzeichen | + | Beachten Sie, dass die zwei Backslashes nur am Zeilenende\\ |
+ | oder gefolgt von\\ einem Leerzeichen | ||
- | Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.\\ Beachte: Die zwei umgekehrten Schrägstriche | + | **Wichtig:** Verwenden Sie erzwungene Zeilenumbrüche |
- | werden | + | |
- | oder wenn ihnen ein\\ Leerzeichen folgt.\\ So\\sieht es ohne Leerzeichen aus. | + | |
- | Zeilenumbrüche durch zwei " | + | ---- |
- | ===== 1.3 Überschriften ===== | + | ===== 2. Überschriften |
- | Mit fünf unterschiedlichen Ebenen, getrennt durch Überschriften, | + | |
- | Die Überschriften werden mit maximal sechs " | + | |
- | Es ist __sinnvoll__, | + | ==== Überschriftenebenen ==== |
+ | < | ||
+ | ====== Ebene 1 (Hauptüberschrift) ====== | ||
+ | ===== Ebene 2 ===== | ||
+ | ==== Ebene 3 ==== | ||
+ | === Ebene 4 === | ||
+ | == Ebene 5 == | ||
+ | </ | ||
- | Wenn in einer Seite mehr als drei Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet. | + | **Ergebnis:** |
- | Soll dieses Inhaltsverzeichnis nicht erstellt werden, muss der Befehl: ''< | + | ====== Ebene 1 (Hauptüberschrift) ====== |
+ | ===== Ebene 2 ===== | ||
+ | ==== Ebene 3 ==== | ||
+ | === Ebene 4 === | ||
+ | == Ebene 5 == | ||
- | | + | ==== Automatisches Inhaltsverzeichnis |
- | | + | |
- | ==== Überschrift Ebene 3 ==== | + | |
- | | + | |
- | == Überschrift Ebene 5 == | + | |
- | Innerhalb von Überschriften können standardmäßig keine weiteren Formatierungen vorgenommen werden! (s. [[faq: | + | ==== Horizontale Linie ==== |
+ | < | ||
+ | ---- | ||
+ | </ | ||
- | ===== 1.4 unformatierte Abschnitte ===== | + | **Ergebnis: |
+ | ---- | ||
+ | |||
+ | Vier oder mehr Bindestriche erzeugen eine horizontale Linie. | ||
+ | |||
+ | ---- | ||
- | Um Text so anzuzeigen, wie er geschrieben wurde, egal ob er DokuWiki Formatierungen oder andere Formatierungen enthält, kann man jede | + | ===== 3. Links ===== |
- | Zeile mit zwei Leerzeichen beginnen (so wie es in dieser Seite angewendet wurde) oder einen der Bezeichner " | + | |
+ | ==== Externe Links ==== | ||
< | < | ||
- | Mit " | + | http:// |
+ | [[http:// | ||
+ | [[http:// | ||
+ | <andi@splitbrain.org> | ||
</ | </ | ||
+ | **Ergebnis: | ||
+ | http:// | ||
+ | [[http:// | ||
+ | [[http:// | ||
+ | < | ||
- | | + | ==== Interne Links ==== |
- | Mit dem Bezeichner " | + | <code> |
- | auf einer Seite zum Download angeboten werden. | + | [[seitenname]] |
- | </file> | + | [[seitenname|Link-Text]] |
+ | [[namespace: | ||
+ | [[syntax# | ||
+ | </code> | ||
- | Innerhalb von " | + | **Ergebnis: |
+ | [[seitenname]]\\ | ||
+ | [[seitenname|Link-Text]]\\ | ||
+ | [[namespace: | ||
+ | [[syntax# | ||
- | <file perl HelloWorld.pl> | + | ==== Interwiki-Links ==== |
- | # | + | <code> |
- | print "Hello World!\n"; | + | [[doku> |
- | </file> | + | [[wp> |
+ | </code> | ||
- | <file perl HelloWorld.pl> | + | **Ergebnis: |
- | # | + | [[doku> |
- | print "Hello World!\n"; | + | [[wp>Wiki]] |
- | </ | + | |
- | Um jegliche Umwandlung durch DokuWiki abzustellen, | + | ==== Windows-Freigaben ==== |
+ | <code> | ||
+ | [[\\server\freigabe|Diese Freigabe]] | ||
+ | </code> | ||
- | < | + | **Ergebnis:**\\ |
- | Dieser Text enthält links wie: http:// | + | [[\\server\freigabe|Diese Freigabe]] |
- | </ | + | |
- | %%Dieser Text ist nun mit %%'' | + | ==== Bild-Links ==== |
+ | <code> | ||
+ | [[http:// | ||
+ | </code> | ||
- | " | + | **Ergebnis:**\\ |
+ | [[http://php.net|{{wiki: | ||
- | Einfach den Quelltext dieser Seite anschauen (den Knopf " | + | ---- |
- | ===== 1.5 Syntax-Hervorhebung | + | ===== 4. Bilder und Medien |
- | [[DokuWiki]] kennt Syntax-Highlighting für Quellcode, um dessen Lesbarkeit zu erhöhen. Dafür wird [[http://qbnz.com/highlighter/|GeSHi]] " | + | ==== Grundlegende Bildsyntax ==== |
- | Es wird der gleiche Bezeichner wie im vorherigen Abschnitt benutzt, nur dass er nun auch den Namen der Sprache enthält: | + | < |
- | ''< | + | {{wiki: |
+ | {{wiki:dokuwiki-128.png? | ||
+ | {{wiki: | ||
+ | {{https:// | ||
+ | </ | ||
+ | **Ergebnis: | ||
+ | {{wiki: | ||
+ | {{wiki: | ||
+ | {{wiki: | ||
+ | {{https:// | ||
+ | |||
+ | ==== Bildausrichtung ==== | ||
+ | < | ||
+ | {{ wiki: | ||
+ | {{wiki: | ||
+ | {{ wiki: | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | |||
+ | {{ wiki: | ||
+ | |||
+ | {{wiki: | ||
+ | |||
+ | {{ wiki: | ||
+ | |||
+ | ==== Bildtitel und Alt-Text ==== | ||
+ | < | ||
+ | {{ wiki: | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | {{ wiki: | ||
+ | |||
+ | ==== Unterstützte Medienformate ==== | ||
+ | |||
+ | ^ Typ ^ Formate ^ | ||
+ | | **Bilder** | '' | ||
+ | | **Video** | '' | ||
+ | | **Audio** | '' | ||
+ | | **Flash** | '' | ||
+ | |||
+ | ==== Nur-Link zu Medien ==== | ||
+ | < | ||
+ | {{wiki: | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | {{wiki: | ||
+ | |||
+ | ==== Fallback-Formate für Videos ==== | ||
+ | Laden Sie mehrere Formate hoch (z.B. '' | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== 5. Listen ===== | ||
+ | |||
+ | ==== Ungeordnete Listen ==== | ||
+ | < | ||
+ | * Dies ist eine Liste | ||
+ | * Der zweite Punkt | ||
+ | * Sie können verschiedene Ebenen haben | ||
+ | * Noch ein Unterpunkt | ||
+ | * Ein weiterer Punkt | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | * Dies ist eine Liste | ||
+ | * Der zweite Punkt | ||
+ | * Sie können verschiedene Ebenen haben | ||
+ | * Noch ein Unterpunkt | ||
+ | * Ein weiterer Punkt | ||
+ | |||
+ | ==== Geordnete Listen ==== | ||
+ | < | ||
+ | - Die gleiche Liste, aber nummeriert | ||
+ | - Ein weiterer Punkt | ||
+ | - Verwenden Sie Einrückung für tiefere Ebenen | ||
+ | - Das war's | ||
+ | - Zurück zur ersten Ebene | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | - Die gleiche Liste, aber nummeriert | ||
+ | - Ein weiterer Punkt | ||
+ | - Verwenden Sie Einrückung für tiefere Ebenen | ||
+ | - Das war's | ||
+ | - Zurück zur ersten Ebene | ||
+ | |||
+ | ==== Gemischte Listen ==== | ||
+ | < | ||
+ | * Ungeordnet | ||
+ | - Geordnet | ||
+ | - Noch einer | ||
+ | * Zurück zu ungeordnet | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | * Ungeordnet | ||
+ | - Geordnet | ||
+ | - Noch einer | ||
+ | * Zurück zu ungeordnet | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== 6. Tabellen ===== | ||
+ | |||
+ | ==== Grundlegende Tabellensyntax ==== | ||
+ | < | ||
+ | ^ Überschrift 1 ^ Überschrift 2 ^ Überschrift 3 ^ | ||
+ | | Zeile 1 Sp 1 | Zeile 1 Sp 2 | Zeile 1 Sp 3 | | ||
+ | | Zeile 2 Sp 1 | Zeile 2 Sp 2 | Zeile 2 Sp 3 | | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | ^ Überschrift 1 ^ Überschrift 2 ^ Überschrift 3 ^ | ||
+ | | Zeile 1 Sp 1 | Zeile 1 Sp 2 | Zeile 1 Sp 3 | | ||
+ | | Zeile 2 Sp 1 | Zeile 2 Sp 2 | Zeile 2 Sp 3 | | ||
+ | |||
+ | ==== Colspan (Zellen horizontal verbinden) ==== | ||
+ | < | ||
+ | ^ Überschrift 1 ^ Überschrift 2 ^ Überschrift 3 ^ | ||
+ | | Zeile 1 Sp 1 | Zeile 1 Sp 2 | Zeile 1 Sp 3 | | ||
+ | | Zeile 2 Sp 1 | ein colspan (beachten Sie die doppelte Pipe) || | ||
+ | | Zeile 3 Sp 1 | Zeile 3 Sp 2 | Zeile 3 Sp 3 | | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | ^ Überschrift 1 ^ Überschrift 2 ^ Überschrift 3 ^ | ||
+ | | Zeile 1 Sp 1 | Zeile 1 Sp 2 | Zeile 1 Sp 3 | | ||
+ | | Zeile 2 Sp 1 | ein colspan (beachten Sie die doppelte Pipe) || | ||
+ | | Zeile 3 Sp 1 | Zeile 3 Sp 2 | Zeile 3 Sp 3 | | ||
+ | |||
+ | ==== Vertikale Überschriften ==== | ||
+ | < | ||
+ | | ^ Überschrift 1 ^ Überschrift 2 ^ | ||
+ | ^ Überschrift 3 | Zeile 1 Sp 2 | Zeile 1 Sp 3 | | ||
+ | ^ Überschrift 4 | Zeile 2 Sp 2 | Zeile 2 Sp 3 | | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | | ^ Überschrift 1 ^ Überschrift 2 ^ | ||
+ | ^ Überschrift 3 | Zeile 1 Sp 2 | Zeile 1 Sp 3 | | ||
+ | ^ Überschrift 4 | Zeile 2 Sp 2 | Zeile 2 Sp 3 | | ||
+ | |||
+ | ==== Rowspan (Zellen vertikal verbinden) ==== | ||
+ | < | ||
+ | ^ Überschrift 1 ^ Überschrift 2 ^ Überschrift 3 ^ | ||
+ | | Zeile 1 Sp 1 | diese Zelle erstreckt sich vertikal | Zeile 1 Sp 3 | | ||
+ | | Zeile 2 Sp 1 | ::: | Zeile 2 Sp 3 | | ||
+ | | Zeile 3 Sp 1 | ::: | Zeile 3 Sp 3 | | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | ^ Überschrift 1 ^ Überschrift 2 ^ Überschrift 3 ^ | ||
+ | | Zeile 1 Sp 1 | diese Zelle erstreckt sich vertikal | Zeile 1 Sp 3 | | ||
+ | | Zeile 2 Sp 1 | ::: | Zeile 2 Sp 3 | | ||
+ | | Zeile 3 Sp 1 | ::: | Zeile 3 Sp 3 | | ||
+ | |||
+ | ==== Tabellenausrichtung ==== | ||
+ | < | ||
+ | ^ | ||
+ | | rechts| | ||
+ | |links | ||
+ | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | ^ | ||
+ | | rechts| | ||
+ | |links | ||
+ | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
+ | |||
+ | **Ausrichtungsregeln: | ||
+ | * **Rechtsbündig: | ||
+ | * **Linksbündig: | ||
+ | * **Zentriert: | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== 7. Code und Formatierung ===== | ||
+ | |||
+ | ==== Inline-Code ==== | ||
+ | < | ||
+ | Dies ist '' | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | Dies ist '' | ||
+ | |||
+ | ==== Code-Blöcke ==== | ||
+ | **Ergebnis: | ||
+ | < | ||
+ | Dies ist vorformatierter Code, alle Leerzeichen bleiben erhalten: wie <-hier | ||
+ | </ | ||
+ | |||
+ | ==== Datei-Blöcke ==== | ||
+ | < | ||
+ | < | ||
+ | Dies ist ziemlich dasselbe, aber Sie könnten es verwenden, um zu zeigen, dass Sie eine Datei zitiert haben. | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | **Ergebnis: | ||
+ | < | ||
+ | Dies ist ziemlich dasselbe, aber Sie könnten es verwenden, um zu zeigen, dass Sie eine Datei zitiert haben. | ||
+ | </ | ||
+ | |||
+ | ==== Syntax-Highlighting ==== | ||
+ | < | ||
<code java> | <code java> | ||
- | /** | + | /** |
- | | + | |
- | | + | |
*/ | */ | ||
class HelloWorldApp { | class HelloWorldApp { | ||
public static void main(String[] args) { | public static void main(String[] args) { | ||
- | System.out.println(" | + | System.out.println(" |
} | } | ||
} | } | ||
+ | </ | ||
</ | </ | ||
- | Es werden folgende Sprachen unterstützt: | + | **Ergebnis:** |
+ | <code java> | ||
+ | /** | ||
+ | * Die HelloWorldApp-Klasse implementiert eine Anwendung, die | ||
+ | * einfach "Hello World!" | ||
+ | */ | ||
+ | class HelloWorldApp { | ||
+ | public static void main(String[] args) { | ||
+ | System.out.println(" | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
- | ===== 1.6 Zitat / Kommentar ===== | + | ==== Unterstützte Sprachen für Syntax-Highlighting |
- | Um einen Text als Zitat oder Kommentar zu kennzeichnen, wird das " | + | '' |