Difference between revisions of "Helpsites parameter type"
From Joomla! Documentation
(Fix red link) |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Image:Params.helpsites.jpg|right]] | [[Image:Params.helpsites.jpg|right]] | ||
| − | The '''helpsites''' parameter type provides a drop down list of the help sites in your Joomla installation. | + | |
| + | {{Ambox|type=notice|text=[[Parameter|Parameters]] have been superseded by [[Form field|form fields]] in Joomla! 1.6. You may want to use the corresponding [[Helpsite form field type]].}} | ||
| + | |||
| + | The '''helpsites''' parameter type provides a drop down list of the help sites in your Joomla installation. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected. With the exception of the “Local” entry, which is always added, the list of help sites is generated from the file: | ||
<tt>[path-to-Joomla]/administrator/help/helpsites-15.xml</tt> | <tt>[path-to-Joomla]/administrator/help/helpsites-15.xml</tt> | ||
| Line 16: | Line 19: | ||
<noinclude> | <noinclude> | ||
=== See also === | === See also === | ||
| − | * [[Standard parameter types| | + | * [[J1.5:Standard parameter types|List of standard parameter types]] |
| − | + | </noinclude> | |
| − | [[Category: | + | [[Category:Archived version Joomla! 1.5|{{PAGENAME}}]] |
| − | |||
| − | |||
Latest revision as of 03:28, 11 June 2013
The "J1.5" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
| Parameters have been superseded by form fields in Joomla! 1.6. You may want to use the corresponding Helpsite form field type. |
The helpsites parameter type provides a drop down list of the help sites in your Joomla installation. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected. With the exception of the “Local” entry, which is always added, the list of help sites is generated from the file:
[path-to-Joomla]/administrator/help/helpsites-15.xml
The 'local' string is translatable. The 'local' URL returned is an empty string.
- type (mandatory) must be helpsites.
- name (mandatory) is the unique name of the parameter.
- label (mandatory) (translatable) is the descriptive title of the field.
- default (optional) is the default help site URL (not the visible help site name).
- description (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
Example XML parameter definition:
<param name="myhelpsite" type="helpsites" default="" label="Select a help site" description="" />