Mvangeest: Made miscellaneous improvements

2011-05-24T21:41:12Z

Made miscellaneous improvements

Mvangeest: Created page for form field type

2011-05-21T13:18:05Z

Created page for form field type

New page

[[Image:Params.spacer.jpg|right]]

{{Ambox|type=notice|text=In Joomla! 1.5, [[Form field|form fields]] were [[Parameter|parameters]]. For that version, you may want to use the corresponding [[Spacer parameter type]].}}

The '''spacer''' form field type provides a visual separator between parameter field elements. It is purely a visual aid and no field value is stored.

* '''type''' (mandatory) must be ''spacer''.
* '''name''' (mandatory?) is the unique name of the field.
* '''label''' (optional) (translatable) is the text to use as a spacer.
* '''hr''' (optional) is whether to display a horizontal rule ('true' or 'false').
* '''class''' (optional) is a CSS class name for the HTML form field.

Example XML field definition:
<source lang="xml"><field type="spacer" name="myspacer" hr="true" /></source>

You can replace the basic horizontal line with a title which can be used to group parameters. For example,
<source lang="xml"><field type="spacer" name="myspacer" label="Advanced parameters" /></source>

You can also place translatable text into the label attribute:
<source lang="xml"><field type="spacer" name="myspacer" class="text"
label="PLG_TINY_FIELD_NAME_EXTENDED_LABEL"
/></source>

Note that you can also include HTML markup but it must be encoded. For example, to put the text into bold you can use:
<source lang="xml"><field type="spacer" name="myspacer" label="<b>Advanced parameters</b>" /></source>
<noinclude>
=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

@@ Line 8: / Line 8: @@
 * '''name''' (mandatory?) is the unique name of the field.
 * '''label''' (optional) (translatable) is the text to use as a spacer.
-* '''hr''' (optional) is whether to display a horizontal rule ('true' or 'false').
+* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
 * '''class''' (optional) is a CSS class name for the HTML form field.
@@ Line 24: / Line 25: @@
 Note that you can also include HTML markup but it must be encoded.  For example, to put the text into bold you can use:
 <source lang="xml"><field type="spacer" name="myspacer" label="&lt;b&gt;Advanced parameters&lt;/b&gt;" /></source>
 <noinclude>
 === See also ===
 * [[Standard form field types|List of standard form field types]]
 [[Category:Standard form field types]]</noinclude>

Spacer form field type - Revision history

Mvangeest: Made miscellaneous improvements

Mvangeest: Created page for form field type