DokuWiki supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing the Edit this page button at the top or bottom of the page. If you want to try something, just use the playground page. The simpler markup is easily accessible via quickbuttons, too.

Der nächste kann diesen Text mal LÖSCHEN ….!

DokuWiki supports bold, italic, underlined and monospaced texts. Of course you can combine all these.

Insert Code

DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
Of course you can **__//''combine''//__** all these.

You can use _subscript and ^superscript, too.

You can use <sub>subscript</sub> and <sup>superscript</sup>, too.

You can mark something as deleted as well.

You can mark something as <del>deleted</del> as well.

Paragraphs are created from blank lines. If you want to force a newline without a paragraph, you can use two backslashes followed by a whitespace or the end of line.

This is some text with some linebreaks
Note that the two backslashes are only recognized at the end of a line
or followed by
a whitespace \\this happens without it.

This is some text with some linebreaks\\ Note that the
two backslashes are only recognized at the end of a line\\
or followed by\\ a whitespace \\this happens without it.

You should use forced newlines only if really needed.

DokuWiki supports multiple ways of creating links.

External links are recognized automagically: http://www.google.com or simply www.google.com - You can set the link text as well: This Link points to google. Email addresses like this one: andi@splitbrain.org are recognized, too.

DokuWiki supports multiple ways of creating links. External links are recognized
automagically: http://www.google.com or simply www.google.com - You can set
link text as well: [[http://www.google.com|This Link points to google]]. Email
addresses like this one: <andi@splitbrain.org> are recognized, too.

Internal links are created by using square brackets. You can either just give a pagename or use an additional link text.

Internal links are created by using square brackets. You can either just give
a [[pagename]] or use an additional [[pagename|link text]].

Wiki pagenames are converted to lowercase automatically, special characters are not allowed.

You can use namespaces by using a colon in the pagename.

You can use [[some:namespaces]] by using a colon in the pagename.

For details about namespaces see namespaces.

Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to this Section.

This links to [[syntax#internal|this Section]].

Notes:

• Links to existing pages are shown in a different style from nonexisting ones.
• DokuWiki does not use CamelCase to automatically create links by default, but this behavior can be enabled in the config file. Hint: If DokuWiki is a link, then it's enabled.
• When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.

DokuWiki supports Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: Wiki.

DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis.
For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].

Windows shares like this are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate Intranet.

Windows Shares like [[\\server\share|this]] are recognized, too.

Notes:

• For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the „local zone“).
• For Mozilla and Firefox it can be enabled through the config option security.checkloaduri but this is not recommended.
• See 151 for more info.

You can also use an image to link to another internal or external page by combining the syntax for links and images (see below) like this:

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

Please note: The image formatting is the only formatting syntax accepted in link names.

The whole image and link syntax is supported (including image resizing, internal and external images and URLs and interwiki links).

You can add footnotes ¹⁾ by using double parentheses.

You can add footnotes ((This is a footnote)) by using double parentheses.

You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically – this can be disabled by including the string ~~NOTOC~~ in the document.

==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

By using four or more dashes, you can make a horizontal line:

You can include external and internal images with curly brackets. Optionally you can specify the size of them.

Real size:

Resize to given width:

Resize to given width and height²⁾:

Resized external image:

Real size:                        {{wiki:dokuwiki-128.png}}
Resize to given width:            {{wiki:dokuwiki-128.png?50}}
Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}

By using left or right whitespaces you can choose the alignment.

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

Of course, you can add a title (displayed as a tooltip by most browsers), too.

{{ wiki:dokuwiki-128.png |This is the caption}}

If you specify a filename (external or internal) that is not an image (gif, jpeg, png), then it will be displayed as a link instead.

For linking an image to another page see Image Links above.

Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a * for unordered lists or a - for ordered ones.

• This is a list
• The second item
  • You may have different levels
• Another item

1. The same list but ordered
2. Another item
   1. Just use indention for deeper levels
3. That's it

  * This is a list
  * The second item
    * You may have different levels
  * Another item

  - The same list but ordered
  - Another item
    - Just use indention for deeper levels
  - That's it

DokuWiki converts commonly used emoticons to their graphical equivalents. More smileys can be placed in the smiley directory and configured in the conf/smileys.conf file. Here is an overview of Smileys included in DokuWiki.

• 8-)
• 8-O
• :-(
• :-)

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

