Formatting Syntax

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

DokuWiki supports bold, //italic//, __underlined__ and monospaced texts. Of course you can __//combine//__ all these.

DokuWiki supports **bold**, //italic//, __underlined__ andmonospaced texts.
Of course you can **__//combine//__** all these.

You can use ~subscript~ and ^superscript^, too.

You can use~subscript~and^superscript^, too.

You can mark something as deleted as well.

You can mark something asdeleted 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: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
apagenameor use an additionallink`` ``text.

Wiki pagenames are converted to lowercase automatically, special characters are not allowed.

You can use some:namespaces by using a colon in the pagename.

You can usesome:namespaces by using a colon in the pagename.

For details about namespaces see doku>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 tothis`` ``Section.

Notes:

* Links toexisting`` ``pagesare shown in a different style fromnonexisting ones.
* DokuWiki does not usewp>CamelCaseto automatically create links by default, but this behavior can be enabled in thedoku>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 doku>Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: wp>Wiki.

DokuWiki supportsdoku>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 wp>Intranet.

Windows Shares likethis 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 theMozilla`` ``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 atlocalization): <code - 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:

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 ((This is a footnote)) 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((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)):

Resized external image:

Real size:
Resize to given width:
Resize to given width and height:
Resized external image:

By using left or right whitespaces you can choose the alignment.

{{ wiki:dokuwiki-128.png}}

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

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

| 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

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:

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

