The Joomla! core components use special help files, which can be displayed in the backend using the menu bar button Help. In this example, we add a button, which, if used, will display the contents of the screen.system.info.html
help file in a pop-up window. The additional information for the button is as follows:
JToolBarHelper::help('screen.system.info');
Core help files are located in the administrator/help
directory. To support multilingual requirements, the help
directory contains one folder for each installed language. Located in these folders are the HTML help files.
We can use a similar implementation for our components. We must create a help
folder in the administration root of our component and add a subfolder for every help language that we support.
Imagine we want to create a generic help file for our component com_boxoffice
. In the component's administrative root, we need to create a folder called help
, and in there, we need to create a folder called en-GB
. Now if we...