You are here: Wiki > start > editors > sandbox > syntax

---

Formatting Syntax

The wiki supports some simple markup language, which tries to make the source 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 sandbox pages.

Basic Text Formatting

The wiki supports bold, italic, and underlined texts. Of course you can combine all these.

The wiki supports **bold**, //italic//, and __underlined__.

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

The wiki supports multiple ways of creating links.

External

External links are not recognized automagically: http:www.google.com or simply www.google.com - You need to set the link text : This Link points to google .

External links are not recognized automagically: http:www.google.com or simply www.google.com - You need to set the link text : This Link points to google .

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.

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 .

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:

{{wiki:dokuwiki-128.png}}

{{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 ((This is a footnote)) 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. A table of contents is generated automatically. Headings must be preceded by an empty line.

====== Headline Level 1 ======

===== Headline Level 2 =====

==== Headline Level 3 ====

=== Headline Level 4 ===

== Headline Level 5 ==

Images and Other Files

You can include external and internal doku>images 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.

This is the caption This is the caption

If you specify a filename (external or internal) that is not an image (''gif, jpeg, png''), then it will be displayed as a link instead.

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

Indentation

Indenting lines may be accomplished by using Lists or Code Blocks (see below), or by forcing extra spaces to appear to the left of the text (as seen on our Index page).

Unlike most other text editors, you cannot simply press the Tab or Spacebar to indent text at the left margin. Pressing the Tab key has no effect, pressing the Spacebar once has no effect, while pressing it twice turns any following text into a Code Block. The only way of inserting one or more extra spaces is to force them to appear by inserting Non-Breaking SPaces (abbreviated to NBSP) when you really need them. To do this, press Alt+255 as follows. Holding down the Alt key, press 2,5,5 on the Numerical Keypad (number pad), usually located to the right of your main keyboard, then release the Alt key. On releasing the Alt key a NBSP will appear. E.g., typing

Line 1

[Alt+255][Alt+255]Line 2

displays as

Line 1

Line 2

Unfortunately NBSPs cannot be copied & pasted from one part of a Wiki to another. They must be added individually each time. Thus, if you notice that your previously two-space indented line now appears as a Code Block, you should delete the spaces to the left of the text and reinsert two NBSP as described above. Any improvement to this rather primitive feature would be welcome.

Lists

The wiki supports unordered lists. To create a list item, indent your text by two spaces and use a *. Nested lists are supported by indenting by a further two spaces for each level.

• This is a list
• The second item
• You may have different levels
• Another item

  * This is a list

  * The second item

    * You may have different levels

  * Another item

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.

Embedded HTML

Some inline HTML is supported, the subset available has not yet been determined. Inline HTML does not require the <html></html> tags to be used (as opposed to DokuWiki), although there is no problem if they are used.

Unsupported Syntax

This wiki does not support the following syntax, which DokuWiki does support. Some examples of this syntax may remain in this wiki from prior to conversion.

Horizontal Rules

In DokuWiki, sing four or more dashes ---- on their own line, you can make a horizontal line.

Monospace

Two single quotes (''xxx'') would cause the contained text to printed in a monospaced font.

Ordered Lists

Only unordered lists are supported at present, ordered list syntax is not functional. Ordered list syntax is the same as unordered list syntax, except using a dash character - instead of asterisks.

- The same list but ordered

- Another item

- Just use indention for deeper levels

- That's it

- The same list but ordered

- Another item

- Just use indention for deeper levels

- That's it

Text Conversions

The following text sequences were converted to emoticons or correct symbols in DokuWiki, they are no longer converted:

• 8-)
• 8-O
• :-(
• :-)
• =)
• :-/
• :-\
• :-?
• :-D
• :-P
• :-O
• :-X
• :-|
• ;-)
• ^_^
• :?:
• :!:
• LOL
• FIXME
• DELETEME
• ->
• <-
• <->
• =>
• <=
• <=>
• >>
• <<
• 640x480
• (c)
• (tm)
• (r)

Quoting

Quoted text can use > as a line prefix to indent. This syntax does not have any special behaviour on the wiki, but still works reasonably well. Eg:

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

Wiki syntax suppression tags

<nowiki>xxx</nowiki> tags or text contained by pairs of percent symbols (%%xxx%%) would prevent contained syntax from being interpreted as wiki syntax and display the raw text.

Code Block Features

Code blocks cannot be constructed by indenting lines by two spaces.

This wiki does not support syntax highlighting within code blocks, which uses the DokuWiki syntax of <code langname></code>

<file> tags used for downloadable code blocks are unsupported.

Embedding PHP

Inline PHP (<php>) is not supported.

RSS/ATOM Feed Aggregation

DokuWiki supports fetching RSS feeds from remote servers. Unsurprisingly, this is disabled on here.

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

Control Macros

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

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, adding this macro will force DokuWiki to rerender a page on every call

---

Last edited by Edgemaster on 22/03/2021 at 00:29