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 subscript and superscript, too.

You can mark something as deleted as well.

You can mark something as deleted 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: 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 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 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 sectionname behind a hash character as known from HTML. This links to this Section.

This links to 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 behaviour 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.

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 Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: 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 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

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:

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 1) 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 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 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: Resize to given width: Resize to given width and height: Resized external image:

By using left or right whitespaces you can choose the alignment

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

This is the caption

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.

This is a list

The second item

      o
        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

        o
          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

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’…”

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “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

Nonparsed 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, actionscript-french, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, caddcl, cadlisp, c, c_mac, cfm, cpp, csharp, css, delphi, diff, d, div, dos, eiffel, freebasic, gml, html4strict, ini, inno, java, java5, javascript, lisp, lua, matlab, mpasm, mysql, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, scheme, sdlbasic, smarty, sql, tsql, robots, ruby, vb, vbnet, vhdl, visualfoxpro, 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:

This is some <font color=“red” size=”+1”>HTML</font>

This is some HTML

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

echo 'A logo generated by PHP:'; echo '<img src=”' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '” alt=“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 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:

Info Plugin 2005-08-03 by Andreas Gohr

  Displays information about various DokuWiki internals
*
  Math Plugin 2005-12-17 by Christopher Smith
  Add mathematical formulae to dokuwiki
  Syntax: <m size>math formulae</m>
  For formulae syntax visit http://www.xm1math.net/phpmathpublisher/doc/help.html
*
  Include Plugin 2006-03-23 by Esther Brunner
  Displays a wiki page (or a section thereof) within another
*
  Poll Plugin 2006-04-05 by Esther Brunner
  allows to create simple polls
*
  Box Plugin 2006-03-11 by Christopher Smith
  Boxes with titles, colour and rounded corners.
  Syntax: <box|title> ... </box> title is optional.
*
  HTML Comment Plugin 2005-10-08 by Christopher Arndt
  allows HTML comments to be retained in the output
*
  Color Highlight Plugin 2006-09-06 by Joseph Nahmias
  Highlight text with a specific color
  Syntax: <hi color>highlighted content</hi>
*
  gcalendar 2006-09-12 by Frank Hinkel
  Transforms unordered lists of dates in different wiki-pages into a group-calendar
*
  Variable Plugin 2006-01-12 by Esther Brunner
  insert dynamic variables
*
  Cloud Plugin 2006-03-16 by Esther Brunner
  displays the most used words in a word cloud
*
  CSV Plugin 2005-11-08 by Steven Danz
  Displays a CSV file, or inline CSV data, as a table
*
  Lastmod Plugin 2005-10-10 by Dennis Ploeger
  Displays the timestamp of the last modification
*
  PHP Include 2006-05-11 by Markus Frosch
  Allows you to make an include of an PHP File on Server
*
  Anormal Tracker Plugin 2006-07-27 by Gerry Weissbach
*
  Gallery Plugin 2006-07-24 by Andreas Gohr
  Creates a gallery of images from a namespace
*
  PHP-Wikify Plugin 2005-07-22 by Kasper Sandberg
  Enables php to be processed by renderer

1) This is a footnote 1) This is a footnote