This is an old revision of the document!

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 this work as a help server, but they are simple and thus easy to maintain, even after an update of DokuWiki or any of the extensions.

Copy 'doku.php' to 'help.php' in the DokuWiki root folder
Create the language fallback to English for non-existent translation pages by adding 3 lines to /help.php at line #41, just below '$ID = getID();'. Remember to update after you add or remove languages.
```
// bco: 20181114. Get requested language and set language fallback
require_once(template('dispatcher.php'));
$langcode = help_language();
```

Modify 'help.php' and replace line #119+4 and #120+4

//do the work (picks up what to do from global env)
act_dispatch();

with

// bco: 20181114. Set language and load act_dispatch override
init_lang($langcode);
help_dispatch();

Modify '/inc/template.php' and add after line #130 ($toc = $TOC) in function tpl_toc

// bco: 20181116. Fix toc issues due to use of condition Plugin
require_once(template('dispatcher.php'));
help_toc($toc);

After a DokuWiki upgrade make sure that
- If '/inc/actions.php' has been upgraded, reflect the changes in '/lib/tpl/bethico/dispatcher.php'
- If '/inc/template.php' has been upgraded, reflect the changes in function tpl_toc
- If '/doku.php' has been upgraded, reflect the changes in '/help.php'
If you use a template other than 'bethico', you must copy '/lib/tpl/bethico/css/userstyle.css' to '/conf'
Optional: replace favicon and logo in '/lib/tpl/bethico/images/'.

The following files must be checked against the previous version after upgrading

File	DokuWiki File	Todo
help.php	doku.php	line 12: $updateVersion and verify content (compare doku.php to previous version)
inc/template.php	inc/template.php	line 131-133: call to help_toc in function tpl_toc
lib/tpl/bethico/dispatcher.php	inc/actions.php	verify function help_dispatch

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

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

Links

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.

Table of Contents