Actions

Difference between revisions of "Help system/Administrator help area"

From Joomla! Documentation

< Help system
(Created page with "In the Joomla Administrator back-end, under the menu item Help -> Joomla help you will see a general help area which lists all the available help screens on the left, with the co...")
 
m (adding category)
 
Line 24: Line 24:
 
</pre>
 
</pre>
 
being retrieved.
 
being retrieved.
 +
 +
<noinclude>[[Category:Joomla! Help System]]</noinclude>

Latest revision as of 11:23, 26 October 2012

In the Joomla Administrator back-end, under the menu item Help -> Joomla help you will see a general help area which lists all the available help screens on the left, with the content of the currently selected screen on the right. This list all the installed local help screens, except those installed within extension directories. It is important to note that the content list is always generated by scanning the contents of the local help directory regardless of whether local or remote help is being used.

Since the name of each file in the /administrator/help/ln-LN directory must be a valid key reference, Joomla uses this fact to automatically construct a language tag "JHELP_CONTENT_ARTICLE_MANAGER" by removing the extension, upper-casing and adding a "JHELP_" prefix.

The language tag is then looked up in the currently loaded language files and in this case en-GB.ini contains the entry

JHELP_CONTENT_ARTICLE_MANAGER="Content_Article_Manager"

which gives the "key reference" as "Content_Article_Manager". This is then used to construct the URL which is used to retrieve the help screen. For example, if the help URL is

http://help.joomla.org/proxy/index.php?option=com_help&keyref=Help{major}{minor}:{keyref}

then this will result in the URL

http://help.joomla.org/proxy/index.php?option=com_help&keyref=Help17:Content_Article_Manager

in Joomla 1.6.x onwards. If the help URL is not specified then the default help URL is given by

/help/{language}/{keyref}

resulting in the file

http://www.domain.com/administrator/help/en-GB/Content_Article_Manager.html

being retrieved.