Table of Contents

Formatting Syntax

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.

Basic text formatting

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.

Links

DokuWiki supports multiple ways of creating links.

External

External links are recognized automagically: http://www.google.com or simply www.google.com - You can set Linknames, too: 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
Linknames, too: [[http://www.google.com|This Link points to google]]. Email
addresses like this one: <andi@splitbrain.org> are recognized, too.

Internal

Internal links are created by using square brackets. You can either just give a wiki:pagename or use an additional Title Text. Wiki pagenames are converted to lowercase automatically, special characters are not allowed. 

Internal links are created by using square brackets. You can either just give
a [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames
are converted to lowercase automatically, special chars are not allowed.

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

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

For details about namespaces see wiki: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:

Interwiki

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

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

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

Notes:

Image Links

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).

Footnotes

You can add footnotes 1) by using double parentheses. 

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

Sectioning

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
==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

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

Images and other files

You can include external and internal wiki: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.

This is the caption 

{{ 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.

Lists

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.

  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

Smileys

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.

Typography

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.

Quoting

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!

Tables

DokuWiki supports a simple syntax to create tables.

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

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.

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

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.

Table with alignment
right center left
left right center
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

This is how it looks in the source: 

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

Non-parsed Blocks

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.

Syntax Highlighting

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: actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, bnf, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, csharp, css, delphi, diff, div, dos, d, eiffel, fortran, freebasic, gml, groovy, html, idl, ini, inno, io, java5, java, javascript, latex, lisp, lua, matlab, mirc, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml

Embedding HTML and PHP

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

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

This is some HTML 

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

A logo generated by PHP:PHP Logo !

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

Syntax Enhancements from Installed Plugins

Folded Text

You can create a folded text segment. This means that normal only a small portion of the text is visible, but when you click on it, the text expands the show the full segment. Folded text is supported both as inline and block.

Inline
This is example text. And after that the text just continues to flow in the same paragraph.

Block

Folded Text Title

Notes

You can create highlighted note boxes within your pages. This can be done by including a block of text in between a set of “note” markers. There are 4 options: 

<note>This syntax produces an simple note box.</note>
This syntax produces an simple note box. 
<note warning>Including the keyword //**warning**// produces a different note box.</note>
Including the keyword warning produces a different note box. 
<note tip>Including the keyword //**tip**// produces this note box.</note>
Including the keyword tip produces this note box. 
<note important>Including the keyword //**important**// produces this note box.</note>
Including the keyword important produces this note box.

Highlighted Text (with background colors)

Text can be highlighted in any desired color using the highlight syntax. Use the highlight tool button in the editor to automatically encapsulate the text in the correct tags and to select the color. 

<hi #ffff00>This text is highlighted in yellow.</hi>

This text is highlighted in yellow. 

<hi #6495ed>This text is highlighted in blue.</hi>

This text is highlighted in blue.

Colored Text

Text color can be set to any desired color using the color syntax. Use the color tool button in the editor to automatically encapsulate the text in the correct tags and to select the color. 

<color #ff0000>This text is colored red.</color>

This text is colored red. 

<color #6495ed>This text is colored  blue.</color>

This text is colored blue.

Table from CSV

This feature allows display of CSV data in table form. The data can either be inline between <csv> and </csv> or be read from a file in the media area using <csv wiki:test.csv></csv>. Both file and inline data may be specified at the same time, but right now that just generates two tables.

The <csv> tag allows for two options to be specified as well as a file reference.

Option Description
hdr_rows=<n> Format the first <n> rows of data from the CSV as column headers. Default=1
span_empty_cols=[01] Create colspans for each empty (two adjacent commas) cell following a cell with content. Default=1

Cells that include a comma as part of the data are expected to be contained between double quotes, which is the typical behavior of most systems when exporting .csv files.

Here is an example where a .csv file has been uploaded and referenced. 

<csv wiki:test.csv></csv>
Could not locate wiki:test.csv

Here is an example where the csv text has been included in line. 

<csv hdr_rows=1>
Column 1,Column 2,Column 3
5,6,7
"Fred Kay","Jones, Joe","Oscar Smith"
</csv>
Column 1Column 2Column 3
567
Fred KayJones, JoeOscar Smith

Index Menu Tree

You can insert an index tree for any dokuwiki namespace. The tree can be rendered using either text or javascript. 

{{indexmenu>[namespace[#n]] [ns1#n ns2#n ...]|[nons] [js[#theme]] [nocookie] [id[#n|page]]}}

Options inside ”[]” parenthesis are optional:

Option Action Comment
namespace Main namespace name. Index starts from it. optional with n or nons; “.” is the current namespace; ”..” or an empty value shows the root site namespace; ”.:ns1” is the ns1 namespace inside current namespace.
n Number that specifies, in js mode, the tree level to open, while, in nojs mode, it is the max level to show. optional; it can be used together with nons. Not defined opens all nodes, whereas equal to 0 or 1 closes them.
ns1#n ns2#n … A list of optional namespaces inside main namespace. Every namespace will be opened or closed at the specified n level. optional; It can be used together with nons. Not defined n opens all nodes, whereas equal to 0 closes them.
js Javascript render method: the index is an expandable tree menu. Optional; without n, all nodes are open, with it, nodes are open till n level.
navbar The tree opens automatically itself at the current page namespace. It's good as navigation sidebar. Optional; ATTENTION: It also sets id=1, therefore use only one navbar indexmenu in your site or set manually different id for other navbar trees.
theme Theme name for indexmenu icons when in js mode. Optional; a theme is a set of icons inside images directory as described in Theme tutorial. Admins can download and share themes in admin panel.
max#n It sets how many js tree levels to render when page loads. Optional; Remaining nodes are rendered (slightly slower) only when they are open by users, by optional namespaces option, by cookies or by navbar option. Default n is 1 so that it will speed up the page loading, above all with an high amount of pages.
nons Exclude namespaces nodes from index. It shows only the pages. optional.
nocookie By default js indexmenu remembers selected, open, and closed nodes by user during navigation. With this option it doesn't remember them and the tree is blocked to its start status. Optional and used only with js option; when it's used, the id option is not useful.
id[#n|page] Cookie id for a js indexmenu. By default is random, but you can force it to be a n fixed number ( i.e id#20 ) or a number automatically retrieved from the current page (id#page). Optional and used only with js option; Useful only with a nocached page and when Js does not remember its previous state. ATTENTION: id must be unique for every indexmenu in your dokuwiki site or you'll get strange js behaviors.
noscroll Disable the javascript scrolling feature optional.

A sample of an indexmenu that could be used inside a navigation sidebar: 

{{indexmenu>..#1|js navbar nocookie}}

Example that displays a js Index tree with nodes open till second level: 

{{indexmenu>wiki:plugins#2|js}}

Wiki theme, closed wiki:plugins namespace and full open “public” namespace (public is inside current namespace). 

{{indexmenu>wiki:plugins#0 .:public|js#doku}}

Standard Dokuwiki index showing only pages inside wiki:plugins and lower namespaces (max two levels): 

{{indexmenu>wiki:plugins#2|nons}}

Root js tree menu with all nodes open and playground closed. This initial status is blocked by the nocookie option, so, when the page is reloaded, it doesn't remember the open and closed nodes by the user. 

{{indexmenu>.. playground#0| nocookie}}

Menu PopUp

This create a popup menu or page whenever you mouse over special popup link.

Syntax: 

{{popup>[head]?[contentPage]}}

Test PopUp 1

This is an example of a sample pop up window.




Test PopUp 2

Pop Up Menu

This is another example of a sample PopUp specified wit a larger window size.

  • Selection 1
  • Selection 2
  • Selection 3



Rendered PHP

You can embed PHP code in your wiki page and have the output of the PHP code rendered by the wiki engine. Normally embedded PHP will output html directly to the browser and bypass the wiki rendering engine.

To have PHP rendered by the wiki engine, enclose it in the following xml tags: 

<phpwikify>
Your PHP code.
</phpwikify>

Progress Bar

You can create a nice progress bar graphic on any wiki page.

Simply put <progress=#> in any page, where # is a number from 0 to 100 without the % sign. (Only multiples of 10 are supported, so you can only use 0%, 10%, 20%, etc.) 

<progress=0>

will make an empty progress bar. 

<progress=70>

will make a 70% full one.

MediaWiki Enhanced Table Support

This plugin allows support of MediaWiki style enhanced table formatting. See more about MediaWiki table syntax under: http://www.mediawiki.org/wiki/Help:Tables. 

<exttab1>
{|
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream 
|}
</exttab1>


Orange Apple
Bread Pie
Butter Ice cream 


<exttab1>
{| border="1"
|Orange
|Apple
|align="right"|12,333.00
|-
|Bread
|Pie
|align="right"|500.00
|- style="font-style:italic;color:green;"
|Butter
|Ice cream
|align="right"|1.00
|}
</exttab1>


Orange Apple 12,333.00
Bread Pie 500.00
Butter Ice cream 1.00 


<exttab1>
{| style="color:green;background-color:#ffffcc;" cellpadding="20" cellspacing="0" border="1"
|Orange
|Apple
|-
|Bread
|Pie
|-
|Butter
|Ice cream 
|}
</exttab1>


Orange Apple
Bread Pie
Butter Ice cream

Syntax Plugins

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:

1) This is a footnote