dokuwiki can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.

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

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

Please note: These conversions can be turned off through a config option and a pattern file.

Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

I think we should do it

No we shouldn't

Well, I say we should

Really?

Yes!

Then lets do it!

DokuWiki unterstützt eine einfache Syntax zum Erstellen von Tabellen.

Um Zellen horizonatal zu verbinden, müssen diese komplett leer sein, wie oben zu sehen ist. Die Anzahl der Striche muss immer gleich sein!

^ Kopf 1      ^ Kopf 2      ^ Kopf 3          ^ 	
| Reihe 1 Spalte 1    | Reihe 1 Spalte 2    | Reihe 1 Spalte 3        | 	
| Reihe 2 Spalte 1    | Doppelspalte (Doppelhochkantstrich beachten) || 	
| Reihe 3 Spalte 1    | Reihe 2 Spalte 2    | Reihe 2 Spalte 3        |

Vertikale Tabellenköpfe sind ebenso möglich.

Wie du sehen kannst, entscheidend ist der Hochkantstrich vor der Zelle entscheident für die Formatierung:

|              ^ Kopf 1            ^ Kopf 2          ^
^ Kopf 3    | Reihe 1 Spalte 2          | Reihe 1 Spalte 3        |
^ Kopf 4    | keine Doppelspalte hier|                    |
^ Kopf 5    | Reihe 2 Spalte 2          | Reihe 2 Spalte 3        |

Vertikale Doppelzellen sind nicht möglich.

Texte im Zellen können auch ausgerichtet werden. Dazu einfach 2 Leerzeichen an Anfang oder Ende des Zelltextes einfügen: Rechtbündig: 2 Leezeichen links, Linksbündig: 2 Leerzeichen rechts, zum Zentrieren jeweils 2 Leerzeichen vorn und hinten.

So sieht der Sourcecode aus:

^           Tabelle mit Ausrichtung           ^^^
|  rechts|  zentriert  |links  |
|links  |  rechts|  zentriert  |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

<color black>schwarzer Text</color>

<color aqua>hellblauer Text</color>

<color navy>dunkelblauer Text</color>

<color blue>blauer Text</color>

<color green>grüner Text</color>

<color teal>dunkelgrüner Text</color>

<color olive>oliver Text</color> 

<color lime>hellgrüner Text</color>

<color maroon>dunkelroter Text</color>

<color purple>violetter Text</color> 

<color red>roter Text</color>  

 <color fuchsia>hellroter Text</color>  

<color gray>dunkelgrauer Text</color> 

< <color silver>grauer Text</color>

<color lightgray>hellgrauer Text</color> 

<color blue/lightgrey>blauer Text mit grauem Hintergrund</color>

blauer Text mit hellgrauem Hintergrund

<color fuchsia/navy>hellroter Text mit dunkelblauem Hintergrund</color>

hellroter Text mit dunkelblauem Hintergrund

You can include non-parsed blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags code or file.

This is preformatted code all spaces are preserved: like              <-this

This is pretty much the same, but you could use it to show that you quoted a file.  

To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with nowiki tags or even simpler, with double percent signs %%.

This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.

See the source of this page to see how to use these blocks.

dokuwiki can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter – so any language supported by GeSHi is supported. The syntax is the same like in the code block in the previous section, but this time the name of the used language is inserted inside the tag. Eg. <code java>.

