DokuWiki zeichnet sich durch einfache Formatierungen aus. Dadurch bleiben die Dateien, die den Inhalt enthalten, gut lesbar.

Hier wird die Syntax beschrieben um Seiten zu bearbeiten.

Schau dir zum Beispiel diese Seite an, indem du den „Diese Seite bearbeiten“ Knopf oben oder unten drückst.
Zum Ausprobieren oder Üben kannst du den Spielplatz (playground) verwenden.
Einfache Formatierungen sind direkt durch Quickbuttons in der „Menüleiste“ über dem Editor erreichbar.

Diese Seite ist eine Übersetzung der Syntax-Seite aus DokuWiki (2005-07-13).
Sie ist keine wortgleiche Übersetzung. Einige Beschreibungen sind etwas ausführlicher ausgefallen. Fachbegriffe werden nur dort verwendet, wo eine Umschreibung mehr Verwirrung stiftet als nützt.
Ähnliches gilt auch für Begriffe, die dem Englischen entspringen, für manche gibt es keine direkte Übersetzungen. Oder sie sind schon so bekannt, dass eine Übersetzung unsinnig ist.
Der Übersetzer ist sich selbst nicht sicher, ob er lieber den Begriff „Link“ oder „Verweis“ benutzen soll.

An einigen Stellen befindet sich ein - hier gibt es etwas, was im Sinne des Übersetzers noch nicht gut umgesetzt wurde.

• Anregungen, Bemerkungen oder Hinweise auf Fehler sind willkommen.
• euer Sebastian Koch ⇒ mr_snede *at* web ~dot~ de

DokuWiki unterstützt fetten, kursiven, unterstrichenen und dicktengleichen Text. Natürlich kann auch alles kombiniert werden.

DokuWiki unterstützt **fetten**, //kursiven//, __unterstrichenen__ und ''dicktengleichen'' Text. 
Natürlich kann auch alles **__//''kombiniert''//__** werden.

Ebenso gibt es _{tiefgestellten} und ^{hochgestellten} Text.

Ebenso gibt es <sub>tiefgestellten</sub> und <sup>hochgestellten</sup> Text.

Text kann als gelöscht deleted¹⁾ markiert werden.

Text kann als gelöscht <del>deleted</del> markiert werden.

Ein Absatz wird durch eine leere Zeile erzeugt.
Eine neue Zeile (Zeilenumbruch) kann durch zwei "backslashes" (umgekehrte Schrägstriche: \\) gefolgt von einem Leerzeichen erzeugt werden.

Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.
Beachte: Die zwei umgekehrten Schrägstriche werden nur erkannt, wenn sie am Zeilenende stehen
oder wenn ihnen ein
Leerzeichen folgt.
So\\sieht es ohne Leerzeichen aus.

Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.\\ Beachte: Die zwei umgekehrten
Schrägstriche werden nur erkannt, wenn sie am Zeilenende stehen\\
oder wenn ihnen ein\\ Leerzeichen folgt.\\ So\\sieht es ohne Leerzeichen aus.

Zeilenumbrüche durch zwei „backslashes“ (umgekehrte Schrägstriche: \\) sollten nur verwendet werden, wenn sie unbedingt gebraucht werden.

Mit fünf unterschiedlichen Ebenen, getrennt durch Überschriften, kann der Inhalt einer Seite strukturiert werden.
Die Überschriften werden mit maximal sechs „=“ eingerahmt, je nach Größe. H1 ist die Überschrift auf höchster Ebene. Am einfachsten zur Erzeugung der Überschriften die Symbolleiste verwenden und hier auf die Buttons H1, H2 oder H3 klicken.

Es ist sinnvoll, wenn immer eine Level 1 Überschrift am Anfang eines Artikels steht.

Wenn in einer Seite mehr als 3 Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet.
Soll dieses Inhaltsverzeichnis nicht erstellt werden, muß der Befehl: ~~NOTOC~~ mit in die Seite aufgenommen werden.

====== Überschrift Ebene 1 ======
===== Überschrift Ebene 2 =====
==== Überschrift Ebene 3 ====
=== Überschrift Ebene 4 ===
== Überschrift Ebene 5 ==

Innerhalb von Überschriften können keine weiteren Formatierungen vorgenommen werden!

Um Text so anzuzeigen, wie er geschrieben wurde, egal ob er DokuWiki Formatierungen oder andere Formatierungen enthält, kann man jede Zeile mit zwei Leerzeichen beginnen (so wie es in dieser Seite angewendet wurde) oder einen der Bezeichner „code“ bzw „file“ benutzen:

