Skip to content

Information about dokuwiki

Martin Gabelmann edited this page Jul 6, 2019 · 1 revision

Informations about DokuWiki

Dokuwiki is a wiki software written in php without the need of any kind of database (article content is stored in text files). Because of its simplicity it is very easy for both moderators and developers to get into usual workflows and the source code within a very short time. Additional plugins and templates offer applications beyond the usual wiki stuff.

Depending on your challenge the following literature is also useful.

Moderators

In general you should read the dokuwiki user manual and syntax pages. Every new installed Dokuwiki instance has its Playground section where you can try out things and do learning by doing.

Developers

There is a devel section on dokuwiki. Have a look at the directory layout, environment, core and template article. You don't want to edit the code of plugins or maybe even everything outside your template because of compatibility with further updates.

Writing Articles

Pages and Namespaces

Dokuwiki manages its content with so called namespaces. Technically they are realised with usual (unix) directory trees. Pages are simple .txt (ascii) files stored in there, e.g. /srv/htdocs/www/project/employees/cheef.txt would be reachable over http://project.kit.edu/employees/cheef

but since Dokuwiki is to make life easier you don't have to care about that while filling it with content. However, it is good to know for some special usage we will discuss later.

Create new Page

Simply type the URL in the address bar that will store your page https://projectname.kit.edu/namespace/sitename If the site doesn't exist and if you have write access in the namespace, there will be a button to create that page. If the side already exists, you also can edit it that way.

To create a namespace with a start page use ''/namespace/start''. Dokuwiki will redirect to that site if someone joins the namespace via the navigation.

Rename/Move/Delete Article/Namespace

If the move plugin is installed, moving/renaming/deleting can be done very easy. For more complex stuff, you can also move/edit the files via shell commands. For deleting a page simply remove all the content in the editor and click save. To rename an entry click on the ''ADMIN'' button from the page you want to rename/move. In the ''further plugins'' section click on the ''rename/move namespace'' link and proceed.

Editors

You should always make use of the preview button. Before saving give a small summary that other people know what is done for a well documented history.

There is a calc2dokuwiki plugin for libreOffice calc, to convert excel tables into dokuwiki ones...