Actions

J1.5

Difference between revisions of "Helpsites parameter type"

From Joomla! Documentation

(New page: right 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 selec...)
 
m (Added more categorisations because this page is generic.)
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.  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:
+
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 17: Line 17:
 
=== See also ===
 
=== See also ===
 
* [[Standard parameter types|Full list of standard parameter types]]
 
* [[Standard parameter types|Full list of standard parameter types]]
</noinclude>
+
[[Category:Components]][[Category:Modules]][[Category:Plugins]][[Category:Templates]][[Category:Development]]</noinclude>
[[Category:Templates]]
+

Revision as of 16:33, 21 August 2008

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.
Params.helpsites.jpg

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="" />

See also