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.

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 mark something as ~~deleted~~ 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: 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 link 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.

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 to this Section.

Notes:

Links to existing pages are shown in a different style from nonexisting ones.
DokuWiki does not use wp>CamelCase to automatically create links by default, but this behavior can be enabled in the doku>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 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 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 [[
server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate wp>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): ```

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

` or ``''.

  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.

  
  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.
  

==== Syntax Highlighting ====

[[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://qbnz.com/highlighter/|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.  or .


/**
 * 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 [[doku>syntax_highlighting|advanced options]] available for syntax highlighting, such as highlighting lines or adding line numbers.

==== Downloadable Code Blocks ====

When you use the ''`` or ``'' 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:

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, [[http://simplepie.org/|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. [[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:
===== Control Macros =====
Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
^ Macro           ^ Description |

|   | If this macro is found on the page, no table of contents will be created | | | 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 |
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:
INFO:syntaxplugins