Difference between revisions of "Editor form field type"

From Joomla! Documentation

m
Line 8: Line 8:
 
* '''cols''' (optional) defines the width of the editor (in columns).
 
* '''cols''' (optional) defines the width of the editor (in columns).
 
* '''rows''' (optional) defines the height of the editor (in rows).
 
* '''rows''' (optional) defines the height of the editor (in rows).
* '''buttons''' (optional) can be an array of plugin buttons to be excluded or set to false. The default editors-xtd are: article, image, pagebreake and readmore.
+
* '''buttons''' (optional) can be an array of plugin buttons to be excluded or set to false. The default editors-xtd are: article, image, pagebreak and readmore.
 
* '''hide''' (optional) array of plugin buttons to be hidden
 
* '''hide''' (optional) array of plugin buttons to be hidden
 
* '''editor''' specifies the editor to be used and can include two options (editor="desired|alternative")
 
* '''editor''' specifies the editor to be used and can include two options (editor="desired|alternative")

Revision as of 02:03, 24 October 2012

The Editor field type provides a WYSIWYG editor.

  • type (mandatory) must be editor.
  • name (mandatory) is the unique name of the parameter.
  • label (mandatory) (translatable) is the descriptive title of the field.
  • width (optional) defines the width (in pixels) of the wysiwyg editor and defaults to 100%.
  • height (optional) defines the height (in pixels) of the wysiwyg editor and defaults to 250px.
  • cols (optional) defines the width of the editor (in columns).
  • rows (optional) defines the height of the editor (in rows).
  • buttons (optional) can be an array of plugin buttons to be excluded or set to false. The default editors-xtd are: article, image, pagebreak and readmore.
  • hide (optional) array of plugin buttons to be hidden
  • editor specifies the editor to be used and can include two options (editor="desired|alternative")
  • filter (optional) allow the system to save certain html tags or raw data.


Example XML Definition

<field name="test1" label ="Test Field" type="editor" width="300" filter="safehtml" />


See also[edit]