c - wiki

dokuwiki-css-doc

Anonymous (anonymous@undisclosed.example.com) — 2021-08-25T05:21:18+00:00

css

using css… bla bla bla

Using IDs

When you use custom IDs in your template for assigning styles, be sure that the ID does not conflict with an existing ID. In particular, be sure that it won’t conflict with the IDs automatically assigned to section headers. The easiest way to ensure this is to use two adjacent underscores (__) in your ID. Because section IDs are always valid pagenames, they will never contain adjacent underscores.

In plugins use <pluginname>__<id>. For example 'searchindexplugin__buttonfield'

Styling based on page properties

Most often people only need to modify a style of some element on all pages. For example one may want to change the font style for h1 heading. But from time to time, it is desirable to modify a style only on certain page. You could want a special background for any page in the attic namespace so that readers instantly realize that they are reading outdated documentation left as a reference. One could also want to add a specific style to some elements if visitor is a connected user, or only on edit page but not when viewing the page. This is possible because most template use an internal DokuWiki function called tpl_classes(). All you need to know is that this function is used by templates to add classes based on page properties to one of the top div element. For example, when a connected visitor is reading the page :wiki:syntax the default template produces this div element :

<div id="dokuwiki__top" class="site dokuwiki mode_show tpl_dokuwiki loggedIn   showSidebar hasSidebar lv_1 ns__wiki ns_wiki_ pg_syntax pg_wiki_syntax">

This offers quite a lot of possibilities. you can create a style for

this page only

conf/userstyle.css.snippet

div.dokuwiki.pg_wiki_syntax {
  background: red;
  h1 {
    text-transform: uppercase;
  }
}

any page viewed by a connected user in a namespace just below the root

conf/userstyle.css.snippet

div.dokuwiki.loggedin.lv_1.mode_show {
  background: red;
  h1 {
    text-transform: uppercase;
  }
}

If your particular template does not use the tpl_classes() function, you will have different classes available. In fhis case, you may want to contact the developer of your theme and ask that the template makes use of this function.

Enough examples, here are the details :

dokuwiki
This class is always present
mode_<ACT>
the action that created the page. Most of the time, this will be mode_view. But see action_modes for a list of action modes. Note that plugins may create more actions.
tpl_<name_of_template>
By default, this will be tpl_dokuwiki. If you use the sprintdoc, this will be tpl_sprintdoc. and if you use the Art for water template, this will be tpl_artforwater.
loggedIn
This class is present only for connected user. There is no «notloggedin» or «loggedout» class. To target page for not loggedIn users, use the :not() CSS pseudo class.
notFound
This class is added for non existent page. Follow this link :this:page:does:not:exist:on:purpose ; the rendered page will have this notFound class in its main DW div.
home
This class is only present on the main DokuWiki page.
showSidebar and hasSidebar
These 2 elements shown are not added by the tpl_classes() function. They are specific to the default template and not described here (although their meaning is quite obvious)
lv_<X>
This is the tree depth level of a page. for :dokuwiki page, this level is 0 (zero), so the class will be lv_0 ; for the page devel:css this will be 1, lv_1 and for fr:plugin:struct:aggregation, this will be 3, lv_3.
ns__<namespace-chain>
These class are built on the page namespace. Each namespace component concatenated with _ separator. If a namespace has an _ in its name, then this result in a __ in the class name. examples :
- page :start ⇒ class ns__
- page fr:plugin:struct:aggregation ⇒ 3 classes are added :
  - class ns__fr
  - class ns__fr_plugin
  - class ns__fr_plugin_struct
- page matching_food_and_drinks:big_juicy_steak:pan_galactic_gargle_blaster ⇒ 2 classes added :
  - class ns__matching__food__and__drinks
  - class ns__matching__food__and__drinks_big__juicy__steak
