Table of Contents

Setting up Alien's DokuWiki

Here's what I had to do to get the Wiki up and running. Remember that the DokuWiki has no need for a database server like MySQL. The Wiki pages, indexes and archives are stored as files below the DokuWiki root (or anyplace else if you want to separate the content from the code). This makes it ideal to install in your own home directory. You do not need any additional permissions on the webserver.

I upgraded to dokuwiki-2008-05-05 and decided to re-visit this page as well. Some of the instructions were outdated, and the section about the blog plugin has been removed, now that I use WordPress software for my new blog. The old revisions of this page still contains everything I edited away.

The DokuWiki comes with a default template which is very functional but rather bland-looking. The DokuWiki web page lists a lot of user-contributed templates, some of which are visually more appealing or functionally better. I opted for the Monobook template. This is a port from the default MediaWiki template (as seen on WikiPedia) which I find very nice looking. This template is actively developed and has many nice features, which make it even better to customize.

Installing the dokuwiki tarball

You have to take care with the default umask and dmask settings because you will end up with lots of other files and directories that are owned by the webserver and read-only to you. This has the effect for instance, that you cannot delete the ./data/cache directories and files any longer!

Template and plugins

Template: MonoBook

Plugin: note

I use the “note” plugin for DokuWiki. This plugin displays nice informational icons in the margin, like “tip” “warning” “information” and “note”. The plugin source is available at the DokuWiki site. The initial versiondid not do what I wanted from it, plus it required you to copy the images into your template directory, and add the CSS to the template's stylesheet. So I hacked it and my changes were accepted by the plugin author, so that now the plugin is fully contained into the DokuWiki's ./lib/plugins/note/ directory.
An example of this plugin is used a bit higher up in the page (in the Installing the dokuwiki tarball section).

Plugin: keyboard

The keyboard plugin enables you to add visual clues to keypress examples. Like, Windows users often need Ctrl+Alt+Del !
This plugin automatically adds a button to the button bar of the Wiki editor. If the plugin does not show up after you reload the editor, you may have to purge the wiki's cached javascript code by visiting this link:

http://your.domain.com/path/to/dokuwiki/lib/exe/js.php?edit=1&write=1&purge=1

Plugin: displaywikipage

This plugin enables you to embed a Wiki page into any other Wiki page. It is used by the Monobook template and can be downloaded from that same website.

Plugin: referrers

The referrers plugin (also found on tatewake.com) keeps a list of visitors of the Wiki and particularly the HTTP_REFERER value the browser sends to Apache. This is what (part of) the page would look like:

Note: I needed to manually create the local_prefs.php file and fill it with defaults, or else the configuration manager would give an error when trying to save the preferences for this plugin:

touch ./lib/plugins/referrers/local_pref.php
chmod 666 ./lib/plugins/referrers/local_pref.php

and this is what the file looks like (the value for referrer-ignore was set through the configuration manager)

<?php
// This file is automatically generated
$re_settings['referrer-ignore'] = 'alien.slackbook.org/dokuwiki';
$re_settings['dontcountadmin'] = '';
$re_settings['dontcountusers'] = '';

It is required for the plugin to work as intended, to have a non-empty value for referrer-ignore!

Plugin: captcha

I needed this plugin to get rid of Wiki spammers. Before I had installed this, spammers would attack my discussion pages on a daily basis. Get it at http://www.dokuwiki.org/plugin:captcha

Plugin: odt

This plugin enables you to export any wiki page as an OpenOffice.org text document. Get it at http://www.dokuwiki.org/plugin:odt - you may have to watch out for plugins that expand the wiki syntax - such a plugin needs to be able to generate OpenOffice code. For instance, I use the note plugin, and the odt plugin editor wrote a patch for the note plugin to make it support odt. In the next section I have included a patch for the Monobook template's toolbox to make it contain an “OpenOffice export” link. I also patched the plugin so that you can define an “odt template” document which will be used as the basis for the generated .ODT document. My own template is here: wiki-template.odt. The patch I used is

diff -uarN odt.orig/conf/default.php odt/conf/default.php
--- odt.orig/conf/default.php   2008-05-07 16:20:34.000000000 +0000
+++ odt/conf/default.php        2008-11-19 16:12:34.657733978 +0000
@@ -5,3 +5,7 @@
 
 // Directory of the templates in the media manager
 $conf['tpl_dir'] = 'odt';
+
+// Leave emptyin order to not use any template
+$conf['tpl_template'] = '';
+
diff -uarN odt.orig/conf/metadata.php odt/conf/metadata.php
--- odt.orig/conf/metadata.php  2008-05-07 16:20:34.000000000 +0000
+++ odt/conf/metadata.php       2008-11-19 16:06:09.217839938 +0000
@@ -6,3 +6,4 @@
  */
 
 $meta['tpl_dir']   = array('string');
+$meta['tpl_template']   = array('string');
diff -uarN odt.orig/renderer.php odt/renderer.php
--- odt.orig/renderer.php       2008-05-07 16:20:34.000000000 +0000
+++ odt/renderer.php    2008-11-19 16:12:15.285718568 +0000
@@ -247,7 +247,11 @@
      * Closes the document
      */
     function document_end(){
-        if ($this->template) { // template chosen
+        if (empty($this->template)) { // if no template chosen in current page, get default template from config
+            $this->template=$this->getConf("tpl_template");
+        }
+
+        if (!empty($this->template)) { // template chosen
             if (file_exists(DOKU_INC.'data/media/'.$this->getConf("tpl_dir")."/".$this->template)) { //template found
                 $this->document_end_template();
             } else { // template chosen but not found : warn the user and use the default template

and then you can define a template in the wiki's configuration manager.

Tuning the look and feel

Adding an editor toolbar button

The editor toolbar is the array of buttons that is displayed after you open a Wiki page in edit mode (“edit this page”). It can help you inserting markup tags like italic, bold, hyperlinks, images etc… comfortably.
I missed a toolbar button for quickly inserting <code></code> tags. This is what is needed to add such a button to the toolbar: