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 [15.10.2025 05:34] (aktuell) – alte Version wiederhergestellt (10.06.2025 10:42) Michael Wegener | ||
|---|---|---|---|
| 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:// | ||
| + | </ | ||
| - | <code java> | + | **Ergebnis:**\\ |
| - | /** | + | {{wiki: |
| - | * The HelloWorldApp class implements an application that | + | {{wiki: |
| - | * simply displays "Hello World!" | + | {{wiki: |
| - | */ | + | {{https:// |
| - | class HelloWorldApp | + | |
| - | | + | ==== Bildausrichtung ==== |
| - | | + | < |
| - | } | + | {{ wiki: |
| - | } | + | {{wiki: |
| + | {{ wiki: | ||
| </ | </ | ||
| - | Es werden folgende Sprachen unterstützt: | + | **Ergebnis:** |
| - | ===== 1.6 Zitat / Kommentar ===== | + | {{ wiki:dokuwiki-128.png}} |
| - | Um einen Text als Zitat oder Kommentar zu kennzeichnen, | + | |
| - | Ich denke wir sollten es tun. | + | {{wiki: |
| - | + | ||
| - | > Nein, sollten wir nicht. | + | |
| - | + | ||
| - | >> Doch! | + | |
| - | + | ||
| - | > Wirklich? | + | |
| - | + | ||
| - | >> Ja! | + | |
| - | + | ||
| - | >>> | + | |
| - | + | ||
| - | >>> | + | |
| - | Ich denke wir sollten es tun | + | {{ wiki: |
| - | > Nein, sollten wir nicht. | + | ==== Bildtitel und Alt-Text ==== |
| + | <code> | ||
| + | {{ wiki: | ||
| + | </ | ||
| - | >> Doch! | + | **Ergebnis: |
| + | {{ wiki: | ||
| - | > Wirklich? | + | ==== Unterstützte Medienformate ==== |
| - | >> Ja! | + | ^ Typ ^ Formate ^ |
| + | | **Bilder** | '' | ||
| + | | **Video** | '' | ||
| + | | **Audio** | '' | ||
| + | | **Flash** | '' | ||
| - | >>> Dann lass es uns tun | + | ==== Nur-Link zu Medien ==== |
| + | <code> | ||
| + | {{wiki: | ||
| + | </code> | ||
| - | >>> | + | **Ergebnis:**\\ |
| - | + | {{wiki:dokuwiki-128.png? | |
| - | ===== 1.7 Escapezeichen ===== | + | |
| - | Will man verhindern, dass DokuWiki irgendwelche Formatierungen am bzw. Umwandlungen im Text vornimmt so kann man die Prozentzeichen benutzen | + | |
| - | < | + | |
| - | Die Ausgabe würde dann folgendermaßen aussehen %%[[wiki:testseite|Testseite]]%% | + | |
| - | ===== 1.8 Fußnoten ===== | + | ==== Fallback-Formate für Videos |
| + | Laden Sie mehrere Formate hoch (z.B. '' | ||
| - | Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote)). Der Text zwischen den Klammern wird an das Ende der Seite geschrieben. Die Reihenfolge und somit die Nummerierung übernimmt DokuWiki. | + | ---- |
| - | Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote)) | + | ===== 5. Listen ===== |
| - | ====== 2 Links ====== | + | ==== Ungeordnete Listen |
| + | < | ||
| + | * Dies ist eine Liste | ||
| + | * Der zweite Punkt | ||
| + | * Sie können verschiedene Ebenen haben | ||
| + | * Noch ein Unterpunkt | ||
| + | * Ein weiterer Punkt | ||
| + | </ | ||
| - | Mit DokuWiki können fünf unterschiedliche Arten von Links benutzt werden: | + | **Ergebnis:** |
| + | * Dies ist eine Liste | ||
| + | * Der zweite Punkt | ||
| + | * Sie können verschiedene Ebenen haben | ||
| + | * Noch ein Unterpunkt | ||
| + | * Ein weiterer Punkt | ||
| - | ===== 2.1 Extern ===== | + | ==== Geordnete Listen |
| + | < | ||
| + | - Die gleiche Liste, aber nummeriert | ||
| + | - Ein weiterer Punkt | ||
| + | - Verwenden Sie Einrückung für tiefere Ebenen | ||
| + | - Das war' | ||
| + | - Zurück zur ersten Ebene | ||
| + | </ | ||
| - | Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http:// | + | **Ergebnis:** |
| - | Verweise können auch hinter eigenen Begriffen versteckt werden: [[http:// | + | - Die gleiche Liste, aber nummeriert |
| - | E-Mail Adressen werden in spitze Klammern gesetzt: < | + | - Ein weiterer Punkt |
| + | - Verwenden Sie Einrückung für tiefere Ebenen | ||
| + | - Das war' | ||
| + | - Zurück zur ersten Ebene | ||
| - | Externe Links werden automatisch erkannt: http:// | + | ==== Gemischte Listen ==== |
| - | | + | < |
| - | | + | |
| + | | ||
| + | - Noch einer | ||
| + | * Zurück zu ungeordnet | ||
| + | </code> | ||
| - | ===== 2.2 Intern ===== | + | **Ergebnis: |
| + | * Ungeordnet | ||
| + | - Geordnet | ||
| + | - Noch einer | ||
| + | * Zurück zu ungeordnet | ||
| - | Interne Links, also Verweise auf Seiten innerhalb von DokuWiki, werden in doppelten eckigen Klammern gesetzt ("Alt Gr+8" bzw. Alt Gr+9 unter Windows bzw. Wahltaste+5 und Wahltaste+6 bei Apple-Betriebssystemen): | + | ---- |
| - | [[doku> | + | |
| - | Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden: | + | ===== 6. Tabellen ===== |
| - | [[pagename|Beschreibung für einen Link]]. | + | |
| - | Interne Links werden in doppelten eckigen Klammern gesetzt: | + | ==== Grundlegende Tabellensyntax ==== |
| - | | + | < |
| - | + | ^ Überschrift 1 ^ Überschrift 2 ^ Überschrift 3 ^ | |
| - | | + | | Zeile 1 Sp 1 | Zeile 1 Sp 2 | Zeile 1 Sp 3 | |
| - | | + | | Zeile 2 Sp 1 |
| + | </ | ||
| - | Dateinamen für neue Seiten im Wiki werden automatisch in Kleinbuchstaben umgewandelt! | + | **Ergebnis: |
| - | Umlaute sind genauso wie Sonderzeichen nicht erlaubt! | + | ^ Ü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 | | ||
| - | Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst: [[de: | + | ==== 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 | | ||
| + | </ | ||
| - | Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst:[[de: | + | **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 | | ||
| - | Weitere Informationen zu Namensbereichen: | + | ==== 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 | | ||
| + | </code> | ||
| - | Die Verlinkung zu einem speziellen Abschnitt innerhalb des Dokuments (Anker) ist auch möglich. Der Abschnittsnamen wird getrennt durch ein Doppelkreuz (#) an den Seitennamen gehängt. | + | **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 | | ||
| - | Dieses Beispiel verlinkt zu [[de:wiki:syntax# | + | ==== 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 | | ||
| + | </ | ||
| - | Dieses Beispiel verlinkt zu [[de:wiki:syntax# | + | **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 | | ||
| + | </ | ||
| - | Anmerkungen: | + | **Ergebnis:** |
| + | ^ | ||
| + | | rechts| | ||
| + | |links | ||
| + | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
| - | | + | **Ausrichtungsregeln:** |
| - | | + | |
| - | * Ändert sich eine Überschrift im Zieldokument, | + | * **Linksbündig: |
| - | * Anker werden klein geschrieben, | + | * **Zentriert: |
| - | ===== 2.3 Interwiki ===== | + | ---- |
| - | DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku> | + | ===== 7. Code und Formatierung ===== |
| - | Ein Link zur Wikipedia Seite über Wikis: | + | |
| - | DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku>de: | + | ==== Inline-Code ==== |
| - | Ein Link zur Wikipedia Seite über Wikis: | + | <code> |
| + | Dies ist '' | ||
| + | </code> | ||
| - | ===== 2.4 Windows-Freigaben ===== | + | **Ergebnis: |
| + | Dies ist '' | ||
| - | DokuWiki kennt auch Links auf Windows-Freigaben: [[\\server\freigabe|freigegebener-Ordner]]. | + | ==== Code-Blöcke ==== |
| - | Dies ist allerdings nur in einer homogenen Benutzergruppe sinnvoll (siehe [[wpde>Intranet]]). | + | **Ergebnis:** |
| + | < | ||
| + | Dies ist vorformatierter Code, alle Leerzeichen bleiben erhalten: wie <-hier | ||
| + | </code> | ||
| - | [[\\server\freigabe|this]]. | + | ==== Datei-Blöcke ==== |
| + | < | ||
| + | < | ||
| + | Dies ist ziemlich dasselbe, aber Sie könnten es verwenden, um zu zeigen, dass Sie eine Datei zitiert haben. | ||
| + | </ | ||
| + | </ | ||
| - | Hinweis: | + | **Ergebnis:** |
| - | | + | <file> |
| - | * Für Mozilla und Firefox kann es durch die Option [[http:// | + | Dies ist ziemlich dasselbe, aber Sie könnten es verwenden, um zu zeigen, dass Sie eine Datei zitiert haben. |
| - | * Opera ignoriert als Sicherheitsfeature seit [[http:// | + | </file> |
| - | * Für weitere Informationen siehe: [[bug>151]] | + | |
| - | ===== 2.5 Bilder als Links ===== | + | ==== Syntax-Highlighting |
| + | < | ||
| + | <code java> | ||
| + | /** | ||
| + | * Die HelloWorldApp-Klasse implementiert eine Anwendung, die | ||
| + | * einfach "Hello World!" | ||
| + | */ | ||
| + | class HelloWorldApp { | ||
| + | public static void main(String[] args) { | ||
| + | System.out.println(" | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| + | </ | ||
| - | Bilder können für einen Link auf eine interne oder externe Datei verwendet werden. Dazu wird die Syntax zur Anzeige von Links einfach | + | **Ergebnis: |
| + | <code java> | ||
| + | /** | ||
| + | * Die HelloWorldApp-Klasse implementiert | ||
| + | | ||
| + | */ | ||
| + | class HelloWorldApp { | ||
| + | public static void main(String[] args) { | ||
| + | System.out.println(" | ||
| + | } | ||
| + | } | ||
| + | </ | ||
| - | | + | ==== Unterstützte Sprachen für Syntax-Highlighting ==== |
| + | '' | ||