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.

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

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}}]]

http://www.php.net

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 supports a simple syntax to create tables.

Table rows have to start and end with a | for normal rows or a ^ for headers.

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | some colspan (note the double pipe) ||
| Row 3 Col 1    | Row 2 Col 2     | Row 2 Col 3        |

To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!

Vertical tableheaders are possible, too.

As you can see, it's the cell separator before a cell which decides about the formatting:

|              ^ Heading 1            ^ Heading 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | no colspan this time |                    |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

Note: Vertical spans (rowspan) are not possible.

You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.

This is how it looks in the source:

^           Table with alignment           ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

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 }}

• German Researchers Hit 40 Gbps On Wireless Link by Unknown Lamer (2013/05/21 04:04)
• The Hunt For LulzSec's Missing Sixth Member by Unknown Lamer (2013/05/21 02:13)
• Latvian Police Raid Teacher's Home for Uploading $4.00 Textbook by Unknown Lamer (2013/05/20 23:06)
• EFF Resumes Accepting Bitcoin Donations After Two Year Hiatus by Unknown Lamer (2013/05/20 20:56)
• Google Drops XMPP Support by Unknown Lamer (2013/05/20 19:18)

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 inline HTML

And this is some block HTML

<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:

• Indexmenu 2009-08-29 by Samuele Tognini
  Insert the index of a specified namespace.
• List Syntax Plugin 2007-08-15 by Matthias Watermann
  Add HTML Style Un/Ordered Lists
• Info Plugin 2008-09-12 by Andreas Gohr
  Displays information about various DokuWiki internals
• Tip Syntax Plugin 2007-08-15 by Matthias Watermann
  Place hints &c. on a page [<tip [c|l|r] [u|e|d] [h|i|n|w]> ... </tip>]

Below is grabbed from http://www.dokuwiki.org/plugin:tip and changed some for customizations that have been made to the plugin.

You know those little yellow pieces of paper which so nicely stick all around your screen's fra­me? Lots of “note this” and “remember that” and “don't for­get to …”

Well, when starting yet another technical document I realized that it would be nice to have some­thing like that available for the pages I was going to write. After scan­ning my paperwork it seemed that I needed four kinds of tips: ”hints”, ”infos”, ”notes” and ”warnings”. Then I felt the de­sire to place them ver­ti­cal­ly (in relation to the sur­roun­ding text): centered on screen, on the left side and, er, the right side. And finally I thought it would be nice³⁾ to have some con­trol about how to position them hori­zon­tally.

So I ended up with a tag which allows for ten different arguments …

The standard way we use tips in this manual, is like this:

   <tip c t>Some text</tip>

That is, “c” for center, then one of the different “type types”. The other “orientations” are not used much (if at all) in the manual. The rest of the instructions are strait from the tips user manual. mostly.

The easiest use of a ”tip” box is just

	<tip> some text </tip>

This will place (by means of CSS rules) ”some text” on the page's right side, like you should see to the right of this text.

So what about the “ten different arguments” mentioned above? Here they come:

• Orientation: ”centered”, ”left”, ”right” (the default);
• Position: ”up”, ”down” and ”even” (the default);
• Type: ”hint”, ”info”, ”note”, ”warning”, (default: none).

In other words: Each ”tag” element has – beside its contents – three “pro­per­ties”: a position, a type and an orientation.

To ease your task of typing the plugin al­lows to write only the first let­ter of each optio­nal ar­gu­ment⁴⁾. Just for the records, here's a list of all possible com­bi­na­tions (using one-letter shortcuts):

• centered: ”c”, ”c d”, ”c d h”, ”c d i”, ”c d n”, ”c d w”, ”c e”, ”c e h”, ”c e i”, ”c e n”, ”c e w”, ”c u”, ”c u h”, ”c u i”, ”c u n”, ”c u w”,
• left aligned: ”l”, ”l d”, ”l d h”, ”l d i”, ”l d n”, ”l d w”, ”l e”, ”l e h”, ”l e i”, ”l e n”, ”l e w”, ”l u”, ”l u h”, ”l u i”, ”l u n”, ”l u w”,
• right aligned: ”r”, ”r d”, ”r d h”, ”r d i”, ”r d n”, ”r d w”, ”r e”, ”r e h”, ”r e i”, ”r e n”, ”r e w”, ”r u”, ”r u h”, ”r u i”, ”r u n”, ”r u w”

Please note, however, that the order of the respective arguments doesn't mat­ter. So in rea­lity there are a lot more possible com­bi­na­tions avail­able for you …

While I took care to make the use of this plugin as easy as possible whilst pro­vi­ding as much flexibility as reasonable feasible, there are some points you should be aware of.

Space characters (” ”⁵⁾) are to be used to delimit both the ”tip” word and the opt­io­nal ar­gu­ments inside the opening tag.

Above I've grouped the possible arguments into the orientation, type and position property groups. For each property only one (the last) value is actually used. E.g. ”<tip cente r>” (no­te the accidential space be­fore the ”r”) would result in a right aligned tip box since the ”r” ar­gu­ment overwrites the ”cente”. This is nei­ther a pitfall nor a bug but is per­fectly sensible if you think about it.

