How to... syntax
Of course there are different styles and formatting options available. On this page you will get a brief overview, a more detailed version can be found here. If you want to play with and try some options, feel free to do so at the playground.
Basic Text Formatting
There are many options to style your text, such as bold, italic, underlined and monospaced
. Of course you can combine
all these.
There are many options to style your text, such as **bold**, //italic//, __underlined__ and ''monospaced''. 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 and linebreaks
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.
If you use some blank lines instead
a new paragraph will be created.
If you use some blank lines instead a new paragraph will be created.
You should use forced newlines only if really needed.
Sectioning
You can use up to five different levels of headlines to structure your content.
Headline Level 1
Headline Level 2
Headline Level 3
Headline Level 4
Headline Level 5
====== 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:
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 ;-)%%.
Links
There are 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: itbadmin@biologie.hu-berlin.de are recognized, too.
There are 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.
- When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.
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://www.php.net|{{wiki:dokuwiki-128.png}}]]
Please note: The image formatting is the only formatting syntax accepted in link names.
The whole imageimage and link syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
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.