Adding a help file

When you distribute your module, you may want to include a help file that will help the user understand how to use your module. You may have noticed a Help button in your toolbar when you edit your module. By default, this is a generic help file for modules, however you can customize this button to make it link to a help file that is specific to your module.

Edit your mod_latestextensions.xml file and add the following line of code after the language tags just below the files tags. Make sure you end with />.

<help url="HELP_EXTENSIONS_MODULE_LATESTEXTENSIONS_URL"/>

If you have already distributed copies of your module, you should also adjust the version number.

<version>1.4.0</version>

Now you need to define the exact URL that this button will go to when clicked on. You can do this through your language file. Open up /administrator/language/en-GB/en-GB.mod_latestextensions.ini and add the following line of code:

HELP_EXTENSIONS_MODULE_LATESTEXTENSIONS_URL...