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.

The word **Diogenes** will be bold.

The word Diogenes will be bold.

Italics will be applied to //Xerxes//.

Italics will be applied to Xerxes.

__Cassandra__ will be underlined.

Cassandra will be underlined.

<del>Descartes</del> will be struck through.

Descartes will be struck through.

Finally, discussions about global warming can use CO<sub>2</sub> properly.

Finally, discussions about global warming can use CO₂ properly.

e = mc<sup>2</sup> for example.

e = mc² for example.

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.

All of the below are valid.

• http://www.google.com
• www.google.com
• [[http://www.google.com]]
• [[http://www.google.com|An alternately titled link to Google]]
• <bob@bob-house.org> will create a mailto link.

• http://www.google.com
• www.google.com
• http://www.google.com
• An alternately titled link to Google
• bob@bob-house.org will create a mailto link.

To link to an internal page, just give use a pagename. The following are valid.

• [[DokuWiki]]
• [[DokuWiki|Alternately titled internal link]]

• DokuWiki
• Alternately titled internal link

Wiki pagenames are converted to lowercase automatically, special characters are not allowed.
You can also use namespaces.

• [[broadband:exchange_locations]]
• [[broadband:exchange_locations|Ilmarin's article on exchanges.]]

• Exchange Locations
• Ilmarin's article on exchanges.

You can also refer to the root namespace by just using a colon.

• [[:bsod]]

• bsod

Confused yet? You may want to read the documentation on namespaces, or the discussion of namespaces on this wiki. They make sense eventually.

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

• This links to the [[syntax#subscript|subscript section]] of this document.

• This links to subscript section of this document.

• Links to existing pages are shown in a different style from nonexisting ones.
• DokuWiki does not use CamelCase to automatically create links by default. If you really want it, bug an admin.

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

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

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 ((Which comprise roughly 60% of all pagespace in Terry Pratchett novels)) by using double parentheses.

You can add footnotes 1) 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 1 ==
=== Headline Level 2 ===
==== Headline Level 3 ====
===== Headline Level 4 =====
====== Headline Level 5 ======

----

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

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

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.

{{ 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, just use a “*” for an unordered list, and a “#” for an ordered list.

* A list item
* Another
** Nesting just involves more asterisks
*** Deep nesting
*** Some more
* And back to the rest of the list.

• A list item
• Another
  • Nesting just involves more asterisks
    • Deep nesting
    • Some more
• And back to the rest of the list.

# Same list, but ordered
# Another
## Nesting just involves more asterisks
### Deep nesting
### Some more
# And back to the rest of the list.

1. Same list, but ordered
2. Another
   1. Nesting just involves more asterisks
      1. Deep nesting
      2. Some more
3. And back to the rest of the list.

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'..."

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.

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

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 using

{{{
brackets like this. Note how they’re on different lines. ←This whitespace should be preserved.
}}}

brackets like this. Note how they're on different lines.     <-This whitespace should be preserved.

To let the parser ignore an area completely you can use %% %%

**This** is bold, but %%**this**%% isn't.

This is bold, but **this** isn’t.

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. Just use a code block with the name inserted in the first tag <code java>.

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

The following language strings are currently recognized: actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, csharp, css, delphi, diff, div, dos, d, eiffel, fortran, freebasic, gml, groovy, html4strict, idl, ini, inno, java5, java, javascript, latex, lisp, lua, matlab, 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

A plugin allowing the usage of bbCode has been installed on this wiki.