No Code Attached Yet
avatar ceford
ceford
12 Sep 2025

A custom component can provide its own Help pages by passing a parameter to the call to display a Help button in HtmlView.php, like this:

            ToolbarHelper::help('manuals', true); // OR $toolbar->help('manuals', true);

However, the Options page uses com_config and the Help button does not work when created with the new method, by defining a key in the component config.xml file, like this:

	<help key="my_component_options" />

So the Help page opens but returns a 404 - RuntimeException.

I think this can be traced to the last line of administrator/components/com_config/src/View/Component/HtmlView.php

        $toolbar->help($helpKey, (bool) $helpUrl, null, $this->currentComponent);

It needs the third parameter to be the helpURL rather than null. But it looks complicated to fix!

avatar ceford ceford - open - 12 Sep 2025
avatar ceford ceford - change - 12 Sep 2025
Labels Removed: ?
avatar joomla-cms-bot joomla-cms-bot - change - 12 Sep 2025
Labels Added: No Code Attached Yet
avatar joomla-cms-bot joomla-cms-bot - labeled - 12 Sep 2025
avatar brianteeman
brianteeman - comment - 12 Sep 2025

Not at my pc anymore to look at the code but I know the akeeba extensions use the help button successfully

avatar ceford
ceford - comment - 12 Sep 2025

Akeeba Backup provides Help pages for its own pages but not for the Options page. That displays the same problem I am referring to here. In addition, there seems no way to tell com_config not to display the Help button.

avatar brianteeman
brianteeman - comment - 12 Sep 2025

Sorry I didn't read your original post carefully enough

Add a Comment

Login with GitHub to post a comment