Mit "code": In diesem Text werden keine überflüssigen Leerzeichen entfernt: wie hier          <-- zwischen

Mit "file": Eigentlich das Gleiche wie oben, sieht nur etwas anders aus. \\ 
Vielleicht um Zitate zu kennzeichnen oder ähnliches.

Um jegliche Umwandlung durch DokuWiki abzustellen, umschließe den entsprechenden Bereich mit „nowiki“ Bezeichnern oder kürzer mit doppelten Prozentzeichen %%.

Dieser Text enthält links wie: http://www.splitbrain.org und **Formatierungen** aber sie werden nicht umgesetzt und erscheinen als normaler Text.

Dieser Text ist nun mit %% markiert und hat die gleiche Wirkung wie "Nowiki" "Dieser Text enthält links wie: http://www.splitbrain.org und **Formatierungen** aber sie werden nicht umgesetzt und erscheinen als normaler Text."

Einfach den Quelltext dieser Seite anschauen (den Knopf „edit“ drücken) um zu sehen, wie diese Blöcke angewendet werden.

DokuWiki kennt Syntax highlighting für Quellcode, um dessen Lesbarkeit zu erhöhen. Dafür wird GeSHi „Generic Syntax Highlighter“ benutzt. Somit wird jede Programmiersprache unterstützt, die GeSHi kennt.
Es wird der gleiche Bezeichner wie im vorherigen Abschnitt benutzt, nur dass er nun auch den Namen der Sprache enthält:
<code java> Quelltext </code>

