User Tools

Site Tools

Upload failed. Maybe wrong permissions?

wiki:how_to

How to use the Wiki

Dokuwiki cheat sheet: A 1-page PDF with many useful hints

Edit a page

Click on Edit on the right of the page (pen symbol).

Add a new page

  • Option 1: Choose where your new page should be located in the first box (think of it as the folder system on your computer) and enter the new name (as it appears in the link) in the right box, then click on “add page”:
  • Option 2: Type the url address of the page you want to create and click enter. You will be asked to create the page since it does not exist
  • Option 3: Create a link to a non-existing page from where you want to link it to, e.g. go to playground, edit the page and add a link to a page named test (click on “edit this page” to see how this was done). Save the page and then click on the newly created link. It will ask you to create the page since it doesn't exist yet. The page “playground” will now have a link to the page “test”.

Delete a page

Save an empty page and it will be deleted.

Basic text formatting

Use the quickbuttons or the following syntax for italic, bold, underlined, monospaced, subscript, superscript and deleted text. You can also combine several of these.

//italic//, **bold**, __underlined__, ''monospaced'', <sub>subscript</sub>, <sup>superscript</sup>, <del>deleted</del>, **__//''combine''  //__**

Headlines

Headlines are created by using the = sign before and after the title: e.g. == this would be a small title ==. The more equal signs you use, the bigger the title will be (up to 5 levels). The largest title thus has 6 equal signs.

If there are more than three headlines, a table of contents is generated automatically – this can be disabled by including the string ~~NOTOC~~ in the document.

Paragraphs

Leave a blank line to create a new paragraph.
And use a double backslash \\ at the end of a line to force a new line.

  • Option A: Add double square brackets around the link or email address, e.g. [[http://esn.ch]].
  • Option B: Copy your link while editing a page, eg. http://esn.ch, then highlight it, click on the symbol with the lying chain (the one without the globe for links to other sites inside the dokuwiki, and the one with the globe for outside links). E.g. for http://esn.ch this will look like: http://esn.ch.

If you want your link to appear under a new name, enter anything after the vertical bar |: e.g. [[http://esn.ch|Homepage of ESN Switzerland]] gives Homepage of ESN Switzerland.

Lists

  • This is
  • a list
    • with 2 levels
  1. This is
  2. a list
    1. with numbers

Use the quickbuttons or the following syntax (3 spaces needed before the * or -):

  * This is 
  * a list
    * with 2 levels

  - This is
  - a list
    - with numbers

Tables

Table syntax: headings, columns, rows, line breaks, cells spanning multiple rows or columns:

Heading 1 Heading 2 Heading 3
Row 1 Col 1 Row 1 Col 2 Row 1 Col 3
Heading 4 some colspan
Row 3 Col 1 Row 3 Col 2 Row 3 Col 3
new line within cell
Row 4 Col 1 this cell spans vertically Row 4 Col 3
Row 5 Col 1 Row 5 Col 3
^ Heading 1      ^ Heading 2       ^ Heading 3          ^ 
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | 
^ Heading 4      | some colspan                        || 
| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3  \\ new line within cell  |
| Row 4 Col 1    | this cell spans vertically      | Row 4 Col 3        |
| Row 5 Col 1    | :::             | Row 5 Col 3        |
  • Table rows have to start and end with a | for normal rows or a ^ for headers. (Note that if you want the first cell of a row to be a header it is enough to start the cell with a ^)
  • Use a double backslash \\ to force a line break within a cell.
  • A cell spanning 2 columns, ends with a double line || (and 3 lines if it spans 3 columns, etc.)

Alignment:

Table with alignment
left center right
^  Table with alignment ^^^
|left  |  center  |  right|
  • Leave at least 2 spaces before the | at the end of the cell to left align your text, 2 to each side to center it, and 2 to its left to right align it.

Images and other files

External and internal images can be included with curly brackets.

Real size:

Images can also be resized to a given width:

Resize to given width and height1):

Resized external image:

Real size:                        {{wiki:dokuwiki-128.png}}
Resize to given width:            {{wiki:dokuwiki-128.png?50}}
Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}

By using left or right whitespaces the alignment can be chosen:

{{ wiki:dokuwiki-128.png?50}}
{{wiki:dokuwiki-128.png?50 }}
{{ wiki:dokuwiki-128.png?50 }}

Of course, a caption can be added (displayed as a tooltip by most browsers), too.

This is the caption

{{ wiki:dokuwiki-128.png?50 |This is the caption}}

Documents such as pdfs can be added in the same way: Newbees presentation (pdf). Use the filemanager to locate your file.

{{:newbees.pdf|Newbees presentation (pdf)}}

Doodle polls

You can add a doodle directly to a wiki page.

<doodle
 title="What do you like best?"
 auth="none|ip|user"
 adminUsers="user1|user2"
 adminGroups="group1|group2"
 voteType="single|multi"
 closed="true|false" 
>
 * Option 1 
 * Option 2 **some wikimarkup** \\ is __allowed__!
 * Option 3
</doodle>
  • Pick the options from auth, adminUsers, etc. that fit your poll.
  • Only the title and at least one option are required. Do not change the options and their order, after the first vote has been casted!
  • The “auth” option will have no effect since all users who use this wiki are logged in.

Example use:

title="Example poll" auth="none" voteType="single" closed="false"
Real name

This was achieved using:

<doodle title="Example poll" auth="none" voteType="single" closed="false">
 * I like
 * I hate
 * I don't know
</doodle>

Notes

To add notes like these

here comes my informative text

heres come my informative text in a small box

use the following formatting:

<WRAP info round>here comes my informative text</WRAP>
<wrap info>here comes my informative text in a small box</wrap>

I.e. WRAP in capital letters for a large box, and wrap in small letters for a small in-line box. This was a note of type info. Other possible types of notes are todo, important, tip, alert, help.

You can also click on “Edit this page” to view how the following notes were obtained:

to do tip important alert help download

To do

Important

Tip

Alert

Help

Download

1) 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
wiki/how_to.txt · Last modified: 06.03.2013 22:10 by Nora Leonardi