01.01. Formatting Syntax

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 different workaround mentioned in the Mozilla Knowledge Base. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in conf/lang/en/lang.php (more details at localization):

  conf/lang/en/lang.php

  <?php
  /**
   * Customization of the english language file
   * Copy only the strings that needs to be modified
   */
  $lang['js']['nosmblinks'] = '';

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 1 ======
===== Headline Level 2 =====
==== 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:           {{https://www.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
• :-|
• ;-)
• ^_^
• m(
• :?:
• :!:
• 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 include code 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 text is indented by two spaces.

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.

Those blocks were created by this source:

  This is text is indented by two spaces.

<code>
This is preformatted code all spaces are preserved: like              <-this
</code>

<file>
This is pretty much the same, but you could use it to show that you quoted a file.
</file>

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 uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. <code java> or <file 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: 4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic

There are additional advanced options available for syntax highlighting, such as highlighting lines or adding line numbers.

When you use the <code> or <file> syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:

<file php myexample.php>
<?php echo "hello world!"; ?>
</file>

myexample.php

<?php echo "hello world!"; ?>

If you don't want any highlighting but want a downloadable file, specify a dash (-) as the language code: <code - myfile.foo>.

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

• NASA Wants SpaceX and Blue Origin To Deliver Cargo To the Moon by BeauHD (2024/11/21 06:00)
• NASA's Curiosity Rover Captures 360-Degree View of Mars by BeauHD (2024/11/21 03:00)
• US Regulators Seek To Break Up Google, Forcing Chrome Sale by BeauHD (2024/11/21 00:00)
• Inside the Booming 'AI Pimping' Industry by BeauHD (2024/11/20 22:30)
• Ubuntu Linux Impacted By Decade-Old 'needrestart' Flaw That Gives Root by BeauHD (2024/11/20 20:00)

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:

• Add New Page plugin 2024-11-08 by Damien Regad, Benjamin Santalucia, Sam Wilson and other contributors
  Adds a "new page form" to any wiki page.
• Avatar 2023-12-04 by Daniel Rodrigues, Michael Hamann, Gina Häußge, et al.
  Displays avatar images
• Barcodes 2024-09-17 by Matthias Lohr
  Barcodes (1D & 2D) for DokuWiki
• Blockquote Plugin 2020-09-27 by Anika Henke (previous author: Gina Haeussge)
  Write quotations in a semantically correct way
• Blog 2023-10-24 by Michael Hamann, Michael Klier, Gina Haeussge
  Use DokuWiki as blogging tool. (previous authors: Esther Brunner)
• Bureaucracy Plugin 2023-05-16 by Andreas Gohr
  Create forms and generate pages or emails from them
• Cloud Plugin 2023-02-11 by Michael Hamann, Michael Klier, Gina Haeussge
  Displays the most used words in a word cloud.
• CSV Plugin 2022-01-03 by Andreas Gohr
  Displays a CSV file, or inline CSV data, as a table
• Structured Data Plugin 2024-01-30 by Andreas Gohr
  Add and query structured data in your wiki
• Diagrams plugin 2023-12-14 by Innovakom + CosmoCode
  Embed diagrams.net editor (formerly draw.io)
• discussion plugin 2021-12-31 by Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulte
  Provides discussion funtionality for wiki pages
• Dw2Pdf plugin 2023-11-25 by Andreas Gohr and Luigi Micco
  DokuWiki to PDF converter
• Feed Plugin 2020-10-26 by Michael Klier, Gina Haeussge
  Generates feeds for other plugins
• folded plugin 2023-07-22 by Michael Hamann, Fabian van-de-l_Isle, Christopher Smith, Esther Brunner
  Foldable page sections
• Gallery Plugin 2024-04-30 by Andreas Gohr
  Creates a gallery of images from a namespace or RSS/ATOM feed
• gh plugin 2022-11-27 by Andreas Gohr
  andi@splitbrain.org
• Posts Heatmap 2024-10-30 by H.-H. PENG (Hsins)
  Showing heatmap of yearly pages (posts) based on created date.
• hidepages plugin 2013-08-02 by Matthias Schulte
  Hide pages from search results and/or sitemap
• Icons Plugin 2024-10-30 by Giuseppe Di Terlizzi
  Embed icons in Dokuwiki
• include plugin 2023-09-22 by Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
  Functions to include another page in a wiki page
• Indexmenu Plugin 2024-01-05 by Samuele Tognini, Gerrit Uitslag
  Show a customizable and sortable index for a namespace
• Info Plugin 2020-06-04 by Andreas Gohr
  Displays information about various DokuWiki internals
• keyboard 2023-02-23 by Gina Häußge
  The keyboard plugin provides a combined syntax and action plugin in order to markup text as keyboard keys, similar to (and making use of) the existing (X)HTML tag <kbd>…</kbd>. A quick button for the markup is automatically inserted into the toolbar of the edit form.
• Linkback plugin 2023-12-30 by Michael Hamann, Gina Häußge
  Adds Trackback and Pingback support to DokuWiki
• log plugin 2019-02-27 by Adrian Lang
  Provide simple logs
• nspages plugin 2024-10-07 by Guillaume Turri
  Presents a toc of the selected namespace using <nspages>
• Pagelist Plugin 2023-08-27 by Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
  Lists pages in a nice formatted way
• PDF.js 2020-06-29 by Szymon Olewniczak
  Show pdf files using PDF.js
• Publish Plugin 2024-10-02 by Jarrod Lowe, Andreas Gohr, Dominik Eckelmann
  Integrate a publishing process into DokuWiki
• Search Form Plugin 2024-02-08 by Gerrit Uitslag, (previous: Adolfo González Blázquez)
  Inserts a search form in any page
• simplenavi plugin 2023-11-13 by Andreas Gohr
  Create a simple navigation tree based on namespaces
• Socialite plugin 2019-01-01 by Fernando Ribeiro
  Lightweight responsive social buttons
• starred plugin 2023-06-13 by Andreas Gohr
  Personal bookmarking for pages
• struct plugin 2024-07-08 by Andreas Gohr, Michael Große, Anna Dabrowska
  Add and query additional structured page data
• svgEmbed plugin 2021-06-09 by Michael Bowers
  Allows the use of the standard media syntax, but SVG files are placed with the <object> or <embed> tag, not the <img> tag.
• Tag Button plugin 2024-10-18 by Louis Ouellet
  Add a tag via a button
• tagsections plugin 2020-04-21 by i-net software / Gerry Weißbach
  Add tags to sections using the taggadd gui
• Tag Plugin 2023-10-17 by Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
  tag wiki pages
• Task Plugin 2020-09-26 by Michael Klier, Gina Haeussge
  Brings task management to DokuWiki.
• ToDo 2024-05-10 by Leo Eibler, Christian Marg, Markus Gschwendt, Robert Weinmeister
  Create a checkbox based todo list with optional user assignment (basic syntax: <todo>This is a ToDo</todo>). It can also be used as a lightweight task list management system.
• Translation Plugin 2024-04-30 by Andreas Gohr
  Supports the easy setup of a multi-language wiki.
• Typography plugin 2020-07-31 by Satoshi Sahara
  Enable typesetting capabilities with CSS font properties such as font face, size, weight, and color of text
• Video Sharing Site Plugin 2024-03-24 by Andreas Gohr
  Easily embed videos from various Video Sharing sites. Example: {{youtube>XXXXXX}}
• Wrap Plugin 2023-08-13 by 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.
• yourip plugin 2022-08-07 by Artem Sidorenko, Hella Breitkopf
  Show the ip information of visitor

02.01. Site Identity

You can change the logo, favicon and apple touch icon the same way as for the dokuwiki template.

If you enable doLogoChangesByNamespace in the template's configuration, Writr will use the closest logo as the site logo. Namespace Logos can be added using the media library. To show a different logo in a namespace, just make sure to add the custom logo.png in the namespace. This feature is recursive.

If you enable doLogoLinkChangesByNamespace in the template's configuration, Writr will set the logo's url to the same namespace it found the logo.

If you enable doTitleChangesByNamespace in the template's configuration, Writr will set the title found in the closest nstitle.txt page.

If you enable doTaglineChangesByNamespace in the template's configuration, Writr will set the title found in the closest nstagline.txt page.

02.02. Navigation

02.03. Sidebar

02.04. Included Hooks

02.05. Color Schemes

02.06. Content Width

If you enable makeFullWidth in the template's configuration, Writr will use content_border as the right border of the content.

02.07. ToolBar

02.08. Tooltips

03.01. List

04.01. Changelog

04.02. Planning

04.03. Fixes