Help system/Helpsites XML format

From Joomla! Documentation

< Help system
Revision as of 17:48, 2 November 2022 by Cmb (talk | contribs) (Several markup changes.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The file location is /administrator/help/.

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

A typical example of a helpsites XML file is:

<?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:

  • 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 dropdown 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.