Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
joomla:j39help [2018/12/04 16:47] – [Links] Bernard Condraujoomla:j39help [2026/09/19 15:43] (current) – removed - external edit (Unknown date) 127.0.0.1
Line 1: Line 1:
-====== DokuWiki Help Server ====== 
  
-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. 
- 
-===== Installation ===== 
-  - Go to [[https://download.dokuwiki.org/|Download DokuWiki]] and configure your download to include: 
-    * Version: stable 
-    * Languages: en, de, fr, ko, th 
-    * Popular Plugins: CAPTCHA, Upgrade, Wrap, Translation. 
-  - Unzip the download to your web server directory, then run /path/to/wiki/install.php 
-  - Install bethico template for DokuWiki 
-  - Install the [[https://www.dokuwiki.org/plugin:icons|Icons Plugin]] for FontAwesome icons 
-  - Install the [[https://www.dokuwiki.org/plugin:condition|condition Plugin]] 
-  - Install the [[https://www.dokuwiki.org/plugin:include|Include Plugin]] 
-  - Install the [[https://www.dokuwiki.org/plugin:date|date 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.<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> 
-  * Change 3rd parameter of 'dw_page.makeToggle' call in file '/lib/scripts/page.js' from //null// or //1// to **-1** to initialize 'closed' instead of 'opened'. 
-  * 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/'. 
-===== 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 || 
- 
-===== Links ===== 
-  * [[joomla:j39help2|DokuWiki Help Server with 2 templates]] 
-  * [[https://www.dokuwiki.org/tips:safely_include_php_code|Safely include PHP code]]