Joomla 4.x Tutorial - Extension Development - Help Sites

Modify this post

Self-explanatory software is ideal. But which programme is? For this reason, help is always a useful addition. Depending on the system, help pages cannot be found immediately or are even hidden. Joomla offers a uniform procedure for this.

Joomla Help link in the list view

For impatient people: Look at the changed programme code in the Diff and copy these changes into your development version.

Step by step

The first thing you need to do is to create the help pages for your extension and save them online. Perhaps you would like to base the structure of your individual help pages on Joomla's own.

You can find Joomla's own help pages on the Internet at the address An example page would be Here, stands for the base address and ?keyref=Help40:Articles&lang=en addresses the specific subpage.

New files

In this chapter, only files are changed.

Modified files

Two lines per view are sufficient to display a button at the top right that contains a question mark as an icon and has an Internet address specified in the code as the link target. I have chosen as an example. The principle is clear. You have the possibility to create a separate help file for each View and to link it in the view of the component - exactly where questions usually arise.

administrator/components/ com_foos/ src/View/Foo/HtmlView.php

		ToolbarHelper::help('', false, '');

administrator/components/ com_foos/ src/View/Foos/HtmlView.php

administrator/components/com_foos/ src/View/Foos/HtmlView.php

		ToolbarHelper::help('', false, '');

Test your Joomla component

  1. install your component in Joomla version 4 to test it: Copy the files in the administrator folder into the administrator folder of your Joomla 4 installation. A new installation is not necessary. Continue using the files from the previous part.
  2. Open the view of your component in the administration area. Click on the help link and make sure that you are redirected to the help page you entered.

Joomla Help Link in the item view

Modify this post