This is an old revision of the document!
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.
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. Note: you need to verify below modifications after every DokuWiki upgrade.
/lib/tpl/
. Current version is 2022-10-09 suitable for DokuWiki “Igor”.doku.php
in DokuWiki's root after line $ID = getID();
require_once(template('dispatcher.php')); $langcode = bethico_language();
and replace line act_dispatch();
with
init_lang($langcode); bethico_dispatch(basename(__FILE__));
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.<code> bco: 20181114. Get requested language and set language fallback
require_once(template('dispatcher.php'));
$langcode = help_language();</code>
* Modify 'help.php' and replace line #119+4 and #120+4<code>do the work (picks up what to do from global env)
act_dispatch();</code>with<code> bco: 20181114. Set language and load act_dispatch override
init_lang($langcode);
help_dispatch();</code>
* Modify '/inc/template.php' and add after line #130 ($toc = $TOC) in function tpl_toc<code> bco: 20181116. Fix toc issues due to use of condition Plugin
require_once(template('dispatcher.php'));
help_toc($toc);
</code>
* 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<code>'https://your.wiki.server/help.php?id={langcode}:{keyref}'</code>
* Add a help button to view 'view' to open the help page<code>JToolbarHelper::help('view', true);</code>
* With English as the active language it will invoke<code>https://your.wiki.server/help.php?id=en:view</code>
==== Help system ====
Joomla's default help url:<code>url example: https://help.joomla.org/proxy?keyref=Help{major}{minor}:{keyref}&lang={langcode}</code>
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 =====
* Namespaces (and how to rename them
* DokuWiki Help Server with 2 templates
* Safely include PHP code
* Andreas Gohr
===== 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.