This page is a reference and demonstration on the basics on how to use dokuwiki. For a more comprehensive how-to, you can also take a look at the manual here, or some tutorial screencasts made by the (dokuwiki) community here. To see how this page is formatted using dokuwiki's syntax, click on the edit page link to the right (note that only users with appropriate permissions will be able to see the edit page link. Right now that is Danni, Kai, and myself ).

A dokuwiki page is divided into sections by the headlines on a page. If there are more than 3 headlines a Table of Contents will be generated automatically. Headlines are created by wrapping text in progressive '=' signs, like so:

==== Headline 1 ====

will look like this:

and so on:

=== Headline 2===

== Headline 3 ==

DokuWiki supports bold, italic, underlined and monospaced texts. and you can combine all these. The formatting syntax to achieve this looks like so:

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

Dokuwiki also supports _subscript and ^superscript, like so:

Dokuwiki also supports <sub>subscript</sub> and <sup>superscript</sup>

To create an unordered list (bulleted) you indent the text with 2 spaces and then a '*' like so:

  * First item
  * Second Item
      * Sub item
  * Third item

becomes:

• First item
• Second Item
  • Sub item
• Third item

To make an ordered list, you do the same thing but use a '-' instead of a '*'

  - First item
  - Second item
    - Sub item
  - Third Item

becomes:

1. First item
2. Second item
   1. Sub item
3. Third Item

To create tables you begin a line with either ^ for headings or | for rows. Each new ^ or | character creates a new column. So, for example take a look at the following:

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | Row 2 Col 2     | Row 2 Col 3        |
| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |

This will result in a table that looks like so when published (saved):

If you want to connect cells horizontally (column span), leave the cell empty (not even whitespace) like so (but make sure to maintain the same number of cell separators per line or the table will break):

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | Row 2 Col 2 and Row 2 Col 3 are now merged ||
| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |

results in:

Vertical span, or row spans, can be accomplished by filling the cell with ':::' like so:

^ 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                    |

looks like:

You can also have vertical headings (headings on rows) like so:

|                      ^ Heading 1            ^ Heading 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | Row 1 Col 2          |                            |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

Will look like this:

Note that Row 2 Col 3 is empty but since it has whitespace, the columns are not merged as in the previous example. This way you can denote an empty field / cell.

To align the content in cells use at least 2 spaces on the left, right, or both sides of the content in the cell like so:

^           Table with alignment           ^^^
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
|         right|    center    |left          |
|left          |         right|    center    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

becomes:

Dokuwiki allows embedding image, video, and audio files on pages. To do this, you first upload your media file using the Media Manager (covered in a screencast here). Once your file is uploaded, you then use the dokuwiki embed syntax to embed the file on the page. For example, I already have uploaded an image of the GJL logo, and now I use the following syntax to embed it on this page like so:

{{wiki:gjl-star.png}}

will then look like so:

To align an embedded media file, add whitespace to the beginning, end, or both sides of the reference to the file in media manager ¹⁾ (the wiki:gjl-star.png part). So this:

{{wiki:gjl-star.png  }}
{{  wiki:gjl-star.png}}
{{  wiki:gjl-star.png  }}

Will look like this when published:

And here's a video example, aligned to the center of the page :

{{ samplevideo_1280x720_5mb.mp4  }}

Note that in this example, there is no colon before the filename. That is because when I uploaded this sample file to with the Media Manager I uploaded it to the root namespace (see the footnote on the bottom of the page about namespaces), whereas with the logo, I uploaded it to the wiki namespace. If I had uploaded the video to the wiki namespace like the logo, the embed syntax would look like this instead:

{{ wiki:samplevideo_1280x720_5mb.mp4  }}

To create a page, just add a new link to a page. If that page does not exist, dokuwiki will automatically create the page. The syntax to create a link looks like so:

[[namespace:page|link text]]

If you leave the namespace out, the page will be created in the root namespace To delete a page, navigate to the page you would like to delete, edit the page, and remove all of the content and then press save. Super easy! and finally, to add a comments section to any page add the following :

~~DISCUSSION~~