- The same list but ordered
- Another item
- 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


          2
          Also take a look at the [FAQ on list items](doku>faq:lists).
        
          4
          ##### Text Conversions
        
          6
          DokuWiki can convert certain pre-defined characters or strings into
        
          7
          images or other text or HTML.
        
          9
          The text to image conversion is mainly done for smileys. And the text to
        
          10
          HTML conversion is used for typography replacements, but can be
        
          11
          configured to use other HTML as well.
        
          13
          #### Text to Image Conversions
        
          15
          DokuWiki converts commonly used [wp\>emoticons](wp>emoticon)
        
          16
          to their graphical equivalents. Those
        
          17
          [doku\>Smileys](doku>Smileys) and other images can be
        
          18
          configured and extended. Here is an overview of Smileys included in
        
          19
          DokuWiki:
        
          21
          ` * 8-) %%  8-)  %%`\
        
          22
          ` * 8-O %%  8-O  %%`\
        
          23
          ` * :-( %%  :-(  %%`\
        
          24
          ` * :-) %%  :-)  %%`\
        
          25
          ` * =)  %%  =)   %%`\
        
          26
          ` * :-/ %%  :-/  %%`\
        
          27
          ` * :-\ %%  :-\  %%`\
        
          28
          ` * :-? %%  :-?  %%`\
        
          29
          ` * :-D %%  :-D  %%`\
        
          30
          ` * :-P %%  :-P  %%`\
        
          31
          ` * :-O %%  :-O  %%`\
        
          32
          ` * :-X %%  :-X  %%`\
        
          33
          ` * :-| %%  :-|  %%`\
        
          34
          ` * ;-) %%  ;-)  %%`\
        
          35
          ` * ^_^ %%  ^_^  %%`\
        
          36
          ` * :?: %%  :?:  %%`\
        
          37
          ` * :!: %%  :!:  %%`\
        
          38
          ` * LOL %%  LOL  %%`\
        
          39
          ` * FIXME %%  FIXME %%`\
        
          40
          ` * DELETEME %% DELETEME %%`
        
          42
          #### Text to HTML Conversions
        
          44
          Typography: [DokuWiki](DokuWiki) can convert simple text
        
          45
          characters to their typographically correct entities. Here is an example
        
          46
          of recognized characters.
        
          48
          -\> \<- \<-\> =\> \<= \<=\> \>\> \<\< \-- \-\-- 640x480 (c) (tm) (r)
        
          49
          "He thought 'It's a man's world'\..."
        
          51
          `-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)`
        
          52
          `"He thought 'It's a man's world'..."`
        
          54
          The same can be done to produce any kind of HTML, it just needs to be
        
          55
          added to the [pattern file](doku>entities).
        
          57
          There are three exceptions which do not come from that pattern file:
        
          58
          multiplication entity (640x480), 'single' and "double quotes". They
        
          59
          can be turned off through a [config
        
          60
          option](doku>config:typography).
        
          62
          ##### Quoting
        
          64
          Some times you want to mark some text to show it's a reply or comment.
        
          65
          You can use the following syntax:
        
          67
           I think we should do it
        
          69
          \> No we shouldn't
        
          71
          \>\> Well, I say we should
        
          73
          \> Really?
        
          75
          \>\> Yes!
        
          77
          \>\>\> Then lets do it! ~~~
        
          79
          I think we should do it
        
          81
          \> No we shouldn't
        
          83
          \>\> Well, I say we should
        
          85
          \> Really?
        
          87
          \>\> Yes!
        
          89
          \>\>\> Then lets do it!
        
          91
          ##### Tables
        
          93
          DokuWiki supports a simple syntax to create tables.
        
          95
          \^ Heading 1 \^ Heading 2 \^ Heading 3 \^ | Row 1 Col 1 | Row 1 Col 2
        
          96
          | Row 1 Col 3 | | Row 2 Col 1 | some colspan (note the double pipe)
        
          97
          || | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 |
        
          99
          Table rows have to start and end with a *|* for normal rows or a *\^*
        
          100
          for headers.
        
          102
          ` ^ Heading 1      ^ Heading 2       ^ Heading 3          ^`\
        
          103
          ` | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |`\
        
          104
          ` | Row 2 Col 1    | some colspan (note the double pipe) ||`\
        
          105
          ` | Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |`
        
          107
          To connect cells horizontally, just make the next cell completely empty
        
          108
          as shown above. Be sure to have always the same amount of cell
        
          109
          separators!
        
          111
          Vertical tableheaders are possible, too.
        
          113
          | \^ Heading 1 \^ Heading 2 \^ \^ Heading 3 | Row 1 Col 2 | Row 1 Col
        
          114
          3 | \^ Heading 4 | no colspan this time | | \^ Heading 5 | Row 2
        
          115
          Col 2 | Row 2 Col 3 |
        
          117
          As you can see, it's the cell separator before a cell which decides
        
          118
          about the formatting:
        
          120
          ` |              ^ Heading 1            ^ Heading 2          ^`\
        
          121
          ` ^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |`\
        
          122
          ` ^ Heading 4    | no colspan this time |                    |`\
        
          123
          ` ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |`
        
          125
          You can have rowspans (vertically connected cells) by adding *%%:::%%*
        
          126
          into the cells below the one to which they should connect.
        
          128
          \^ Heading 1 \^ Heading 2 \^ Heading 3 \^ | Row 1 Col 1 | this cell
        
          129
          spans vertically | Row 1 Col 3 | | Row 2 Col 1 | ::: | Row 2 Col 3
        
          130
          | | Row 3 Col 1 | ::: | Row 2 Col 3 |
        
          132
          Apart from the rowspan syntax those cells should not contain anything
        
          133
          else.
        
          135
          ` ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^`\
        
          136
          ` | Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        |`\
        
          137
          ` | Row 2 Col 1    | :::                        | Row 2 Col 3        |`\
        
          138
          ` | Row 3 Col 1    | :::                        | Row 2 Col 3        |`
        
          140
          You can align the table contents, too. Just add at least two whitespaces
        
          141
          at the opposite end of your text: Add two spaces on the left to align
        
          142
          right, two spaces on the right to align left and two spaces at least at
        
          143
          both ends for centered text.
        
          145
          \^ Table with alignment \^\^\^ | right| center |left | |left |
        
          146
          right| center | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
        
          148
          This is how it looks in the source:
        
          150
          ` ^           Table with alignment           ^^^`\
        
          151
          ` |         right|    center    |left          |`\
        
          152
          ` |left          |         right|    center    |`\
        
          153
          ` | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |`
        
          155
          Note: Vertical alignment is not supported.
        
          157
          ##### No Formatting
        
          159
          If you need to display text exactly like it is typed (without any
        
          160
          formatting), enclose the area either with *%%%%'' tags or even
        
          161
          simpler, with double percent signs ''\%%*.
        
          163
          This is some text which contains addresses like this:
        
          164
          http://www.splitbrain.org and **formatting**, but nothing is done
        
          165
          with it. The same is true for %%//\_\_this\_\_ text// with a smiley
        
          166
          ;-)%%.
        
          168
          ` `\
        
          169
          `  This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.`\
        
          170
          `  `\
        
          171
          ` The same is true for %%//__this__ text// with a smiley ;-)%%.`
        
          173
          ##### Code Blocks
        
          175
          You can include code blocks into your documents by either indenting them
        
          176
          by at least two spaces (like used for the previous examples) or by using
        
          177
          the tags *%%%%* or *%%%%*.
        
          179
          ` This is text is indented by two spaces.`
        
          181
          `This is preformatted code all spaces are preserved: like <-this`
        
          183
           This is pretty much the same, but you could use it to show that
        
          184
          you quoted a file. 
        
          186
          Those blocks were created by this source:
        
          188
          `   This is text is indented by two spaces.`
        
          190
          ` `\
        
          191
          ` This is preformatted code all spaces are preserved: like              <-this`\
        
          192
          ` `~~~
        
          194
          ` `\
        
          195
          ` This is pretty much the same, but you could use it to show that you quoted a file.`\
        
          196
          ` `
        
          198
          #### Syntax Highlighting
        
          200
          [wiki:DokuWiki](wiki:DokuWiki) can highlight sourcecode,
        
          201
          which makes it easier to read. It uses the
        
          202
          [GeSHi](http://qbnz.com/highlighter/) Generic Syntax
        
          203
          Highlighter \-- so any language supported by GeSHi is supported. The
        
          204
          syntax uses the same code and file blocks described in the previous
        
          205
          section, but this time the name of the language syntax to be highlighted
        
          206
          is included inside the tag, e.g. *\* or *\*.
        
          208
           /**
        
          210
          `* The HelloWorldApp class implements an application that`\
        
          211
          `* simply displays "Hello World!" to the standard output.`\
        
          212
          `*/`
        
          214
          class HelloWorldApp {
        
          216
          `   public static void main(String[] args) {`\
        
          217
          `       System.out.println("Hello World!"); //Display the string.`\
        
          218
          `   }`
        
          220
          } ~~~
        
          222
          The following language strings are currently recognized: //4cs 6502acme
        
          223
          6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada
        
          224
          aimms algol68 apache applescript apt\_sources arm asm asp asymptote
        
          225
          autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf
        
          226
          biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm
        
          227
          chaiscript chapel cil c\_loadrunner clojure c\_mac cmake cobol
        
          228
          coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c\_winapi dart
        
          229
          dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e
        
          230
          erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp
        
          231
          gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic
        
          232
          haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno
        
          233
          intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart
        
          234
          klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode
        
          235
          lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic
        
          236
          mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3
        
          237
          mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc
        
          238
          objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz
        
          239
          parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16
        
          240
          pike pixelbender pli plsql postgresql postscript povray powerbuilder
        
          241
          powershell proftpd progress prolog properties providex purebasic pycon
        
          242
          pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff
        
          243
          rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic
        
          244
          smalltalk smarty spark sparql sql sshconfig standardml stonescript swift
        
          245
          systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig
        
          246
          typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog
        
          247
          vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram
        
          248
          xbasic xml xojo xorg\_conf xpp yaml z80 zxbasic//
        
          250
          There are additional [advanced
        
          251
          options](doku>syntax_highlighting) available for syntax
        
          252
          highlighting, such as highlighting lines or adding line numbers.
        
          254
          #### Downloadable Code Blocks
        
          256
          When you use the *%%%%* or *%%%%* syntax as above, you might
        
          257
          want to make the shown code available for download as well. You can do
        
          258
          this by specifying a file name after language code like this:
        
          260
          `` `` 
        
          262
          \ \ 
        
          264
          If you don't want any highlighting but want a downloadable file,
        
          265
          specify a dash (*-*) as the language code: *%%\%%*.
        
          267
          ##### Embedding HTML and PHP
        
          269
          You can embed raw HTML or PHP code into your documents by using the
        
          270
          ''%%
        
          272
          
        
          273
          \%%'' or *%%%%* tags. (Use uppercase tags if you need to enclose
        
          274
          block level elements.)
        
          276
          HTML example:
        
          278
          
        
          280
          
        
          281
          This is some inline HTML
        
          283
          
        
          284
          
        
          285
          And this is some block HTML
        
          287
          
        
...
not set
This is some inline HTMLAnd this is some block HTMLPHP example:

echo 'The PHP version: '; echo phpversion(); echo ' (generated inline HTML)'; echo '

'; echo ''; echo '
The same, but inside a block level element:'.phpversion().'
'; ~~~

echo 'The PHP version: '; echo phpversion(); echo ' (inline HTML)'; echo '

'; echo ''; echo '
The same, but inside a block level element:'.phpversion().'
';

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:

^ 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. If HTML is disabled all 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. wiki: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 wiki: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:

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 %%%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call |

DokuWiki's syntax can be extended by Plugins. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:

~~INFO:syntaxplugins~~