/** 
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

Es werden folgende Sprachen unterstützt:
actionscript, actionscript-french, ada, apache, applescript, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, diff, d, div, dos, eiffel, freebasic, gml, html4strict, ini, inno, java, javascript, lisp, lua, matlab, mpasm, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, scheme, sdlbasic, smarty, sql, ruby, vb, vbnet, vhdl, visualfoxpro, xml

Um einen Text als Zitat oder 'Kommentar' zu kennzeichen, wird das „größer als“ - Zeichen folgendermaßen verwendet:

Ich denke wir sollten es tun.

> Nein, sollten wir nicht.

>> Doch!

> Wirklich?

>> Ja!

>>> Dann lass es uns tun!

>>> Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text
    zeigt. Um einen Text als Zitat oder Kommentar zu kennzeichen, wird das "größer als" - Zeichen
    folgendermaßen verwendet

Ich denke wir sollten es tun

Nein, sollten wir nicht.

Doch!

Wirklich?

Ja!

Dann lass es uns tun

Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Um einen Text als Zitat oder Kommentar zu kennzeichen, wird das „größer als“ - Zeichen folgendermaßen verwendet

Will man verhindern, dass Dokuwiki irgendwelche Formatierungen am bzw. Umwandlungen am Text vornimmt so kann man die Escapezeichen benutzen

%%[[wiki:testseite|Testseite]]%%

Die Ausgabe würde dann folgendermaßen aussehen [[wiki:testseite|Testseite]]

Mit DokuWiki können 5 unterschiedliche Arten von Links benutzt werden:

Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http://www.google.com oder einfach www.google.com
Verweise können auch hinter eigenen Begriffen versteckt werden: hier ist google
E-mail Adressen werden in spitze Klammern gesetzt: andi@splitbrain.org

Externe Links werden automatisch erkannt: http://www.google.com oder einfach  www.google.com\\
Verweise können auch hinter eigenen Begriffen versteckt werden: [[http://www.google.com|hier ist google]] \\
E-mail Adressen werden in spitze Klammern gesetzt: <andi@splitbrain.org>

Interne Links, also Verweise auf Seiten innerhalb von DokuWiki, werden in doppelten eckigen Klammern gesetzt(„altgr+8“ bzw. altgr+9 auf einer win-tastatur bzw Wahltaste+5 und Wahltaste+6 bei Apple) auf:
pagename

Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden:
Beschreibung für einen Link.

Interne Links werden in doppelten eckigen Klammern gesetzt:
[[pagename]] 

Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden:
[[pagename|Beschreibung für einen Link]].

Dateinamen für neue Seiten im Wiki werden automatisch in Kleinbuchstaben umgewandelt!
Umlaute sind genauso wie Sonderzeichen nicht erlaubt!

Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst: namespaces

Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst:[[de:namespaces]] 

Weitere Informationen zu Namensbereichen: de:namespaces.

Die Verlinkung zu einem speziellen Abschnitt innerhalb des Dokuments ist auch möglich (Anker). Einfach den Abschnittsnamen hinter einem Hash-Zeichen, so wie man es in HTML kennt. Dieses Beispiel verlinkt zu diesem Abschnitt.

Dieses Beispiel verlinkt zu [[de:syntax#intern|diesem Abschnitt]].

Anmerkungen:

• Links zu existierenden Seiten werden anders angezeigt als Links zu nicht-existierenden Seiten.
• DokuWiki verwendet standardmäßig keine CamelCase für Links.
  In der Einstellungsdatei: config kann das aber geändert werden.
  Hinweis: wenn das Wort: DokuWiki als Link angezeigt wird, dann ist diese Option eingeschaltet.

DokuWiki unterstützt auch Links in andere Wikis, sogenannte de:interwiki Links.
Ein Link zur Wikipedia Seite über Wikis:Wiki

DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku>de:interwiki]] Links. \\
Ein Link zur Wikipedia Seite über Wikis:[[wpde>Wiki]]

Bilder können für einen Link auf eine interne oder externe Datei verwendet werden. Dazu wird die Syntax zur Anzeige von Links einfach mit der zur Anzeige von Bildern (siehe unten) kombiniert:

 [[http://www.php.net|{{wiki:dokuwiki-128.png}}]]

Bitte beachte: Bildformatierungen sind die einzigen Formatierungen, die in Linknamen benutzt werden können!

Bitte dazu auch das Bilder-Tutorial beachten.

Das Hochladen von Bildern muss in der Konfigurationsdatei eingeschaltet sein. Zusätzlich kann der Seitenbetreiber diese Funktion per ACL beschränken. Zum Hochladen ist mindestens die Berechtigung „Hochladen“ (engl. „Upload“), zum Löschen „Entfernen“ (engl. „Delete“) für den entsprechenden Namensraum erforderlich.

Mit geschweiften Klammern können sowohl externe als auch interne Bilder eingebunden werden. Optional kann deren Größe angegeben werden:

Original Größe:

Eine Breite vorgeben:

Breite und Höhe vorgeben:

Größe für externe Bilder vorgeben:

Original Größe:                        {{wiki:dokuwiki-128.png}}
Eine Breite vorgeben:                  {{wiki:dokuwiki-128.png?50}}
Breite und Höhe vorgeben:              {{wiki:dokuwiki-128.png?200x50}}
Größe für externe Bilder vorgeben:     {{http://de3.php.net/images/php.gif?200x50}}

Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden(links, mitte, rechts).

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

bei Ausrichtung und der Verwendung eines Titels sollte man drauf achten dass der Titel nach dem Leerzeichen kommt

{{ wiki:dokuwiki-128.png|Rechtsbündig}}
{{wiki:dokuwiki-128.png |Linksbündig}}
{{ wiki:dokuwiki-128.png |Zentriert}}

Weitere Möglichkeiten siehe Bilder-Tutorial

Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden.

{{ wiki:dokuwiki-128.png |Dies ist ein Titel}}

Wenn eine Datei angegeben wird, die kein Bild (gif,jpeg,png) ist, so wird sie als Link angezeigt und so zum Download angeboten.

Beispiel

Bilder werden automatisch mit einer Verlinkung zur Ihren Metadaten erstellt - Bsp.:

Dieses Verhalten kann über die Option ?nolink²⁾ unterbunden werden³⁾:

{{wiki:dokuwiki-128.png?15&nolink}}

Ausserdem kann mit ?direct das Bild, z.Bsp. als Vollansicht, direkt verlinkt werden:

{{wiki:dokuwiki-128.png?15&direct}}

DokuWiki kennt unsortierte und nummerierte Listen. Um einen Listeneintrag zu erzeugen, beginne eine Zeile mit 2 Leerzeichen. Diesen Leerzeichen folgt dann ein „*“ für unsortierte oder ein „-“ für nummerierte Listen.

• Dies ist ein Eintrag einer unsortierten Liste
• Ein zweiter Eintrag
  • Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen
• Noch ein Eintrag

1. Dies ist ein Eintrag einer nummerierte Liste
2. Ein zweiter Eintrag
   1. Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen
3. Noch ein Eintrag

  * Dies ist ein Eintrag einer unsortierten Liste
  * Ein zweiter Eintrag
    * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen
  * Noch ein Eintrag

  - Dies ist ein Eintrag einer nummerierte Liste
  - Ein zweiter Eintrag
    - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen
  - Noch ein Eintrag

Mit DokuWiki können Tabellen ganz einfach erstellt werden:

Felder einer Tabelle starten mit „|“ für ein normales Feld oder mit einem „^“ für hervorgehobenes Feld.

^ hervorgehoben       ^ zum Beispiel für                                                  ^ eine Titelzeile         ^
| Zeile 1 Spalte 1    | Zeile 1 Spalte 2                                                  | Zeile 1 Spalte 3        |
| Zeile 2 Spalte 1    | doppelte Spaltenbreite (beachte den doppelten senkrechten Strich) ||
| Zeile 3 Spalte 1    | Zeile2 Spalte 2                                                   | Zeile 2 Spalte 3        |

Zellen über mehrere Spalten werden erzeugt, wenn man, wie oben gezeigt, am Ende einer solchen Spalte soviele „|“ oder „^“ ohne Leerzeichen dazwischen hintereinander setzt, wie Spalten überbrückt werden.
Kurz gesagt: Alle Zeilen einer Tabelle müssen die gleiche Anzahl an Feldtrennern „|“ oder „^“ haben.

Hervorgehobene Felder in Vertikaler Ausrichtung sind auch möglich.

Wie wir sehen, entscheidet der Feldtrenner („|“ oder „^“) vor einer Zelle über ihr Aussehen:

|                    ^ hervorgehoben 1           ^ hervorgehoben 2         ^
^ hervorgehoben 3    | Zeile 1 Spalte 2          | Zeile 1 Spalte 3        |
^ hervorgehoben 4    | Zeile 2 Spalte 2          |                         |
^ hervorgehoben 5    | Zeile 3 Spalte 2          | Zeile 3 Spalte 3        |

Felder über mehrere Zeilen (vertikal verbundene Zellen) lassen sich durch hinzufügen von ::: in der zu verbindenden Zelle zusammenfügen.

Außer den drei Doppelpunkten darf die zu verbindende Zelle keine weiteren Inhalte haben.

^ Titelzeile 1        ^ Titelzeile 2                       ^ Titelzeile 3            ^
| Zeile 1 Spalte 1    | Diese Zelle ist vertikal verbunden | Zeile 1 Spalte 3        |
| Zeile 2 Spalte 1    | :::                                | Zeile 2 Spalte 3        |
| Zeile 3 Spalte 1    | :::                                | Zeile 3 Spalte 3        |

• Der Inhalt einer Zelle kann horizontal ausgerichtet werden. Füge 2 Leerzeichen hinzu:
  
  • 2 Leerzeichen Links vom Text: rechtsbündig
  • 2 Leerzeichen Rechts vom Text: linksbündig
  • 2 Leerzeichen Links und Rechts vom Text: zentriert

So sieht die Formatierung aus:

^          Tabelle mit Ausrichtung         ^^^
|        Rechts|    Mitte     |Links         |
|Links         |        Rechts|    Mitte     |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Fußnoten ⁴⁾ werden durch eine doppelte runde Klammer dargestellt ⁵⁾. 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))

Mit 4 aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden:

----

Dokuwiki verwandelt oft genutzte Emoticons zu kleinen Smily-Grafiken.
Weitere Smiley-Grafiken können im Ordner „smily“ abgelegt und dann in der Datei conf/smileys.conf eingetragen werden.
Hier ist nun eine Übersicht der standardmäßig in DokuWiki enthaltenen Smileys:

8-)	8-O	:-(	:-)	=)	:-/	:-\	:-?	:-D	:-P	:-O	:-X	:-|	;-)	:?:	:!:	^_^	LOL	FIXME	DELETEME

DokuWiki kann einfache Textzeichen in ihre typografischen Entsprechungen umwandeln.
Hier eine Liste aller Zeichen, die DokuWiki kennt:

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® „He thought 'It's a man's world'…“

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

Die sogenannten Non-Bracking-Spaces können wie folgt erzeugt werden:

 (nbsp)         

Manche Syntax Befehle beeinflussen wie Dokuwiki eine Seite bei jedem Aufruf ausgibt. Die folgenden Kontroll Makros sind verfügbar:

DokuWikis Syntax kann durch Plugins erweitert werden. Wie die einzelnen Plugins benutzt werden, steht auf deren Beschreibungsseiten. Die folgenden Plugins sind auf dieser DokuWiki Installation verfügbar:

• ACSV Plugin 2015-02-26 von Andreas Gohr (+MW Feb.2015)
  Displays a CSV file, or inline CSV data, as a table (+spez.features ;)
• awtools plugin 2015-03-07 von MWanke
  einige Erweiterungen fuer amigawiki
• Changes Plugin 2023-12-14 von Andreas Gohr
  List the most recent changes of the wiki
• hidepages plugin 2013-08-02 von Matthias Schulte
  Hide pages from search results and/or sitemap
• htmlmetatags plugin 2024-03-04 von Heiko Heinz
  Set html and open graph meta tags.
• Plugin imagebox 2023-08-21 von Lukas Rademacher, CvH, Dr-Yukon, FFTiger & myst6re
  Syntax for display an image with a caption, like Wikipedia.org
• include plugin 2023-09-22 von Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
  Functions to include another page in a wiki page
• Info Plugin 2020-06-04 von Andreas Gohr
  Displays information about various DokuWiki internals
• Pagelist Plugin 2023-08-27 von Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
  Lists pages in a nice formatted way
• PageQuery Plugin 2024-02-14 von Mark C. Prins, previously Symon Bent
  Search for (fulltext) and list wiki pages, sorted and optionally grouped by name, date, creator, abc, etc. in columns. Insert the pagequery markup wherever you want your list to appear. E.g.{{pagequery>[query;fulltext;sort=key:direction,key2:direction;group;limit=??;cols=?;inwords;proper]}} [..] = optional
• Tag Plugin 2023-10-17 von Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
  tag wiki pages
• Translation Plugin 2024-04-30 von Andreas Gohr
  Supports the easy setup of a multi-language wiki.

….

Wikipedia-Snippets (d.h. der erste Abschnitt vom Artikel wird von Wikipedia hier herein geladen) Syntax:

{{wp>Article_Name}}

It's intentional that it's similar to the interwiki link:

[[wp>Article_Name]]

The difference is that

• it includes the first paragraphs of the according Wikipedia page and
• it uses automatically the language of the wiki (lang)

• … Platzhalter

• BBC : vielen Foren-Besuchern bestens bekannt. Hier sind die wichtigsten eingebaut (->)

This plugin provides support for BBCode syntax within DokuWiki. BBCode is popular among discussion forums like phpBB or vBulletin. The BBCode plugin supports almost all of the phpBB implementation of BBCode.

Of course, DokuWiki's syntax is much more powerful and is more intuitive to read and write, but nevertheless, you might want to switch content from a forum to your wiki or make it easy for users coming from forums to start contributing.

Basic Formatting:

[b]bold text[/b]
[i]italic text[/i]
[u]underline[/u]
[s]deleted[/s]
[m]monospace[/m]

Code and Quoting:

[code]<?php echo $text;

[quote="Esther"]DokuWiki is great![/quote]

Links and Images:

[url=http://www.amiga4000tower.de]Home of the Amiga 4000 Tower[/url]
[img]http://www.dokuwiki.org/lib/exe/fetch.php?w=&h=&cache=cache&media=wiki%3Adokuwiki-128.png[/img]

The [url] parameter can be optionally quoted.

Lists:

[list][*]item 1[*]item 2[*]item 3[/list]
[list=1][*]item 1[*]item 2[*]item 3[/list]  attribute: 1, a, A, i or I

Text size:

[size=2]smaller text[/size]               
  attribute: CSS units (px, em, %, ...), single-digit, or keywords like small; can be optionally quoted

Text color:

[color=red]colored text[/color]             
  attribute: color name, "browser-color" name, #fff[fff] or rgb(255,255,255); can be optionally quoted

Wird nur im Editier-Modus angezeigt. Auch für Hinweise für den Autor

This tiny plugin allows you to leave notes to yourself (and other authors of your wiki) in the wiki source code that won't be shown on the wiki page. The syntax is like C and PHP:

Beispiele:

Dieser Text /* zwischen dem Schrägstrichen und den Sternchen */ ist versteckt

Wird zu:

So sieht ein Kommentar über mehrere Zeilen aus:

/**
 * @todo: rewrite this section to reflect changes made recently
 *
 * this is a longer note
 */

Das funktioniert auch:

/********** added by Esther **********/

• Images within a link aren't supported. Use DokuWiki's syntax [[http://www.some.url|{{http://www.some.url/logo.png}}]].
• Only some of the supported formats map to the ODT Plugin, namely the basic format ones, [url]/[email] and [quote]. All of the others may render without extra formatting when exporting to an ODT document.