How to contribute

First of all, don't be afraid of adding or editing content. Play with it!

Wiki Structure

A wiki consists of individual pages. These pages can be arranged in so called namespaces. Pages and namespaces are very similar to files and directories on your hard drive.
To get an idea, check the Sitemap (which can be found in the sidebar on the left).

The wiki structure can be flat (all pages within one namespace) or hierarchical. Both structures have advantages and disadvantages.
If certain pages should be open to only a specific user group but not others, then it makes sense to group content in different namespaces. That way rights can be set for a whole namespace, without having to set policies for every page. Moreover, new pages created in a namespace inherit the namespace's settings.
You can read more on namespaces in the Manual of the DokuWiki.

For now, all namespaces are restricted. Though it is possible to allow access to a broader audience, such as information which isn't sensible.

Overview and short description of current namespaces. Note, not all of these might be visible for you.

Namespace Purpose
guide Mostly methodical information and tutorials
lss Information for the interest of LSS members only
library Pages on scientific topics
news Contains pages, like a blog, publicly accessible
doodle For surveys
public Pages which are without access restriction, such as the frontpage
system Wiki infrastructure
admin Organizational stuff

Creating a new page

There are different methods to create new pages. You can use your preferred method. Though it is advisable, to think about to which namespace the new page could be added. This will maintain a certain structure. Yet, do not feel forced to fit your content in to the current structure. If necessary, the new page's location can be changed later.
Methods to add a new page:

  • setting a link to a new page which doesn't exist yet. The link will be shown in red, such as this. You can click on such links and you will find a button “Create this page” near the top. Examples:
    • [[test]] → this page will be created without any explicit namespace. It will inherit the namespace of the page where you placed it first. If you set this link in the lss namespace, test will also be in the lss namespace such as start.
    • [[help:students:test]] → This test page will be in the subnamespace “students” of the namespace “help”. If these namespaces haven't existed before then they will be created.
  • Use the search for a page. If there is no result the wiki offers to create a new page on that topic.
  • Directly type the desired page name as URL. This page's adress is https://wikis.ovgu.de/lss/doku.php?id=guide:howtowiki. It means the page “howtowiki” is in the namespace “guide”. Replace <..> in ?id=<…> with your new page.
  • Use a Plugin called newpage Below is the object of that plugin. In the drop-down menu, the current namespace is selected by default. You can select change it to any other namespace. When you don't know where to safe, then use ROOT. The page name can be set in the edit field.

The namespaces lss is special. It is restricted to LSS members only. Use it if you want to share sensible information with members but not with other users, such as students. All other namespaces (except system, wiki and admin) are mostly unrestricted. You can created new namespaces as needed, too.

Renaming or deleting a page

If you want to delete a page, you have go into the edit-page mode and remove the whole content. Though this method will keep the old versions of the deleted page on the server.
Directly renaming or moving an article can only be done by a user with admin rights. However, you can alternatively create a new page with the corrected location or name and copy the content from the initial page. Subsequently, delete the initial page.

Formatting content

Sectioning

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 1 ====== (not drawn for readability)
===== Headline Level 2 =====   (not drawn for readability)
==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

By using four or more dashes, you can make a horizontal line:


Formatting

Creating or Editing content is rather simple. Most of the text formatting can be done by with the page editor. Just click a button to write bold, italic, or underlined. That way you don't have to remember wiki specific code. However, you will find out, the formatting of a text block is done by enclosing it with the symbols **, //, and __ for bold, italic, and underlined. Try out **bold** to get bold text.

Equations

Mathematical equations and symbols can be entered in latex-style, such as this $e^q ua+ion$. Just written inline by:

$e^q ua+ion$

Alternative an equation in a seperate line: $$e^q ua+ion$$

$$e^q ua+ion$$

