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.
JMenuBar::help('screen.system.info');
Component Design
[ 100 ]
Core help files are located in the administrator/help directory. To support
multilingual requirements, the help directory contains one folder for each installed
language, for example en-GB. 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 the component 'My Extension'. 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 create a file called help.
html and save it into the help\en-GB folder, we can use the administration menubar
help button to view it, as this example demonstrates:
JMenuBar::help('help', true);
By adding the second parameter, we are telling Joomla! to look for help files in the
components help folder.
Pages:
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148