ns_<last_ns_component>_
This class is based on the last component of the page namespace. Please note that for all pages in the root namespace, there is nothing since the empty root namespace would produce ns__ which is already added by the previous rule. Examples :
- page :start ⇒ nothing
- page fr:plugin:struct:aggregation ⇒ class ns_aggregation_
- page matching_food_and_drinks:big_juicy_steak:pan_galactic_gargle_blaster ⇒ class ns_big__juicy__steak_
pg_<full-page-id>
Same thing as the namespace one, but for the page name. _ in page name are also doubled in the class name. examples :
- page :start ⇒ pg_start
- page fr:plugin:struct:aggregation ⇒ class pg_fr_plugin_struct_aggregation
- page matching_food_and_drinks:big_juicy_steak:pan_galactic_gargle_blaster ⇒ class pg_matching__food__and__drinks_big__juicy__steak_pan__galactic__gargle__blaster
pg_<rel-page-id>
Same thing as the full-page-id one but don't use the namespace components. For pages in the root namespace, this would be the same as <full-page-id>, so it is not present
- page :start ⇒ nothing
- page fr:plugin:struct:aggregation ⇒ class pg_aggregation
- page matching_food_and_drinks:big_juicy_steak:pan_galactic_gargle_blaster ⇒ class pg_pan__galactic__gargle__blaster

example selectors

To target all start page in any namespace use this

div.dokuwiki.pg_start

To target the main page

div.dokuwiki.home

To target a page exactly in the fr namespace

div.dokuwiki.ns__fr.lv_1

To target a page anywhere in the fr namespace (meaning fr:syntax or fr:plugin:struct:aggregation)

div.dokuwiki.ns__fr

To target “this page does not yet exist” in any namespace when using the boozurk template and only for anonymous user and when user is viewing the page but not editing it

div:not(.loggedIn).dokuwiki.notFound.mode_show.tpl_boozurk

A note for non english page and namespace

CSS accepts fnencode settings

dokuwiki-rewrite-rules

Anonymous (anonymous@undisclosed.example.com) — 2023-07-30T06:10:58+00:00

How does rewriting work ?

First, let's examine an URL. Here is an URL

http://www.example.com/foo/bar?x=toto&y=titi

It has 4 parts :

http : The protocol
www.example.com : the servername
foo/bar : the path
x=toto&y=titi : the query string

apache only rewrite the path. Apache can add things to the query string with its QSA flag. Apache can only add to the query string. It has no other possibility to change it.

So, how does it work ?

The PATH is compared with the first rule. if it matches, then it is rewritten. apache goes to the next rule. It compares the (maybe changed) PATH with this rule and, if it matches the PATH is modified. Apache goes on until there is no more rewrite rules. When this is done, apache has a new form of the url and deals with new URL.

Rules can do more than just rewriting the PATH. I just show 2 things that happen here :

A rule can say : “OK, I've rewritten the path. No need to go further” with its L (last) flag
A rule can also say : “I rewrie the path, but I also add something to the query string”, with its QSA flag

It is important to note that this happens inside the apache server only. Your browser is not aware of this, and will never see the result of the rewriting rules.

example1 :

You request http://www.example.com
The rewrite rules transform it to http://www.example.com/doku.php
Apache now has to deal with this new URL. Hopefully, it will know what to do with php files and it will run doku.php ; but this is beyond the scope of rewrite rules.

example 2 :

You request http://www.example.com/foo:bar
The rewrite rules transform it to http://www.example.com/doku.php?id=foo:bar
Apache now has to deal with this new URL. Hopefully, it will know what to do with php files…

Default rules explained

These are the default rules, presented in .htaccess.dist

if PATH starts with _media/, give it to lib/exe/fetch.php and we're done
```
RewriteRule ^_media/(.*)              lib/exe/fetch.php?media=$1  [QSA,L]
```
Example and explanation: Given the URL http://example.com/_media/wiki:dokuwiki.png we have
- ^_media/(.*) that matches _media/wiki:dokuwiki.png
  - The part corresponding to (.*)¹⁾ is associated with $1. So $1 is now wiki:wiki.png.
- it is rewritten as lib/exe/fetch.php?media=wiki:dokuwiki.png
  - Note that for the ?media=wiki:dokuwiki.png part to be effectively added to the URL, we have to use the [QSA] flag
