DokuWiki Server

This guide is for installation instructions of a DokuWiki private site, or a DokuWiki help server for a Joomla 3.9 website installation and help pages served by DokuWiki. This is specific for my personal needs, but might help you in setting up a highly customized dokuwiki server instance.

Installation

Go to Download DokuWiki and configure your download to include:
- Version: stable
- Languages: en, de, fr, ko, th
- Popular Plugins: CAPTCHA, Upgrade, Wrap, Translation.
- For a general purpose server, add Popular Plugins: Video Share, Gallery.
Unzip the download to your web server directory, then run /path/to/wiki/install.php
Install bethico template for DokuWiki
Install the Icons Plugin for FontAwesome icons
Install the condition Plugin
Install the Include Plugin
Install the date Plugin
Install the TocTweak Plugin

General Purpose Server

Install sqlite Plugin (required for Calendar Plugin)
Install davcal Plugin (Calendar Plugin with CalDAV sharing support)
Install Comment Plugin
Install Discussion Plugin
Install Google Maps Plugin
Install whoisonline Plugin
hover css and icon links to websites

Google Maps Plugin → grep -r “<html” and remove all <html> tags, disable html
color Plugin → grep -r “<color” and replace with wrap plugin

Settings

Add “admin” group for every administrator of the help server in User Manager.
Create the language namespaces (e.g. en, fr, de, ko, th) and set permissions to Read only for @ALL in Access Control List Management
Set “Use first heading for pagenames” to Always under Display in DokuWiki's Configuration Settings.
Set “Top level for table of contents=2”, “Minimum amount of headlines that determines whether the TOC is built=1”, “Maximum level for table of contents=4”, and “Maximum section edit level=4” under Display in DokuWiki's Configuration Settings.
Uncheck icon libraries other than FontAwesome from Icons plugin configuration in DokuWiki's Configuration Settings.
Add “_blank” to “Target window for external links” and “Target window for media links” under Links in DokuWiki's Configuration Settings.

Customization

There are a few core hacks required to make my template work properly, both for a regular wiki as well as for a help server. Additionally, there is a bug fix required to display table of contents if you utilize the plugin:condition and plugin:toctweak.
Note: you need to verify below modifications after every DokuWiki upgrade.

Concept

The dispatcher calls files doku.php and help.php in the template directory instead of main.php (function bethico_dispatch)
Language detection and fallback added to doku.php in the root directory which then dispatches doku.php in the template directory
Language detection and fallback added to help.php (copy of doku.php) in the root directory which then dispatches help.php in the template directory

Core hacks

Install my Bethico Template into /lib/tpl/. Current version is v55.1 / 2024-06-09 suitable for DokuWiki “Kaos”.
Add the following lines in doku.php in DokuWiki's root after line $ID = getID(); at the beginning…
```
require_once(template('dispatcher.php'));
$langcode = bethico_language();
bethico_init_toc();
```

…and replace at the end line act_dispatch(); with

init_lang($langcode);
bethico_dispatch(basename(__FILE__));

Add a line to file /lib/scripts/page.js in function makeToggle to allow the template to set the table of contents to open or closed

$handle[0].setState = function(state){
            var hidden;
        --> if(!state && JSINFO.toc) state = JSINFO.toc.initial_state;
            if(!state) state = 1;

Fix toc handling in core

Modify /inc/template.php in function tpl_toc add before line Event::createAndTrigger('TPL_TOC_RENDER', $toc, null, false);:
```
if (@include_once(template('dispatcher.php'))) bethico_update_toc($toc, $TOC);
```
This is a non-destructive change which fixes an issue in the table of contents if plugin:condition is installed.

Fix toc handling in plugin:toctweak

Make elements of items array unique at the end of function _toc in file lib/plugins/toctweak/helper.php
```
$items = array_unique($items, SORT_REGULAR);
```

Install

Copies of the modified files for “Kaos” are in folder /lib/tpl/bethico/core/v551/, copy them with
```
cp -R /lib/tpl/bethico/core/v551/* /
```
then check file permissions
After a DokuWiki upgrade check and change if necessary
1. Check /inc/actions.php and change /lib/tpl/bethico/dispatcher.php
2. Check /inc/template.php and change
3. Check /doku.php and change then copy to /help.php
Optional: replace favicon and logo in '/lib/tpl/bethico/images/'.
Add the following line in /lib/scripts/page.js (v55.1-line 170) right before if(!state) state = 1;
```
if(!state && JSINFO.toc) state = JSINFO.toc.initial_state;
```

Joomla Access

Set the Help URL in the component configuration of com_bethico to
```
'https://your.wiki.server/help.php?id={langcode}:{keyref}'
```
Add a help button to view 'view' to open the help page
```
JToolbarHelper::help('view', true);
```
With English as the active language it will invoke
```
https://your.wiki.server/help.php?id=en:view
```

Help system

Joomla's default help url:

url example: https://help.joomla.org/proxy?keyref=Help{major}{minor}:{keyref}&lang={langcode}

Substitute tags:

Tag	Name	Example
{app}	Application name	'Administrator'
{component}	Component name	'com_content'
{keyref}	Help screen key reference	JToolbarHelper::help('{keyref}', true)
{language}	Full language code	'en-GB'
{langcode}	Short language code	'en'
{langregion}	Region code	'GB'
{major}	Joomla major version number
{minor}	Joomla minor version number
{maintenance}	Joomla maintenance version number

Backup with zip

use the following command to backup an entire wiki with zip

$ sudo zip -r my_wiki my_wiki -x my_wiki/data/cache/**\* my_wiki my_wiki -x my_wiki/data/log/error/**\* my_wiki my_wiki -x my_wiki/data/log/deprecated/**\*

Upgrade to Version 2020-07-29 "Hogfather"

Plugin whoisonline

Replace function handle($match, $state, $pos, &$handler) definition with function handle($match, $state, $pos, Doku_Handler $handler) in file lib/plugins/whoisonline/syntax.php
Replace function render($mode, &$renderer, $data) definition with function render($mode, Doku_Renderer $renderer, $data) in file lib/plugins/whoisonline/syntax.php
Set $conf['defer_js']=0; in file conf/dokuwiki.php

Todo: change menu system

New menu system see /inc/Menu
Menus
Menus! blog
Material Design Icons

PHP 8.1 issues

Plugin condition

Replace curly brackets string indices with square brackets in line 84 and 149 of plugins/condition/syntax.php if you run your webserver with PHP 8.

Plugin html5video

Put brackets enclosing the expressions on line 190 and 191 of plugins/html5video/syntax/video.php if you run your webserver with PHP 8.

davcal

Check when a date entry was made

Copy /data/meta/davcal.sqlite3 to D:\

Open sqlite3.exe command line tool from D:\PortableCustom\sqlite3, then enter the following commands to see entries made after 2023-01-01:

.open /davcal.sqlite3
SELECT calendardata FROM calendarobjects WHERE datetime(lastoccurence, 'unixepoch') > '2023-01-01 00:00:00';
.quit

Table of Contents