More information here: DokuWiki Latex Math (used Mathjax

Lists

To make a dotted list, you put two spaces, an asterisk(*) and another space in the beginning of the a line

  * this is the first line
    * to use a sublevel, add two more spaces before the asterisk, 4 in total
      * another two spaces for the next sublevel
  * continue with the first level

Result:

  • this is the first line
    • to use a sublevel, add two more spaces before the asterisk, 4 in total
      • another two spaces for the next sublevel
  • continue with the first level

To make a numbered list put a - symbel instead of the asterisk:

  - this is the first line
    - sublevel 1
      - sublevel 2

Result:

  1. this is the first line
    1. sublevel 1
      1. sublevel 2

DokuWiki supports 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: jgille@ovgu.de 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: <jgille@ovgu.de> 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 [[guide:howtowiki#internal|this Section]].

Notes:

  • Links to existing pages are shown in a different style from nonexisting ones.
  • DokuWiki does not use CamelCase to automatically create links by default, but this behavior can be enabled in the 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 Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: 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]].

Windows Shares

Windows shares like this are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate Intranet.

Windows Shares like [[\\server\share|this]] are recognized, too.

Notes:

  • For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the “local zone”).
  • In any other browser just copy the link and paste it into the file explorer in windows. For any other operating system, check here.

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://php.net|{{guide:scroll.png?100}}]]

Please note: The image formatting is the only formatting syntax accepted in link names.

Tables

Creating tables is easy but not obvious. Cells are seperated by |-symbols. The optional header is divided with ^-symbols. To align cell contents you can set two spaces on next to the delimiters. With ::: or double delimiters you can define to row-span or column-span multiple times.

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    |  center  | Row 1 Col 3        |
|left  | some colspan (note the double pipe) ||
| :::    | Row 3 Col 2     |  right|
Heading 1 Heading 2 Heading 3
Row 1 Col 1 center Row 1 Col 3
left some colspan (note the double pipe)
Row 3 Col 2 right

More regarding tables.

Modifying tables interactively

Table Edit button Each table has their own edit button. This will open the table in the editTable plugin. When editing a text in the normal editor, a new table can be inserted using the Add Table button.

Editing

Select a cell by tab key, cursor keys or mouse click. To overwrite cell contents just start to type, to change cell contents press enter or double click a cell. To confirm an edit press enter or move to another cell.

Inside a cell, all wiki syntax allowed for tables can be used as usual. Editing

Manipulating Cells

Context Menu

All cell manipulation is done via a right-click context menu. To do so select a single cell or select multiple cells by dragging. The context menu allows you to change the alignment and header state of cells, adding and removing columns and rows and gives a way to make cells span over multiple rows or columns.

Dragging the small square at the bottom right of a selected cell will fill the same content to the cells selected by dragging. Please note that auto-continuing rows (eg. counting onward) like in Excel is not supported currently.

Move

Rows and Columns can be rearranged by moving them. Contents will be moved accordingly. Please note that rows or columns can not be moved out or into column or row spans respectively.

Moving a row Moving a column

To move a row, grab the handle at the top of its header cell, then move it to where you want it to go.

For moving columns grab the handle at the left of its header cell.

Resize

Resizing columns For editing purposes columns can be manually resized by dragging the handle on the right of their header cell. Note that this is not saved by DokuWiki (since DokuWiki has no width or other properties for tables) but might be a good help when editing big tables with many columns that might fit on a screen page with less scrolling by resizing column width.

This section is copied from editTable plugin describtions

sortable Tables

To create a table with sortable data can be created by using the datatable plugin. This plugin is activated by putting the tags <datatables> around a normal table. See the example

More information on datatables

<datatables>
^ Heading1 ^ Heading2 ^ Heading3 ^
| A1 | B2 | C1 |
| A2 | B3 | C1 |
| A1 | B1 | C1 |
</datatables>
Heading1 Heading2 Heading3
A1 B2 C1
A2 B3 C1
A1 B1 C1

HTML

Wiki pages can also be formatted by using HTML. Such section are enclosed in <html> or <HTML> tags.
An example copied from the DokuWiki manual:

This is some inline HTML

And this is some block HTML

It is generated by with this source:

<html>
This is some <span style="color:red;font-size:150%;">inline HTML</span>
</html>
<HTML>
<p style="border:2px dashed red;">And this is some block HTML</p>
</HTML>

