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.

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.

-

The DokuWiki comes with a default template which is rather bland. Their 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 [[wp>MediaWiki]] template (as seen on [[http://en.wikipedia.org|WikiPedia]]) which I find very nice looking. This template is avtively developed and many nice features have been added recently, which make it even better to customize.

+

> 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 [[http://alien.slackbook.org/blog/|my new blog]]. The [[http://alien.slackbook.org/dokuwiki/doku.php?id=slackware:wikinotes&do=revisions|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 [[wp>MediaWiki]] template (as seen on [[http://en.wikipedia.org|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 ====

==== Installing the dokuwiki tarball ====

-

* Download the latest and greatest DokuWiki archive at the [[http://www.splitbrain.org/projects/dokuwiki|download page]].

+

* Download the latest and greatest DokuWiki archive at the [[http://www.splitbrain.org/projects/dokuwiki|download page]]. Dokuwiki comes with a clear [[http://wiki.splitbrain.org/wiki:install|installation]] and [[http://wiki.splitbrain.org/wiki:config|configuration]] pages. This paragraph will recap some of that information.

* Unpack the tarball into your Apache DocumentRoot, change to the DocumentRoot directory (by default that is ''/var/www/htdocs'') and create a symbolic link called //dokuwiki// that points to the fresh DokuWiki directory tree: <code>ln -s dokuwiki-yyyy-mm-dd dokuwiki</code>. If you already have a DokuWiki running, better wait with changing the symlink until you're sure you've configured and upgraded everything right.

* Unpack the tarball into your Apache DocumentRoot, change to the DocumentRoot directory (by default that is ''/var/www/htdocs'') and create a symbolic link called //dokuwiki// that points to the fresh DokuWiki directory tree: <code>ln -s dokuwiki-yyyy-mm-dd dokuwiki</code>. If you already have a DokuWiki running, better wait with changing the symlink until you're sure you've configured and upgraded everything right.

* Change into the DokuWiki directory and have a look around.\\ The ''conf'' directory is where we will be customizing the new Wiki soon. The ''data'' directory is where all the Wiki content (pages, indexes, archives, media, cache) will be stored. If anything, your Apache webserver //must// be able to write there. The ''conf'' and ''data'' directories are the most important to back up regularly!

* Change into the DokuWiki directory and have a look around.\\ The ''conf'' directory is where we will be customizing the new Wiki soon. The ''data'' directory is where all the Wiki content (pages, indexes, archives, media, cache) will be stored. If anything, your Apache webserver //must// be able to write there. The ''conf'' and ''data'' directories are the most important to back up regularly!

+

+

* Create an empty logfile <code>

+

touch ./data/changes.log

+

</code>

* Configuration.\\ You can customize the Wiki by overriding any of the values that are found in ./conf/dokuwiki.php. Just run <code>

* Configuration.\\ You can customize the Wiki by overriding any of the values that are found in ./conf/dokuwiki.php. Just run <code>

cd conf

cd conf

cp -a local.php.dist local.php

cp -a local.php.dist local.php

-

</code> and add any line from ''dokuwiki.conf'' that you want to give a custom value.\\ When you want to add user accounts and access control lists, create the two needed configuration files and edit them (or use the Admin interface of your wiki to set this up): <code>

+

</code> and add any line from ''dokuwiki.php'' that you want to give a custom value.\\ When you want to add user accounts and access control lists, create the two needed configuration files and edit them (or use the Admin interface of your wiki to set this up): <code>

cd conf

cd conf

cp -a users.auth.php.dist users.auth.php

cp -a users.auth.php.dist users.auth.php

Line 23:

Line 29:

-

* Finally, make sure that the webserver can read and //write// to your DokuWiki: <code>chown -R nobody:wheel .</code> In this example command, I assumed that you are running your Apache as the user "nobody" which is the default for Slackware, and that you have root access to the server.\\ In my case on the Slackware server, I have no privileged account, so I cannot change the ownership of any files. In order to make the Wiki writable by the Apache process, I had to make the ''./data'' directory writable for "others": <code>chmod -R o+w /path/to/dokuwiki/data</code> There is also a problem with Dokuwiki's configuration manager. When you change configuration through the admin interface, the file ''./conf/local.php'' is (re-)written, actually the current file is moved to ''local.php.bak'' and a //new// file is written. In this process the //umask// settings are not honoured and you end up with a file owned by the web server and read-only to yourself. A small patch is enough to fix this, in the file ''./lib/plugins/config/settings/config.class.php'' at the start of function save_settings().\\ This is my diff: <code diff>

+

* Finally, make sure that the webserver can read and //write// to your DokuWiki: <code>chown -R apache:wheel .</code> In this example command, I assumed that you are running your Apache as the user "apache" which is the default for Slackware, and that you have root access to the server.\\ In my case on the Slackware server, I have no privileged account, so I cannot change the ownership of any files. In order to make the Wiki writable by the Apache process, I had to make the ''./data'' directory writable for "others": <code>chmod -R o+w /path/to/dokuwiki/data</code> There is also a problem with Dokuwiki's configuration manager. When you change configuration through the admin interface, the file ''./conf/local.php'' is (re-)written, actually the current file is moved to ''local.php.bak'' and a //new// file is written. In this process the //umask// settings are not honoured and you end up with a file owned by the web server and read-only to yourself. A small patch is enough to fix this, in the file ''./lib/plugins/config/settings/config.class.php'' at the start of function save_settings().\\ This is my diff: <code diff>

</code> Now, with a customized umask like ''$conf['umask'] = '0111';'' the ''local.php'' file will have mode 666, so that even while it is owned by the webserver, you can still edit it.\\

+

-

<note warning> You have to take care with the default umsak and dmask settings because you'll 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!</note>

+

</code> Now, with a customized umask like ''$conf['umask'] = '0111';'' the ''local.php'' file will have mode 666, so that even while it is owned by the webserver, you can still edit it. These are the settings I use in my Wiki (you can change these using the configuration manager on the __//admin//__ page) <code>

+

$conf['dmode'] = 0777;

+

$conf['fmode'] = 0666;

+

$conf['umask'] = '0111';

+

$conf['dmask'] = '0000';

+

</code>

+

<note important> 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!</note>

+

+

* DokuWiki comes with a plugin manager that according to the documentation is disabled by default - to enable the plugin manager, add the following line to ''./conf/local.php'' <code>

+

$conf['pluginmanager'] = 1; //enable automated plugin management

+

</code> For this to work, the plugin manager (i.e. efeectively the web server process) must have write access to the ''./lib/plugins'' directory, so I also did <code>

+

chmod -R a+w ./lib/plugins</code>

==== Template and plugins ====

==== Template and plugins ====

Line 43:

Line 60:

=== Template: MonoBook ===

=== Template: MonoBook ===

-

* Get the archive file for the monobook template from [[http://tatewake.com/wiki/projects:monobook_for_dokuwiki|Tatewake's web site]]. The template should match with the release of DokuWiki you've just installed. This is only an issue when there has been a major new release of DokuWiki. Usually you would just grab the most recent monobook release.

+

* Get the archive file for the monobook template from [[http://tatewake.com/wiki/software:dokuwiki:template:monobook|Tatewake's web site]]. The template should match with the release of DokuWiki you've just installed. This is only an issue when there has been a major new release of DokuWiki. Usually you would just grab the most recent monobook release.

* Fix the permissions and ownership of the monobook directory tree, so that the webserver can at least read them.

* Fix the permissions and ownership of the monobook directory tree, so that the webserver can at least read them.

-

* //(16-mar-2006)// The monobook template misses the file ''./lib/tpl/default/style.ini'', so I copied it over to the monobook directory. This takes care of some custom definitions in the blog plugin.

+

=== Plugin: note ===

-

* //(21-mar-2006)// The new version of the template (03182006) fixes the style issues I had with the previous version. I also adapted the tabs on the top of the wiki pages (the 'article' 'show page' etc...) to be more conformant with the MediaWiki's original Monobook template. These are my fixes: <code>

+

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 [[http://wiki.splitbrain.org/plugin:note | 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).

-

--- main.css.org 2006-03-20 15:56:32.000000000 -0800

+

-

+++ main.css 2006-03-20 15:43:56.000000000 -0800

+

-

@@ -827,6 +827,7 @@

+

-

#p-cactions li.selected {

+

-

border-color: #fabd23;

+

-

padding: 0 0 .2em 0;

+

-

+ font-weight: bold;

+

-

}

+

-

#p-cactions li a {

+

-

background-color: white;

+

+

=== Plugin: keyboard ===

+

The keyboard plugin enables you to add visual clues to keypress examples. Like, Windows users often need <key>Ctrl-Alt-Del</key> !\\ 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:

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.

-

* Actually, I'm still testing this.\\ The blog plugin can be obtained [[http://wiki.splitbrain.org/plugin:blog|here]] and downloaded as a ZIP archive: <code>wget http://www.qwik.ch/media/blog.zip</code>

+

=== Plugin: referrers ===

-

* Unzip the blog plugin into ''./lib/plugins/''. Add this to the //top// of your template's ''main.php'' - in my case that is the file ''./lib/tpl/monobook/main.php'': <code>

+

The //referrers// plugin (also found on [[http://tatewake.com/wiki/software:dokuwiki:plugin:referrers|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:

-

<?php

+

-

// include discussion code

+

-

include(DOKU_PLUGIN.'blog/functions.php');

+

-

// we must move the doctype down (unfortunately) - headers need to be first

+

-

?></code> It should come right before the line ''<!DOCTYPE html PUBLIC .....>''.\\ And add this line immediately below the line that says ''<?php tpl_content()?>'': <code><?php tpl_discussion()?></code>

+

-

* Customization of the blog plugin.\\ Create a file ''./lib/plugins/blog/conf/local.php'' and copy the parameters from the file ''./lib/plugins/blog/conf/default.php'' over into this file if you want them changed. My only change was: <code>

+

^ hostname ^ ip address ^ referrer ^

-

$conf['plugin']['blog']['tag_namespace'] = 'blog:categories'; // where should tag links point to?

&lt;/code&gt; This way, the tags or &quot;categories&quot; get their own [[http://wiki.splitbrain.org/wiki:namespaces|namespace]]. \\ Note that the original //$conf['tag_namespace']// must change to //$conf['plugin']['blog']['tag_namespace']//.

* Now, the blog plugin is ready for use. How to use it, is another story entirely, and I am in the process of finding out.

+

__//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: <code>

+

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

+

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

+

</code> and this is what the file looks like (the value for ''referrer-ignore'' was set through the configuration manager) <code bash>

+

<?php

+

// This file is automatically generated

+

$re_settings['referrer-ignore'] = 'alien.slackbook.org/dokuwiki';

+

$re_settings['dontcountadmin'] = '';

+

$re_settings['dontcountusers'] = '';

+

</code> //It is required for the plugin to work as intended, to have a __non-empty__ value for ''referrer-ignore''//!

+

=== Plugin: captcha ===

-

=== Plugin: boxes ===

+

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

-

The //boxes// plugin enables the ''<box></box>'' tag which shows up in your page as a floating box, with several possible styles. The feature that attracted me to it is the "left" and "right" styles which create floating boxes that are left- or right-aligned.

* Download the [[http://www.cdsmith.plus.com/dokuwiki/plugin-box.tar.gz|plugin-box.tar.gz archive]] and unpack it into ''./lib/plugins/''. That is all!

+

-

+

-

* If your ''<box>'' tags don't show up, the wiki cache is interfering. Altering something in your Wiki configuration (like the used template) seems to force a cache flush, so that is what I did to make the boxes display right away.

+

-

+

-

=== Plugin: note ===

+

-

+

-

I downloaded the "note" plugin for DokuWiki. This plugin displays nice informational icons in the margin, like "tip" "warning" "note" and "note". The plugin source is available at [[http://wiki.splitbrain.org/plugin:note | the DokuWiki site]] but it did not do what I wanted from it, plus it requires you to copy the images into your template directory, and add the CSS to the template's stylesheet. So I hacked it, so that now the plugin is fully contained into the DokuWiki's ''./lib/plugins/note/'' directory. You can download my {{:slackware:dokuwiki-plugin-note-3alien.tar.gz|modified plugin}} and unpack it into your DokuWiki's ''./lib/plugins/'' directory.

+

-

+

-

* //(23-mar-2006)// My changes were picked up by Olivier, the author of the //note// plugin, and therefore I changed back to the "official" newly released version (which now uses nice rounded corners).

+

+

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 [[#tuning_the_look_and_feel|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: {{:odt:wiki-template.odt|wiki-template.odt}}. The patch I used is <code diff>

+

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

+

</code> and then you can define a template in the wiki's configuration manager.

</code> Note that the monobook template redefines the location of the site's logo bitmap. The default bitmap for dokuwiki is ''./data/media/wiki/dokuwiki-128.png''

</code> Note that the monobook template redefines the location of the site's logo bitmap. The default bitmap for dokuwiki is ''./data/media/wiki/dokuwiki-128.png''

-

* I added my own links to the "navigation" and "toolbox" boxes on the left. This is as easy as editing the "user-modifiable" files found in ''./lib/tpl/monobook/user/*.php''

+

* I added my own links to the "navigation" and "toolbox" boxes on the left. The "navigation" box actually is a separate wiki page, it's location is defined in the monobook section in the wiki's configuration manager. I liked the old php array better, but o well... The "toolbox" is actually hard-coded into '' lib/tpl/monobook-yyyy-mm-dd/context.php'' and still uses the php array. I added a few items to the default toolbox: <code diff>

* <del>I added a few lines to monobook's main.css file that makes the Wiki links appear in //red// when they point to a not yet existing Wiki page.</del> The 14-mar-2006 version of MonoBook has a doku.css which contains the "missing wikilink" style definition. It now works out of the box.

+

* To silence Apache in it's error_log, I also copied a favicon.ico file to the DokuWiki image library: <code>cp /path/to/documentroot/favicon.ico /path/to/dokuwiki/lib/images/</code>

-

* The blog plugin has a bland color scheme. I found a better looking {{:slackware:style.css|style.css}} in [[http://doogie.in-space.de/dokuwiki/|Doogie's blog]] and used that to replace ''./lib/plugins/blog/style.css''

-

-

* To silence Apache in it's error_log, I also copied a favicon.ico file to the DokuWiki image library: <code>cp /path/to/documentroot/favicon.ico /path/to/dokuwiki/lib/images/</code>

=== Adding an editor toolbar button ===

=== 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:

I missed a toolbar button for quickly inserting ''<code></code>'' tags. This is what is needed to add such a button to the toolbar:

Line 156:

Line 209:

</file>

</file>

* Add this text to the english language file ''inc/lang/en/lang.php'' (for other languages the corresponding texts have not yet been updated): <code>$lang['qb_syntax'] = 'Syntax Code';</code> And voilá!

* Add this text to the english language file ''inc/lang/en/lang.php'' (for other languages the corresponding texts have not yet been updated): <code>$lang['qb_syntax'] = 'Syntax Code';</code> And voilá!