Table of Contents
NOTE: JarrettHoman does not take responsibility for anything added to this wiki page after July 26, 2014 12:59 AM PST
This guide is essentially a skim-downed version of this page with additions and subtractions specific to the needs of Civcraft.
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.
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: email@example.com 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: <firstname.lastname@example.org> are recognized, too.
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]].
- When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.
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.
You can add footnotes 1) 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
==== Headline Level 3 ==== === Headline Level 4 === == Headline Level 5 ==
By using four or more dashes, you can make a horizontal line:
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
Also take a look at the FAQ on list items.
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
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.
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
Then lets do it!
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|
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.