/** 
 * 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.
    }
}

The following language strings are currently recognized: abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoit, bash, basic4gl, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, cobol, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, dot, d, eiffel, fortran, freebasic, genero, glsl, gml, gnuplot, groovy, gettext, haskell, html, idl, ini, inno, io, java5, java, javascript, kixtart, klonec, klonecpp, latex, lisp, lotusformulas, lotusscript, lua, m68k, matlab, mirc, mpasm, mxml, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, per, php-brief, php, pic16, plsql, povray, powershell, progress, python, qbasic, rails, reg, robots, ruby, sas, scala, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, typoscript, vbnet, vb, verilog, vhdl, visualfoxpro, winbatch, xml, xorg_conf, xpp, z80

dokuwiki can integrate data from external XML feeds. For parsing the XML feeds, SimplePie is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:

The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. dokuwiki will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells dokuwiki to re-render the page if it is more than refresh period since the page was last rendered.

Example:

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

• Almost a Million UK Homes Will Suffer 4G TV interference von samzenpus (2012/02/23 06:35)
• FCC Chair Calls On ISPs To Adopt New Security Measures von samzenpus (2012/02/23 04:06)
• Biologists Debunk the "Rotting Y Chromosome" Theory von samzenpus (2012/02/23 02:25)
• NRC Releases Audio of Fukushima Disaster von samzenpus (2012/02/23 01:56)
• LinkedIn Buys Rapportive von samzenpus (2012/02/23 01:36)

You can embed raw HTML or PHP code into your documents by using the html or php tags like this:

<html>
This is some <span style="color:red;font-size:150%;">inline HTML</span>
</html>
<HTML>
<p style="border:2px dashed red;">And this is some block HTML</p>
</HTML>

This is some <span style="color:red;font-size:150%;">inline HTML</span>

<p style="border:2px dashed red;">And this is some block HTML</p>

<php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
echo '(generated inline HTML)';
</php>
<PHP>
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';
</PHP>

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

echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';

Please Note: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.

Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:

DokuWiki's syntax can be extended by Plugins. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:

• Gallery Plugin 2009-11-02 von Andreas Gohr
  Creates a gallery of images from a namespace or RSS/ATOM feed
• Medialist 2009-05-21 von Michael Klier
  Displays a list of media files linked from the given page or located in the namespace of the page.
• Tooltip Plugin (standard tooltip component) 2009-10-03 von Luis Machuca Bezzaza
  Mark text with a tooltip: <ttip:text> tooltip </ttip>
• ToDo 2009-10-14 von Babbage
  Create a checkbox based todo list
• PanoView Plugin 2009-07-31 von Andreas Gohr
  View large images in a pannable view
• Note Plugin 2009-06-15 von Olivier Cortès / Eric Hameleers / Christopher Smith / Aurélien Bompard
  Add Note/Important/Tip/Warning Capability (DIV+CSS box)
• Flash Embed Plugin 2009-12-11 von Andreas Gohr
  Embed a Flash SWF file with any number of parameters
• Color Plugin 2008-02-06 von Christopher Smith
  Changes text colour and background
• hidden Plugin 2009-12-01 von Guillaume Turri
  Enable to hide/show details
• Imagebox Plugin 2009-04-23 von FFTiger / myst6re
  Entoure les images avec un cadre de décoration.
• Alphaindex 2008-10-28 von Hubert Moliere
  Insert the alphabetical index of a specified namespace.
• RemoteScript v0.9.16 2006-12-21 von Ilya Lebedev
  Backend for the remote scripting facility. Controller code taken from http://en.dklab.ru/lib/JsHttpRequest/
• Diagram plugin, Splitter component 2009-11-11 von Nikita Melnichenko
  Parses diagram content
• Info Plugin 2008-09-12 von Andreas Gohr
  Displays information about various DokuWiki internals
• Tag Plugin (topic component) 2009-05-11 von Gina Häußge, Michael Klier, Esther Brunner
  Displays a list of wiki pages with a given category tag