This is an old revision of the document!
The help server is built with DokuWiki. At the moment, all admin help views are served from this server. At a later date, I plan to migrate all site help views to the help server as well.
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.
// bco: 20181114. Get requested language and set language fallback
require_once(template('dispatcher.php'));
$langcode = help_language();
//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();
// bco: 20181116. Fix toc issues due to use of condition Plugin
require_once(template('dispatcher.php'));
help_toc($toc);
'https://your.wiki.server/help.php?id={langcode}:{keyref}'
JToolbarHelper::help('view', true);
https://your.wiki.server/help.php?id=en:view
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 (eg. 'GB') {major} Joomla major version number {minor} Joomla minor version number {maintenance} Joomla maintenance version number </code>