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 ”Edit this page”. If you want to try something, just use the playground page. The simpler markup is easily accessible via quickbuttons, too.

Unicode-koodilla voi lisätä merkkejä Wordissa näppäilemällä koodin ja sen jälkeen alt+x. Hexadecimal-koodilla voi lisätä koodin wordissa painamalla ensin alt + +, ja sen jälkeen koodi näppäimistön oikean reunan numeronäppäimillä.

<quizlib id="VAIHDA TÄHÄN JOTAIN SATUNNAISTA!! EI SAA OLLA KAHTA SAMAA" rightanswers="[['2'],['Ryhmä 18, jakso 1.']]" submit="Tarkista vastaukset">
  <question title=" Mikä on yhtälön $\frac{x}{4}=\frac{1}{2}$ ratkaisu?" type="text"></question>
  <question title="2. Mihin jaksoon ja ryhmään helium kuuluu?" type="text"></question>
</quizlib>

<quizlib id="VAIHDA TÄHÄN JOTAIN SATUNNAISTA!!! EI SAA OLLA KAHTA SAMAA!" rightanswers="[['a1'],['a0'],['a1']]" submit="Tarkista vastaukset">
  <question title="6. Happi on..." type="radio">metalli|epämetalli|puolimetalli</question>
  <question title="7. Sievennä $\frac{12x}{26}$" type="radio"> $\frac{6x}{13}$ | $\frac{13x}{6}$ | $\frac{12x}{26}$</question>
  <question title="8. Vety on..." type="radio">metalli|epämetalli|puolimetalli</question>
</quizlib>

<quizlib id="VAIHDA TÄHÄN JOTAIN SATUNNAISTA!!!!1 EI SAA OLLA KAHTA SAMAA!!" rightanswers="[['a0','a2'],['a0','a1'],['a1','a2','a3']]" submit="Tarkista vastaukset">
  <question title="6. a ja c oikein" type="checkbox">a|b|c</question>
  <question title="7. a ja b oikein" type="checkbox">a|b|c</question>
  <question title="8. kaikki oikein" type="checkbox">a|b|c</question>
</quizlib>

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

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://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, videos and audio files 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://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}}

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

DokuWiki can embed the following media formats directly.

If you specify a filename that is not a supported media format, then it will be displayed as a link instead.

By adding ?linkonly you provide a link to the media without displaying it inline

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

dokuwiki-128.png This is just a link to the image.

Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility.

For example consider this embedded mp4 video:

{{video.mp4|A funny video}}

When you upload a video.webm and video.ogv next to the referenced video.mp4, DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.

Additionally DokuWiki supports a ”poster” image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a video.jpg file would work.

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

Also take a look at the FAQ on list items.

DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.

The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well.

DokuWiki converts commonly used emoticons to their graphical equivalents. Those Smileys and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:

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

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

The same can be done to produce any kind of HTML, it just needs to be added to the pattern file.

There are three exceptions which do not come from that pattern file: multiplication entity (640×480), 'single' and ”double quotes”. They can be turned off through a config option.

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 3 Col 2     | Row 3 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        |

You can have rowspans (vertically connected cells) by adding ::: into the cells below the one to which they should connect.

Apart from the rowspan syntax those cells should not contain anything else.

^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
| Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        |
| Row 2 Col 1    | :::                        | Row 2 Col 3        |
| Row 3 Col 1    | :::                        | Row 2 Col 3        |

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 |

Note: Vertical alignment is not supported.

If you need to display text exactly like it is typed (without any formatting), 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. The same is true for //__this__ text// with a smiley ;-).

<nowiki>
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
</nowiki>
The same is true for %%//__this__ text// with a smiley ;-)%%.

You can embed raw HTML or PHP code into your documents by using the <html> or <php> tags. (Use uppercase tags if you need to enclose block level elements.)

HTML example:

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

<html> This is some inline HTML </html> <HTML> <p style=”border:2px dashed red;”>And this is some block HTML</p> </HTML>

PHP example:

<php>
echo 'The PHP version: ';
echo phpversion();
echo ' (generated inline HTML)';
</php>
<PHP>
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td>'.phpversion().'</td>';
echo '</tr></table>';
</PHP>

<php> echo 'The PHP version: '; echo phpversion(); echo ' (inline HTML)'; </php> <PHP> echo '<table class=”inline”><tr><td>The same, but inside a block level element:</td>'; echo '<td>'.phpversion().'</td>'; echo '</tr></table>'; </PHP>

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

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.

By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the reverse parameter, or display the feed as is with nosort.

Example:

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

