Einleitung

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.

zur Übersetzung

Diese Seite ist eine Übersetzung der Syntax Seite aus DokuWiki(25.09.04).
Sie ist keine wortgleiche Übersetzung. Einige Beschreibungen sind etwas ausführlicher ausgefallen. Des weiteren versucht der Übersetzer Fachbegriffe nur dort zu verwenden 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 FIXME - 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 headstones@web.de

Basis Formatierungen

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

DokuWiki unterstützt **fetten**, //kursiven//, __unterstrichenen__ und ''monospaced'' Texte. 
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.

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.

Links

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

1. Extern

Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http://www.google.com oder einfach www.google.com
Natürlich können Verweise auch hinter eigenen Begriffen versteckt werden: Dieser Link führt zu 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\\
Natürlich können Verweise auch hinter eigenen Begriffen versteckt werden: [[http://www.google.com|This Link points to google]] \\
E-mail Adressen werden in spitze Klammern gesetzt: <andi@splitbrain.org>

2. Intern

Interne Links, also Verweise auf Seiten die mit DokuWiki erstellt wurden, werden in doppelten eckigen Klammern gesetzt: wiki: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: [[doku>wiki:pagename]] 
Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden:[[doku>wiki:pagename|Beschreibung für einen Link]].

Dateinamen für neue Seiten im Wiki werden automatisch in Kleinbuchstaben umgewanderlt!
Umlaute sind genauso wie Sonderzeichen nicht erlaubt! (Verweis auf erlaubte Zeichen in Dateinamen - englisch)

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

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

Weitere Informationen zu Namensbereichen: wiki:namespaces.

Anmerkungen:

3. Interwiki

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

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

4. Windows Freigaben

DokuWiki kennt auch Links auf Windows Freigaben: freigegebener-Ordner.
Dies macht allerdings nur in einer homogenen Benutzergruppe Sinn:Intranet.

DokuWiki kennt auch Links auf Windows Freigaben: [[\\server\freigabe|this]].

Hinweis:

  • Aus Sicherheitsgründen funktioniert direktes Navigieren durch Windowsfreigaben nur mit dem Internet Explorer!
  • For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer (steht hier noch, da mir die Übersetzung noch nicht gefällt - sabba FIXME)

5. Bilder als Links

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:php-powered.gif}}]]

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

Fußnoten

Fußnoten 1) werden durch eine doppelte runde Klammer dargestellt 2). 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 duch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote)) 

Sektionen

Mit 5 unterschiedliche Ebenen, getrennt durch Überschriften, kann der Inhalt einer Seite strukturiert werden.
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 3

Überschrift Ebene 4

Überschrift Ebene 5
==== Überschrift Ebene 3 ====
=== Überschrift Ebene 4 ===
== Überschrift Ebene 5 ==

Mit 4 aufeinander folgenden Minuszeichen kann eine horrizontale Linie erzeugt werden:


Bilder und andere Dateien

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:

Eine Größe vorgeben:

Eine Größe für externe Bilder vorgeben:

