Actions

Difference between revisions of "Help system/Helpsites XML format"

From Joomla! Documentation

< Help system
m (adding category)
(Remove 1.6 for 2.5)
 
Line 23: Line 23:
 
** attribute: tag: language code
 
** attribute: tag: language code
 
** attribute: url: {{JVer|1.5}} Base URL of the help server.
 
** attribute: url: {{JVer|1.5}} Base URL of the help server.
** attribute: url: {{JVer|1.6}} URL containing [[Help system/Substitution codes|substitution codes]].
+
** attribute: url: {{JVer|2.5}} URL containing [[Help system/Substitution codes|substitution codes]].
  
 
<noinclude>[[Category:Joomla! Help System]]</noinclude>
 
<noinclude>[[Category:Joomla! Help System]]</noinclude>

Latest revision as of 12:14, 29 April 2013

File location is /administrator/help/

File name is helpsites-MM.xml where MM is the major and minor Joomla version numbers concatenated. For example, for Joomla 1.6 the filename is helpsites-16.xml.

A typical example of a helpsites XML file is as follows:

<?xml version="1.0" encoding="iso-8859-1"?>
<joshelp>
    <sites>
        <site
            tag="en-GB"
            url="http://help.joomla.org/proxy/index.php?option=com_help&amp;keyref=Help{major}{minor}:{keyref}">
            English (GB) - Joomla help wiki
        </site>       
    </sites>
</joshelp>

The XML elements are defined as follows:

  • joshelp: XML root element.
  • sites: container for one or more site elements.
  • site: describes the location of help files for a single language. The element value is the name of the help server for use in drop-down selection lists.
    • attribute: tag: language code
    • attribute: url: Joomla 1.5 Base URL of the help server.
    • attribute: url: Joomla 2.5 URL containing substitution codes.