• Android Gets a New Software-Based AV1 Decoder / BeauHD (20/04/2024 03:45)
• Firefox Nightly Expands To Linux On ARM64 / BeauHD (20/04/2024 03:02)
• Dutch Privacy Watchdog Recommends Government Organizations Stop Using Facebook / BeauHD (20/04/2024 02:20)
• 23andMe CEO Anne Wojcicki Considers Taking Company Private / BeauHD (20/04/2024 01:40)
• 'Women Who Code' Shuts Down Unexpectedly / BeauHD (20/04/2024 01:02)

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:

• Autonumbering Plugin 2023-03-04 / Florian Wehner
  This plugin allows the use of multiples counters with multiples levels, within the same page.
• Bookcreator Plugin 2021-03-30 / Gerrit Uitslag (previous: Luigi Micco)
  Allow to make a book (PDF, ODT, HTML or text) from selected pages
• Bootstrap Wrapper Plugin 2022-09-22 / Giuseppe Di Terlizzi
  Bootstrap Wrapper for DokuWiki
• Bureaucracy Plugin 2023-05-16 / Andreas Gohr
  Create forms and generate pages or emails from them
• ckgedit 2022-10-06 / Myron Turner
  WYSIWYG plugin for Dokuwiki
• Dw2Pdf plugin 2023-05-02 / Andreas Gohr and Luigi Micco
  DokuWiki to PDF converter
• hidden Plugin 2023-05-04 / Guillaume Turri
  Enable to hide/show details
• Plugin imagebox 2019-10-13 / Lukas Rademacher, CvH, Dr-Yukon, FFTiger & myst6re
  Syntax for display an image with a caption, like Wikipedia.org
• include plugin 2022-01-23 / Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
  Functions to include another page in a wiki page
• Info Plugin 2020-06-04 / Andreas Gohr
  Displays information about various DokuWiki internals