- Our job is done. ie no need to test for the next rewrite rule. Since this rule applied, it is the Last one in this run. That's the role of the [L] flag.
- In the end, apache now has to deal with this URL:
```
http://example.com/lib/exe/fetch.php?media=wiki:dokuwiki.png
```
if PATH starts with _details/, give it to lib/exe/detail.php and we're done
```
RewriteRule ^_detail/(.*)             lib/exe/detail.php?media=$1  [QSA,L]
```
Example and explanation: This is the same as above, but with _details instead of _media.
if PATH starts with _export/FOO/, give it to doku.php?do=export_FOO and we're done
```
RewriteRule ^_export/([^/]+)/(.*)     doku.php?do=export_$1&id=$2  [QSA,L]
```
Example and explanation: This is almost the same as the preceding cases. The only difference is we have 2 groups of parentheses instead of 1. We'll have $1 and $2 as “variables”. So, given the URL http://example.com/_export/raw/wiki:syntax we have
- _export/([^/]+)/(.*) that matches _export/raw/wiki:syntax
  - The part corresponding to ([^/]*)²⁾ is associated with $1. So $1 is now raw.
  - The part corresponding to (.*)³⁾ is associated with $2. So $2 is now wiki:syntax.
- it is rewritten as doku.php?do=export_raw&id=wiki:syntax
- Note that for the ?do=export_raw&id=wiki:syntax part to be effectively added to the URL, we have to use the [QSA] flag
- Our job is done. ie no need to test for the next rewrite rule. Since this rule applied, it is the Last one in this run. That's the role of the [L] flag.
- In the end, apache now has to deal with this URL:
```
http://example.com/doku.php?do=export_raw&id=wiki:syntax
```
if PATH is empty (ie full URL is just http://example.com), give it to doku.php, and we're done.
```
RewriteRule ^$                        doku.php  [L]
```
The resulting URL is
```
http://example.com/doku.php
```

if the PATH does not map to a file

RewriteCond %{REQUEST_FILENAME}       !-f

and if it does not map to a folder

RewriteCond %{REQUEST_FILENAME}       !-d

then give it to doku.php, and we're done

RewriteRule (.*)                      doku.php?id=$1  [QSA,L]

It transforms

http://example.com/faq:footerbuttons<code>into
http://example.com/doku.php?id=faq:footerbuttons

Because of the tests performed in 5, we are sure that from here on, we deal with an existing file or folder.
if the url/file is index.php, then use doku.php instead of index.php and continue with next rule, as there is no [L] flag.
```
RewriteRule ^index.php$ doku.php
```
It transforms
```
http://example.com/index.php<code>into
http://example.com/doku.php
```
There is no more rule, so no special rewrite ⇒ just serve the file or folder as usual.

Here is presented the same information but more friendly

initial URL	rewritten URL
initial URL	(what apache will effectively deal with)
`http://example.com/_media/wiki:dokuwiki.png`	`http://example.com/lib/exe/fetch.php?media=wiki:dokuwiki.png`
`http://example.com/_details/wiki:dokuwiki.png`	`http://example.com/lib/exe/fetch.php?media=wiki:dokuwiki.png`
`http://example.com/lib/image/page.png`	No rewrite because `lib/image/page.png` is a file that exists.
`http://example.com/_export/raw/wiki:syntax`	`http://example.com/doku.php?do=export_raw&id=wiki:syntax`
`http://example.com/index.php`	`http://example.com/doku.php`

¹⁾

that means all the characters that are left. (after media/)

²⁾

that means the first word left after _export/

³⁾

that means everything that's left (after _export/raw/)

dokuwiki

Anonymous (anonymous@undisclosed.example.com) — 2026-05-07T04:58:51+00:00

DokuWiki

DokuWiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki.

Read the DokuWiki Manual to unleash the full power of DokuWiki.

Download

DokuWiki is available at https://download.dokuwiki.org/

All documentation and additional information besides the syntax description is maintained in the DokuWiki at www.dokuwiki.org.

About DokuWiki

Installing DokuWiki

Using DokuWiki

Customizing DokuWiki

DokuWiki Feedback and Community

Copyright

2004-2020 © Andreas Gohr andi@splitbrain.org⁴⁾ and the DokuWiki Community

The DokuWiki engine is licensed under GNU General Public License Version 2. If you use DokuWiki in your company, consider donating a few bucks .

Not sure what this means? See the FAQ on the Licenses.

⁴⁾

Please do not contact me for help and support – use the mailinglist or forum instead

syntax

Anonymous (anonymous@undisclosed.example.com) — 2026-05-07T04:58:51+00:00

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 “Edit this 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 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

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.

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>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 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'] = '';
```

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://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 ⁵⁾ 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:

Media Files

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.

Supported Media Formats

DokuWiki can embed the following media formats directly.

Image	`gif`, `jpg`, `png`
Video	`webm`, `ogv`, `mp4`
Audio	`ogg`, `mp3`, `wav`
Flash	`swf`

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.

Fallback Formats

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.

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
- You may have different levels
Another item

The same list but ordered
Another item
1. Just use indention for deeper levels
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.

Text Conversions

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.

Text to Image Conversions

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

Text to HTML Conversions

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.

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

	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        |

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

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

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.

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 |

Note: Vertical alignment is not supported.

No Formatting

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

Code Blocks

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>

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

Downloadable Code Blocks

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

RSS/ATOM Feed Aggregation

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:

Parameter	Description
any number	will be used as maximum number items to show, defaults to 8
reverse	display the last items in the feed first
author	show item authors names
date	show item dates
description	show the item description. All HTML tags will be stripped
nosort	do not sort the items in the feed
n[dhm]	refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours).

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

First Segment of the Fehmarnbelt Tunnel Is In Place by BeauHD (08/05/2026 13:00)
The Canvas Hack Is a New Kind of Ransomware Debacle by BeauHD (08/05/2026 09:00)
Sam Altman Had a Bad Day In Court by BeauHD (08/05/2026 05:50)
IMF Warns New AI Models Risk 'Systemic' Shock To Finance by BeauHD (08/05/2026 01:00)
60% of MD5 Password Hashes Are Crackable In Under an Hour by BeauHD (08/05/2026 00:00)

Control Macros

Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:

Macro	Description
~~NOTOC~~	If this macro is found on the page, no table of contents will be created
~~NOCACHE~~	DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the <php> syntax above is used), adding this macro will force DokuWiki to rerender a page on every call

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:

a2s plugin 2022-06-21 by Schplurtz le Déboulonné
Convert ASCII art diagram to nice embedded SVG images.
Bureaucracy Plugin 2023-05-16 by Andreas Gohr
Create forms and generate pages or emails from them
Command Line Interface (CLI) Plugin 2020-08-18 by Schplurtz le Déboulonné
Renders transcripts of command line interactions, e.g. for shell and dynamic language interpretor tutorials
comment 2023-08-18 by Gina Häußge, Michael Klier
Add comments/notes to your wiki source that won't be shown on the page.
database2 plugin 2017-08-01 by Oliver Geisen
Integration of database2 into DokuWiki as syntax plugin
Structured Data Plugin 2024-01-30 by Andreas Gohr
Add and query structured data in your wiki
Doodle Plugin 3 2017/03/30 by Matthias Jung
helps to schedule meetings
DoxyCode Plugin 2024-02-16 by Lukas Probsthain
Parse code in dokuwiki with cross referencing to doxygen documentation.
do plugin 2024-05-12 by Andreas Gohr
Assign tasks within the wiki
Dw2Pdf plugin 2023-11-25 by Andreas Gohr and Luigi Micco
DokuWiki to PDF converter
Encrypted Passwords Plugin 2023-12-20 by Andreas Gohr
This plugin let you store 256 bit AES encrypted passwords in your DokuWiki pages. The password can be decrypted by clicking them (Javascript must be enabled).
Example silly plugin 2017-02-18 by Schplurtz le Déboulonné
Demo. Get text between <tag> and </tag>. Does nothing except stripping <tag> and </tag>
filelisting plugin 2023-09-27 by Szymon Olewniczak
List files in currently viewed namespaces
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
geotag plugin 2024-08-24 by Mark C. Prins
Allow a user to annotate pages with a geotag
Graphviz Plugin 2016-02-03 by Andreas Gohr
Create graph images from Graphviz dot language
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
Open Document Plugin 2023-03-03 by Andreas Gohr, Aurelien Bompard, Florian Lamml, LarsDW223
Export the current Wiki page to a OpenOffice ODT file
OpenLayers map plugin for DokuWiki 2025-01-31 by Mark C. Prins
Provides a syntax for rendering OpenLayers based maps in wiki pages.
PageQuery Plugin 2025-01-14 by Mark C. Prins, previously Symon Bent
Search for (fulltext) and list wiki pages, sorted and optionally grouped by name, date, creator, abc, etc. in columns. Insert the pagequery markup wherever you want your list to appear. E.g.{{pagequery>[query;fulltext;sort=key:direction,key2:direction;group;limit=??;cols=?;inwords;proper]}} [..] = optional
PHP Include 2006-05-11 by Markus Frosch
Allows you to make an include of an PHP File on Server
Poem 2012-07-06 by Danny Lin
<poem> tag that embeds a block with linebreaks preserved.
S5 Slideshow Plugin 2022-11-30 by Andreas Gohr
Display a Wiki page as S5 slideshow presentation
sortablejs 2023-04-20 by vaxquis
Allow sorting tables by columns
Spatial Helper plugin for DokuWiki 2025-02-08 by Mark C. Prins
Provides spatial indexing and spatial search facilities.
tabbox plugin 2018-04-29 by Andreas Gohr
Insert a tabbed box in a page
Tab include plugin 2024-08-07 by Ikuo Obataya
Tab control of wiki pages
Tag Plugin 2023-10-17 by Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
tag wiki pages
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.
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.

⁵⁾

This is a footnote

⁶⁾

when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing

welcome

Anonymous (anonymous@undisclosed.example.com) — 2026-05-07T04:58:51+00:00

Welcome to your new DokuWiki

Congratulations, your wiki is now up and running. Here are a few more tips to get you started.

Enjoy your work with DokuWiki,
– the developers

Create your first pages

Your wiki needs to have a start page. As long as it doesn't exist, this link will be red: start.

Go on, follow that link and create the page. If you need help with using the syntax you can always refer to the syntax page.

You might also want to use a sidebar. To create it, just edit the sidebar page. Everything in that page will be shown in a margin column on the side. Read our FAQ on sidebars to learn more.

Please be aware that not all templates support sidebars.

Customize your Wiki

Once you're comfortable with creating and editing pages you might want to have a look at the configuration settings (be sure to login as superuser first).

You may also want to see what plugins and templates are available at DokuWiki.org to extend the functionality and looks of your DokuWiki installation.

Join the Community

DokuWiki is an Open Source project that thrives through user contributions. A good way to stay informed on what's going on and to get useful tips in using DokuWiki is subscribing to the newsletter.

The DokuWiki User Forum is an excellent way to get in contact with other DokuWiki users and is just one of the many ways to get support.

Of course we'd be more than happy to have you getting involved with DokuWiki.

c - wiki

dokuwiki-css-doc

css

Using IDs

Styling based on page properties

example selectors

A note for non english page and namespace

dokuwiki-rewrite-rules

How does rewriting work ?

Default rules explained

dokuwiki

DokuWiki

Download

Read More

Copyright

syntax

Formatting Syntax

Basic Text Formatting

Links

External

Internal

Interwiki

Windows Shares

Image Links

Footnotes

Sectioning

Headline Level 3

Headline Level 4

Headline Level 5

Media Files

Supported Media Formats

Fallback Formats

Lists

Text Conversions

Text to Image Conversions

Text to HTML Conversions

Quoting

Tables

No Formatting

Code Blocks

Syntax Highlighting

Downloadable Code Blocks

RSS/ATOM Feed Aggregation

Control Macros

Syntax Plugins

welcome

Welcome to your new DokuWiki

Create your first pages

Customize your Wiki

Join the Community