While most other Wiki markup is allowed inside a tip's content⁶⁾, the nesting of other ”tip” boxes is not. Again, this be­ha­viour is by design. Nesting of tips in­side tips wouldn't serve the in­ten­ded pur­pose of this plugin and hence I didn't im­ple­ment it.

The tip tag creates a new block level ele­ment in the docu­ment. In con­se­quen­ce it pro­bab­ly won't work as ex­pec­ted when used in­side Wiki mark­up that doesn't sup­port nested block level ele­ments. For (un/ordered) lists please con­si­der using the Lists plugin which re­places and en­han­ces DokuWiki's built­in list parser and will allow you to place ”tip” boxes⁷⁾ in­side list items. The same is true for the Definition List plugin.

This plugin as such just pre­pa­res the (X)HTML markup – but the real work is done by the rea­der's brow­ser. As the visual ap­pearance of a tip's con­tent is com­ple­tely con­trol­led by sty­ling rules, a CSS con­for­mant web-browser⁸⁾ is strongly re­com­men­ded.

In the following examples I'm using only the respec­tive first letter for all pro­perty va­lues. How­ever, you may very well type in the complete name for cla­rity rea­sons if you prefer a more explicit markup style.

I already stated that the easiest way to add a ”tip” looks like:

<tip>
	right aligned text
</tip>

which is just the same as giving the default orien­tation (right) and posi­tion (even) pro­perty values expli­citely:

<tip r e>
	right aligned text
</tip>

To place it on the left side switch the orien­tation pro­perty to left:

<tip l>
	left aligned text
</tip>

Similiar if you'd prefer a centered text:

<tip c>
	some centered text
</tip>

Now let's say you'd like to push the tip a bit down (using the default right orien­tation):

<tip d>
	down text, right aligned
</tip>

Similiar if you'd like to move it up a bit:

<tip u>
	up text, right aligned
</tip>

Well, now that you know how to use the position (up, down and the default even) as well as the orien­tation pro­perty (center, left and the default right) you might like to add some gra­phi­cal indi­ca­tion about the type of your tip.

The plugin's source archive contains four small icons⁹⁾ I've created to dif­feren­ti­ate your ”tip” boxes fur­ther (besides posi­tion and orien­ta­tion). Those images get placed at the left/top cor­ner of the tip box if you're using the type property¹⁰⁾.

To mark a tip as a hint (aka ”see also”) set the type pro­perty to ”hint” (or just ”h”):

<tip h>
	right aligned hint text
</tip>

To mark a tip as additional information set the type pro­perty to ”in­fo” (or just ”i”):

<tip i>
	right aligned information text
</tip>

To mark a tip as a note set the type pro­perty to ”note” (or just ”n”):

<tip n>
	right aligned note text
</tip>

To mark a tip as a warning set the type pro­perty to ”warn” (or just ”w”):

<tip w>
	right aligned warning text
</tip>

You can, of course, combine this type pro­perty values with any of the po­si­tion and orien­ta­tion pro­perty values, e.g.

<tip l n d>
	left aligned note down
</tip>

The left and right aligned tip boxes will get up to 31% wide of the em­bedding pa­rent ele­ment; the cen­tered boxes will take up to 62% width¹¹⁾.

The tip's orientation property determines both the location where the tip box gets pla­ced¹²⁾ and the text align­ment¹³⁾.

Generally it's a good idea to place the tip markup in your page before¹⁴⁾ the text which the tip should align with. – If in doubt use the preview button of Doku­Wiki's page edit form to see the actual result.

Depending on the tip's actual contents – which can be any­thing except another tip – the tip box might be­come larger (i.e. higher) than the neigh­bouring page element. In conse­quence the space occu­pied by the tip box will ex­pand into the visual area of the next page element. While this is all right in many situa­tions it could be distur­bing in others – for example if the next ele­ment is a list or table or code block where an over­lapping tip box wouldn't look that good. In such a case it can be help­ful to use Doku­Wiki's line­break markup (i.e. ”\\ ”) to force the next ele­ment visually down until it gets placed below the tip box.

Although the position property allows for mo­ving the tip box up/down a bit, usu­ally the default value (i.e. ”even”) is what you want. Hence you should think twice be­fore using other values.

The tip markup allows any content to be placed inside it. But having the option to do so doesn't mean that you're forced to use it. After all, the plugin's pur­pose is to allow for rela­tively small notes to be placed along the normal text. Hence you should resist the tempta­tion to put long essays, lists or tables in a tip box.

While it's easy to create funny effects by using this plugin, a page author should always be aware of the old rule: Less Is More. — In other words: Be­fore you're going to empha­sise some text by ta­king it out of the stan­dard rea­ding flow you should con­sider care­fully whe­ther it wouldn't be better – for both the page de­sign and the reader's reception – if you'd just re­phrased your words to make them part of the stan­dard flow of text.