J1.5:Spacer parameter type
From Joomla! Documentation
(Difference between revisions)
(New page: right The spacer parameter type provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored. * ''...) |
|||
| (8 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
[[Image:Params.spacer.jpg|right]] | [[Image:Params.spacer.jpg|right]] | ||
| − | The spacer parameter type provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored. | + | |
| + | {{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 [[Spacer form field type]].}} | ||
| + | |||
| + | The '''spacer''' parameter type provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored. | ||
* '''type''' (mandatory) must be ''spacer''. | * '''type''' (mandatory) must be ''spacer''. | ||
| + | * '''default''' (optional) (translatable) is a string which will be used instead of the ''<nowiki><hr /></nowiki>'' that is inserted by default. | ||
Example XML parameter definition: | Example XML parameter definition: | ||
<source lang="xml"><param type="spacer" /></source> | <source lang="xml"><param type="spacer" /></source> | ||
| + | |||
| + | You can replace the basic horizontal line with a title which can be used to group parameters. For example, | ||
| + | <source lang="xml"><param type="spacer" default="Advanced parameters" /></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"><param type="spacer" default="<b>Advanced parameters</b>" /></source> | ||
<noinclude> | <noinclude> | ||
=== See also === | === See also === | ||
| − | * [[Standard parameter types| | + | * [[Standard parameter types|List of standard parameter types]] |
| − | + | [[Category:Standard parameter types]]</noinclude> | |
| − | [[Category: | + | |
Revision as of 09:19, 18 October 2011
| Parameters have been superseded by form fields in Joomla! 1.6. You may want to use the corresponding Spacer form field type. |
The spacer parameter type provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored.
- type (mandatory) must be spacer.
- default (optional) (translatable) is a string which will be used instead of the <hr /> that is inserted by default.
Example XML parameter definition:
<param type="spacer" />You can replace the basic horizontal line with a title which can be used to group parameters. For example,
<param type="spacer" default="Advanced parameters" />Note that you can also include HTML markup but it must be encoded. For example, to put the text into bold you can use:
<param type="spacer" default="<b>Advanced parameters</b>" />
