Actions

Difference between revisions of "Help system/Help servers"

From Joomla! Documentation

< Help system
(New page: One of the aims in redeveloping the help system in Joomla 1.6 was to allow greater flexibility in the kinds of help servers that can be constructed. Prior to Joomla 1.6 it was necessary f...)
 
m (Serving help screens from a MediaWiki installation)
 
Line 24: Line 24:
  
 
==Serving help screens from a MediaWiki installation==
 
==Serving help screens from a MediaWiki installation==
Starting with Joomla 1.6 the official English help screens are being served from the wiki at http://docs,joomla.org making it easier and quicker for the Joomla community to collaboratively keep them accurate and up-to-date.  Pages in the wiki are retrieved via URLs which include the page title so that using key references to refer directly to pages in the wiki is straightforward.
+
Starting with Joomla 1.6 the official English help screens are being served from the wiki at http://docs.joomla.org making it easier and quicker for the Joomla community to collaboratively keep them accurate and up-to-date.  Pages in the wiki are retrieved via URLs which include the page title so that using key references to refer directly to pages in the wiki is straightforward.
  
 
However, the issue already described above for Joomla installations, where the output from the wiki includes navigation and other output that you would generally not want to include in a help screen, is also evident with the wiki.  The solution recommended for Joomla installations where a separate MediaWiki installation with a stripped-down template ("theme" in MediaWiki parlance) is used to serve help screens, is much less than ideal because generally the idea of using a wiki in the first place is to encourage collaboration and a largely un-navigable user interface is hardly likely to achieve that.
 
However, the issue already described above for Joomla installations, where the output from the wiki includes navigation and other output that you would generally not want to include in a help screen, is also evident with the wiki.  The solution recommended for Joomla installations where a separate MediaWiki installation with a stripped-down template ("theme" in MediaWiki parlance) is used to serve help screens, is much less than ideal because generally the idea of using a wiki in the first place is to encourage collaboration and a largely un-navigable user interface is hardly likely to achieve that.
Line 31: Line 31:
  
 
The information flow is as follows.  The help screen is initially requested by a user logged in to an instance of the Joomla Administrator.  The request is passed to the com_help component running on the proxy at http://help.joomla.org/proxy/.  The component parses the request to determine the key reference and uses that to make a request for page data from the wiki at http://docs.joomla.org using the MediaWiki Web API.  The wiki returns the data requested as an XML file and com_help then extracts the data it requires, performing some transformations such as replacing relative links and references to absolute ones, removing extraneous information such as tables of content and categorisations.  It then constructs a web page, passing it through the default template which adds HTML headers and footers, copyright and license data, then outputs it to the user's web browser.
 
The information flow is as follows.  The help screen is initially requested by a user logged in to an instance of the Joomla Administrator.  The request is passed to the com_help component running on the proxy at http://help.joomla.org/proxy/.  The component parses the request to determine the key reference and uses that to make a request for page data from the wiki at http://docs.joomla.org using the MediaWiki Web API.  The wiki returns the data requested as an XML file and com_help then extracts the data it requires, performing some transformations such as replacing relative links and references to absolute ones, removing extraneous information such as tables of content and categorisations.  It then constructs a web page, passing it through the default template which adds HTML headers and footers, copyright and license data, then outputs it to the user's web browser.
 +
 +
<noinclude>[[Category:Joomla! Help System]]</noinclude>

Latest revision as of 10:33, 2 December 2013