Difference between revisions of "Editors parameter type"

From Joomla! Documentation

m (Added more categorisations because this page is generic.)
Line 15: Line 15:
=== See also ===
=== See also ===
* [[Standard parameter types|Full list of standard parameter types]]
* [[Standard parameter types|Full list of standard parameter types]]
[[Category:Components]][[Category:Modules]][[Category:Plugins]][[Category:Templates]][[Category:Development]]</noinclude>[[Category:References]][[Category:Module Development]]
[[Category:Plugin Development]]
[[Category:Component Development]]

Revision as of 07:25, 20 September 2010

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.

The editors parameter type provides a drop down list of the available and enabled WYSIWYG editors. 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.

The first option on the list is always '- Select Editor -' (which is a translatable string) and is given the value 0.

  • type (mandatory) must be editors.
  • name (mandatory) is the unique name of the parameter.
  • label (mandatory) (translatable) is the descriptive title of the field.
  • default (optional) is the default editor name. This is the name listed in the File column in the Plugin Manager screen.
  • 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="myeditor" type="editors" default="none" label="Select an editor" />

See also