Embed Youtube Videos

<HTML><iframe width="320" height="240" src="https://www.youtube-nocookie.com/embed/kJDkdCBrPnU" frameborder="0" allowfullscreen></iframe></HTML>

replace kJDkdCBrPnU with your intended video id. Then, you can adapt the size of the object.


For a playlist, the yt link looks slightly different:

<HTML><iframe width="320" height="240" src="https://www.youtube-nocookie.com/embed/videoseries?list=PLFAC320731F539902" frameborder="0" allowfullscreen></iframe></HTML>

Uploading Content

Files, such as Images, can be uploaded via the Media Manager which can be found in the sidebar. Each separate file upload is limited to 24mb.

The screenshot shows the layout of the Manager. On the left part you the existing namespace structure for files. These structure can be different for files than for pages. Yet it is advisable to maintain a similar structure to the page namespace.
On the right side, there are three Tabs:

  • Media Files - showing uploaded files in the currently selected namespace
  • Upload - this tab is used to upload files
  • Search - for files by name

The Upload tab is shown in the screenshot. The select button is used to locate a file on your system. Below, is field to set a name for the uploaded file. The filename can also be used to create the file in a specific or new namespace. In the screenshot the current namespace is guide. The new file name is :upload:media_upload.png. This will upload the new file in the namespace guide:upload. The colon : separates the namespace, while a leading colon references to the currently selected namespace (here: guide). Overwriting files might be restricted because certain rights are necessary which would allow deletion of other content.

Media Files

You can include external and internal images, videos and audio files with curly brackets. Optionally you can specify the size of them.

Real size:

Resize to 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:           {{https://secure.php.net/images/php.gif?200x50}}

By using left or right whitespaces you can choose the alignment.

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

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

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

Supported Media Formats

DokuWiki can embed the following media formats directly.

Image gif, jpg, png
Video webm, ogv, mp4
Audio ogg, mp3, wav
Flash swf

If you specify a filename that is not a supported media format, then it will be displayed as a link instead.

By adding ?linkonly you provide a link to the media without displaying it inline

{{guide:scroll.png?linkonly}}

scroll.png This is just a link to the image.

Fallback Formats

Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility.

For example consider this embedded mp4 video:

{{video.mp4|A funny video}}

When you upload a video.webm and video.ogv next to the referenced video.mp4, DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.

Additionally DokuWiki supports a “poster” image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a video.jpg file would work.

Dynamic Images

Sometimes you may want to embed a dynamic image like this one

Using the usual method:

{{http://kalsey.com/tools/buttonmaker/button.php?outerBorder=666666&innerBorder=ffffff&barPosition=32&leftFill=7a0037&leftText=LSS&leftTextColor=ffffff&leftTextPosition=9&rightFill=898E79&rightText=WIKI&rightTextColor=ffffff&rightTextPosition=47}}

doesn't work:

button.php

This is because DokuWiki assumes an image ends with .gif,.jpg or .png but this file ends with .php. The trick is to append an additional CGI parameter like this: &.png – the CGI will ignore this unknown parameter but DokuWiki will think it's an image.

You also need to add a question mark at the very end or DokuWiki will think the CGI parameters are caching options.

Special Characters need to be encoded in the url!

{ %7B
} %7D
| %7C

Example of usage of the &.png? syntax:

{{http://kalsey.com/tools/buttonmaker/button.php?outerBorder=666666&innerBorder=ffffff&barPosition=32&leftFill=7a0037&leftText=LSS&leftTextColor=ffffff&leftTextPosition=9&rightFill=898E79&rightText=WIKI&rightTextColor=ffffff&rightTextPosition=47&.png?}}

BTW: You can find buttonmaker webfrontends at

More

To get a more information use the link to the DokuWiki's syntax.


Most of the information of this page is a translation from a help provided by the OvGU's URZ ( Help for Wiki authors) provided under the CC-BY-SA licence.

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
guide/howtowiki.txt · Last modified: 2020/01/20 22:11 by seengel
Back to top
CC Attribution-Share Alike 3.0 Unported
chimeric.de = chi`s home Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0