Original Größe:             {{wiki:php-powered.gif}}
Eine Breite vorgeben: {{wiki:php-powered.gif?100}}
Eine Größe vorgeben:  {{wiki:php-powered.gif?100x100}}
Eine Größe für externe Bilder vorgeben: {{http://amon.am.funpic.de/php.gif?150x100}}

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

{{ wiki:php-powered.gif}}
{{wiki:php-powered.gif }}
{{ wiki:php-powered.gif }}

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

Dies ist ein Titel

{{ wiki:php-powered.gif |Dies ist ein Titel}}

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

Listen

DokuWiki kennt sortierte 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 werden 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 werden 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 werden durch Hinzufügen von weiteren 2 Leerzeichen
  * Noch ein Eintrag

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

Smileys

Dokuwiki verwandelt oft genutzte emoticons zu kleinen Smily-Grafiken.
Weitere Smiley-Grafiken können im Ordener "smily"(/path/to/wiki/lib/images/smileys) 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-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :-\ :-\
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • FIXME FIXME
  • DELETEME DELETEME

Typografie

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

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640x480 © ™ ® "He thought 'It's a man's world'…"

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

Bitte beachtet: Diese Umwandlungen können in der Konfigurationsdatei abgestellt werden

Tabellen

Mit DokuWiki können Tabellen ganz einfach erstellt werden:

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

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

^ hervorgehoben   ^ zum Beispiel für   ^ 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.

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

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        |

Anmerkung: Felder über mehrere Zeilen werden nicht unterstützt.

unformatierte Abschnitte

Danke an den unbekannten Übersetzer, habe aus deinem Vorschlag "Nicht formatierte Abschnitte" für "Norparsed Blocks" "unformatierte Abschnitte" gemacht - dadurch wird im TOC nicht umgebrochen, ich hoffe das ist so OK <sabba>

Um Text anzuzeigen so, wie er geschrieben wurde egal ob er DokuWiki Formatierungen oder andere Formatierungen enthält kann man jede Zeile mit zwei Leerzeichen beginnen 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.

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

Syntax highlighting

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:

  • ada
  • apache
  • asm
  • bash
  • c
  • css
  • html4strict
  • java
  • nsis
  • pascal
  • php-brief
  • php
  • perl
  • qbasic
  • sql

HTML und PHP einbinden

In einer Seite kann sowohl HTML als auch PHP direkt benutzt werden:

This is some HTML

<html>
This is some <font color="red" size="+1">HTML</font>
</html>

Oder hier PHP:

A logo generated by PHP:PHP Logo !

<php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>

Achtung: Das Einbinden von HTML und PHP in einer Seite kann in der Konfigurationsdatei ausgeschaltet werden. Ist dieses geschehen wird der Quellcode dieser Abschnitte als Text angezeigt und nicht ausgeführt.

BOOKMARK

With this plugin you can insert a bookmark to your page. The format is

<BOOKMARK:name>

This will insert code

<a name='name'></a>

Description

This Plugin transforms your wiki into a blog engine :-). It displays a number of recently changed wiki pages (aka. blog entries) of a given namespace on a single page. The syntax is similar to the one of the gallery plugin:

{{blog>[namespace]?[number]}}
[namespace] is a namespace in your wiki; defaults to the top namespace
[number] is the number of entries to show; default is 5

Both parameters are optional.

The <h1> title will be linked to the individual wiki page. In blogs, this feature is called permalink. Table of contents and category tags will be stripped. Below the entry the username and the date of the last change is displayed.

You can see the Plugin in action in Esthers Kaffeehaus Blog.

Blog

Lists a number of recently created / modified pages from a given namespace in reverse chronological order. Every entry is linked to the main entry page and below the entry author, modification date and number of comments are displayed.

{{blog>[namespace]?[number]}}
[namespace] source namespace from which the latest modified pages are taken and aggregated optional; default is what you set in $conf['blog']['blog_namespace']
[number] number of entries you want to display optional; default is 5

Description

The new3) Blog plugin gives you all you need to transform DokuWiki into a blog engine. It consists of five components:

Blog

Lists a number of recently created / modified pages from a given namespace in reverse chronological order. Every entry is linked to the main entry page and below the entry author, modification date and number of comments are displayed.

{{blog>[namespace]?[number]}}
[namespace] source namespace from which the latest modified pages are taken and aggregated optional; default is what you set in $conf['blog']['blog_namespace']
[number] number of entries you want to display optional; default is 5

Discussion

Provides the ability to readers to leave a comment to your wiki page, even if they have no write access.

~~DISCUSSION~~

Indicates that on this page you want to display existing comments and a form to add further comments. Comments by unregistered users are only allowed for a certain time configured in $conf['blog']['comment_allowguests'] to prevent spam. You can suppress an existing discussion with the command ~~NODISCUSSION~~.

Gravatar

Displays user avatar images from gravatar.com (globally recognized avatars).

{{gravatar>[email]?[size]|[title]}}
[email] e-mail address of the user required
[size] size of the avatar image: eighter s(mall, 20 pixel), m(edium, 40 pixel) or l(arge), 80 pixel) optional; default is 40 pixel
[title] for alt tag and title rollover optional; default is the (obfuscated) e-mail address

Additionally, by using left or right whitespaces you can choose the alignment like with otherImages.

Tag

Allows you to categorize your wiki pages. A list of links will be created that link to the tag pages in the namespace you've set in $conf['blog']['tag_namespace'].

{{tag>[tag] [tag] ...}}

A space separated list of tags that describe the content of the current page. These are necessary for tag based archives as described in the next section.

Archive

With this plugin component you can easily create date or category based archives.

{{archive>[namespace]?[month]}}
{{archive>[namespace]?[tag]}}
[namespace] source namespace for which the archive is to be created optional; default is what you set in $conf['blog']['blog_namespace']
[month] month in the form yyyy-mm required
[tag] a category tag, case insensitive required

Syntax iframe

Simple:

{{url>http://www.somesite.com/somepage.html}}

Complete:

{{url>someurl [ width , height ] | alternate-text }}

  • [width,height] is optional. If only one dimension is specified, it is assumed to be height. Default values are: width - 98%, height - 400px.
  • |alternate text is optional. If not specified an empty string will be used.

See the plugin in action here.

Syntax code replacement plugin

<code lang |title> some code </code>
<file |title> some text </file>

If no title is given the plugin will render the <code> or <file> markup identically to the native dokuwiki handler.

See the page in action here

1) dies ist eine Fußnote
2) eine zweite Fußnote
3) There is an old version which works with the latest official release of DokuWiki (2005-09-22).

Eigene Werkzeuge