• MathJax plugin 2021-11-20 / Mark Liffiton
  Enables MathJax (https://www.mathjax.org/) parsing of TeX math expressions in wiki pages
• nspages plugin 2023-05-11 / Guillaume Turri
  Presents a toc of the selected namespace using <nspages>
• Open Document Plugin 2023-03-03 / Andreas Gohr, Aurelien Bompard, Florian Lamml, LarsDW223
  Export the current Wiki page to a OpenOffice ODT file
• QuizLib Plugin 2016-04-17 / Enrico Billich
  Quizes for self test for DokuWiki based on QuizLib at https://github.com/ALPSquid/quizlib
• DokuWiki statdisplay plugin 2022-12-12 / Andreas Gohr
  Displays log statistics about your DokuWiki
• Pure SVG Insert Plugin 2015-03-16 / Leszek Piatek
  Inserts an SVG image as-is to be rendered by compatible browsers.
• Tag Plugin 2022-10-02 / Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
  tag wiki pages
• Video Sharing Site Plugin 2022-02-03 / Andreas Gohr
  Easily embed videos from various Video Sharing sites. Example: {{youtube>XXXXXX}}
• Wrap Plugin 2022-08-10 / Anika Henke
  Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.

Matikkaa voi lisätä LaTeX-koodilla lisäämällä koodi $-merkkien sisään. Esimerkiksi

 ${V_{kok}=8{,}99\cdot10^9\ \frac{Nm^2}{C^2}\cdot\left(\frac{15\mu C}{2{,}236m}-\frac{15\mu C}{2{,}236m}\right)} $ 

näkyy valmiina ${V_{kok}=8{,}99\cdot10^9\ \frac{Nm^2}{C^2}\cdot\left(\frac{15\mu C}{2{,}236m}-\frac{15\mu C}{2{,}236m}\right)}$

LaTeX-koodia voi tehdä helposti esim. Abitti-editorilla: https://math-demo.abitti.fi

https://www.dokuwiki.org/plugin:bootswrapper#nav

Esimerkkejä: Examples/Usage

An uppercase <WRAP> (or alternatively <block> or <div>) creates a div and should be used for ”big” containers, surrounding paragraphs, lists, tables, etc.

<WRAP classes width :language>
"big" content
</WRAP>

or
<block classes width :language>
"big" content
</block>

or
<div classes width :language>
"big" content
</div>

A lowercase <wrap> (or alternatively <inline> or <span>) creates a span and should be used for ”small” containers, inside paragraphs, lists, tables, etc.

<wrap classes width :language>"small" content</wrap>

or
<inline classes width :language>"small" content</inline>

or
<span classes width :language>"small" content</span>

Please note, some things won't work with lowercase spans:

• alignments (including alignments generated by changing the text direction)
• multi-columns
• and widths

if the according wrap isn't floated as well.

You can have columns easily by adding the class column and a width, e.g.

<WRAP column 30%>...content...</WRAP>

//**__Emulated Big Headline__**//

//**Emulated Small Headline**//

**//No Headline//**

After using any of the float classes, you might come across something like this, where the following text protrudes into the space where only the floating containers should be …

… to prevent that, you should simply add

<WRAP clear></WRAP>

after your last column.

You can use the same options with spans (as each element that floats is automatically a block level element), but it probably doesn't make too much sense. Widths on spans normally do not work (by design), but can make sense, when it is floating.

Attention: Widths can cause problems and will often look different and break in some browsers. If you're not a web developer, you might not understand any problems regarding the box model. Just try to test your columns in all major browsers and make your widths smaller than you initially think they should be.

All of those options will also work in the boxes and notes wraps (see below).

You can use these different text alignments:

• leftalign
• rightalign
• centeralign
• justify

<WRAP centeralign>
Center aligned text ...
</WRAP>

<WRAP rightalign>
... and right aligned.
</WRAP>

You cannot add alignments to spans.

<WRAP info></WRAP>

<WRAP tip></WRAP>

<WRAP important></WRAP>

<WRAP alert></WRAP>

<WRAP round help></WRAP>

<WRAP download></WRAP>

<WRAP todo></WRAP>

Safety Notes:

<WRAP danger></WRAP>

<WRAP warning></WRAP>

<WRAP caution></WRAP>

<WRAP round notice></WRAP>

<WRAP round safety></WRAP>

You can use notes and boxes also inside text with spans like this: info, help, alert, important, tip, download, todo and round box and danger, warning, caution, notice, safety.

<wrap info>info</wrap>, <wrap help>help</wrap>, ...

You can mark text as highlighted, less significant and especially emphasised.

You can mark text as <wrap hi>highlighted</wrap>, <wrap lo>less significant</wrap> and <wrap em>especially emphasised</wrap>.

This might look ugly in some templates and should be adjusted accordingly.

This text will appear indented.

<wrap indent>This text will appear indented.</wrap>

This text will appear ”outdented”.

<wrap outdent>This text will appear "outdented".</wrap>

Inside this code block the words will wrap to a new line although they are all in one line.

<WRAP prewrap 250px>
<code>
Inside this code block the words will wrap to a new line although they are all in one line.
</code>
</WRAP>

Here follows a spoiler: Darth Vader is Luke's father.

Here follows a spoiler: <wrap spoiler>Darth Vader is Luke's father.</wrap>

Just select the text in the spoiler box to be able to read its content.

The following text is hidden: John, please revise that sentence.

The following text is hidden: <wrap hide>John, please revise that sentence.</wrap>

Warning: The text will still appear in the source code, in non-modern browsers and is searchable. Do not hide any security risky secrets with it!

The following will add a pagebreak:

The following will add a pagebreak: <WRAP pagebreak></WRAP>

This has no effect on the browser screen. A pagebreak will force a new page in printouts.

The following will try to avoid a pagebreak:

The following will try to avoid a pagebreak: <WRAP nopagebreak>much content, belonging together (like a long table)</WRAP>

This also has no effect on the browser screen. It will try to avoid a page break in printouts.

This text appears on the screen, but not in print.

<wrap noprint>This text appears on the screen, but not in print.</wrap>

This text does not appear on the screen, but only in print.

<wrap onlyprint>This text does not appear on the screen, but only in print.</wrap>

I advice against using the following typography classes. It's better to create semantic classes that reflect their meaning instead.

• font family: sansserif, serif, monospace
• font size: bigger, muchbigger, smaller
• font colour: fgred, fggreen, fgblue, fgcyan, fgviolet, fgyellow, fggrey, fgwhite, fgblack
• background colour: bgred, bggreen, bgblue, bgcyan, bgviolet, bgyellow, bggrey, bgwhite, bgblack

You can combine and nest all classes and types of boxes, e.g.

<WRAP box bggreen fgblack 350px right :en>
//**__Outer green box floats right__**//

<WRAP 165px left>
Inner nested box floats left and is partly <wrap em hi>__em__phasized and __hi__ghlighted with nested <wrap bigger>__bigger__ text</wrap> inside</wrap>.
</WRAP>

Text inside outer right box, but beneath inner left box.

<WRAP clear></WRAP>

<WRAP round tip>
Round tip box underneath, after a ''clear''.
</WRAP>

</WRAP>

You can change the language and the reading direction of a wrap container by simply adding a colon followed by the language code, like this:

<WRAP :he>
זה עברית. ((<wrap :en>This means "This is Hebrew.", at least according to [[http://translate.google.com/|Google Translate]].</wrap>))
</WRAP>

The text direction (rtl, right to left or ltr, left to right) will get inserted automatically and is solely dependent on the language. The list of currently supported languages is taken from: http://meta.wikimedia.org/wiki/Template:List_of_language_names_ordered_by_code (If you specify a language not listed there, it simply won't do anything.)