User tests: Successful: Unsuccessful:
Pull Request resolves #46083 .
Allow component Options forms to define a custom Help URL using the url attribute of the element in the component config.xml.
The configured URL is passed to the existing Joomla Help API as the URL override, allowing third-party extensions to link directly to their own documentation instead of using the Joomla Help site.
Existing Help behaviour, including the existing helpURL component parameter and configuration, is unchanged.
https://help.joomla.org/proxy?keyref=Help62:&lang=en <help key="Brian_Component:_Control_Panel"/> - it will fail https://help.joomla.org/proxy?keyref=Help62:Brian_Component:_Control_Panel&lang=enModify the extension's config.xml so that the <help> element contains a key AND a URL, for example:
<help
key="Brian_Component:_Control_Panel"
url="https://example.com/documentation/control-panel.html"
/>
The element in a component's config.xml can specify a Help key, but the url attribute is not passed to the Help API by the component Options view.
As a result, a third-party extension cannot use the element to specify its own documentation URL on the component options page. The Help button uses the configured Joomla Help URL instead, such as:
https://help.joomla.org/proxy?keyref=Help62:News_Feed:_Options&lang=en
The url attribute of the <help> element is passed to the Joomla Help API as the URL override.
Third-party extensions can therefore specify their own documentation URL, for example:
<help
key="Brian_Component:_Control_Panel"
url="https://example.com/documentation/control-panel.html"
/>
Clicking Help on the component Options page opens the configured documentation URL.
Existing Help configurations that do not specify a url attribute continue to use the existing Joomla Help behaviour.
I'm sure this will need to be documented but I dont know where
Please select:
Documentation link for guide.joomla.org:
No documentation changes for guide.joomla.org needed
Pull Request link for manual.joomla.org:
No documentation changes for manual.joomla.org needed
| Status | New | ⇒ | Pending |
| Category | ⇒ | Administration com_config |
| Title |
|
||||||