Actions

Difference between revisions of "Standard form field and parameter types"

From Joomla! Documentation

Line 1: Line 1:
{{cookiejar}}
+
There are 21 different standard parameter types supported in the Joomla Framework for all extension types (templates, components, modules and plugins).  This section gives a brief description of each parameter type, in alphabetical order.  Full details of each parameter type are given on the following pages.
===Parameter types supported===
+
 
----
+
* '''[[Calendar parameter type|calendar]]''' provides a text box for entry of a date.  An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
This chunk should begin by explaining what extension parameters are and
+
* '''[[Category parameter type|category]]''' provides a drop down list of categories from a given section.
provide a simple illustration of parameters in use. It should then
+
* '''[[Editors parameter type|editors]]''' provides a drop down list of the available WYSIWYG editors.
describe how and where to place parameter definitions in extension XML
+
* '''[[Filelist parameter type|filelist]]''' provides a drop down list of files from a specified directory.
files and how to access parameter values in PHP during extension execution.
+
* '''[[Folderlist parameter type|folderlist]]''' provides a drop down list of folders from a specified directory.
Having listed the available parameter types in brief, it should
+
* '''[[Helpsites parameter type|helpsites]]''' provides a drop down list of the help sites for your Joomla installation.
then provide a complete reference to each type including the XML syntax
+
* '''[[Hidden parameter type|hidden]]''' provides a hidden field for saving a parameter whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file).
required and annotated screenshots to show their effect.
+
* '''[[Imagelist parameter type|imagelist]]''' provides a drop down list of image files in a specified directory.
----
+
* '''[[Languages parameter type|languages]]''' provides a drop down list of the installed languages for the Front-end or Back-end.
 +
* '''[[List parameter type|list]]''' provides a drop down list of custom-defined entries.
 +
* '''[[Menu parameter type|menu]]''' provides a drop down list of the available menus from your Joomla site.
 +
* '''[[Menuitem parameter type|menuitem]]''' provides a drop down list of the available menu items from your Joomla site.
 +
* '''[[Password parameter type|password]]''' provides a text box for entry of a password.  The password characters will be obscured as they are entered.
 +
* '''[[Radio parameter type|radio]]''' provides radio buttons to select different options.
 +
* '''[[Section parameter type|section]]''' provides a drop down list of the sections from your Joomla site.
 +
* '''[[Spacer parameter type|spacer]]''' provides a visual separator between parameter field elements.  It is purely a visual aid and no parameter value is stored.
 +
* '''[[Sql parameter type|sql]]''' provides a drop down list of entries obtained by running a query on the Joomla Database.  The first results column returned by the query provides the values for the drop down box.
 +
* '''[[Text parameter type|text]]''' provides a text box for data entry.
 +
* '''[[Textarea parameter type|textarea]]''' provides a text area for entry of multi-line text.
 +
* '''[[Timezones parameter type|timezones]]''' provides a drop down list of time zones.
 +
* '''[[Usergroups parameter type|usergroups]]''' provides a drop down list of user groups.
 
[[Category:Templates]]
 
[[Category:Templates]]

Revision as of 11:49, 16 August 2008

There are 21 different standard parameter types supported in the Joomla Framework for all extension types (templates, components, modules and plugins). This section gives a brief description of each parameter type, in alphabetical order. Full details of each parameter type are given on the following pages.

  • calendar provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.
  • category provides a drop down list of categories from a given section.
  • editors provides a drop down list of the available WYSIWYG editors.
  • filelist provides a drop down list of files from a specified directory.
  • folderlist provides a drop down list of folders from a specified directory.
  • helpsites provides a drop down list of the help sites for your Joomla installation.
  • hidden provides a hidden field for saving a parameter whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the params.ini file).
  • imagelist provides a drop down list of image files in a specified directory.
  • languages provides a drop down list of the installed languages for the Front-end or Back-end.
  • list provides a drop down list of custom-defined entries.
  • menu provides a drop down list of the available menus from your Joomla site.
  • menuitem provides a drop down list of the available menu items from your Joomla site.
  • password provides a text box for entry of a password. The password characters will be obscured as they are entered.
  • radio provides radio buttons to select different options.
  • section provides a drop down list of the sections from your Joomla site.
  • spacer provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored.
  • sql provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box.
  • text provides a text box for data entry.
  • textarea provides a text area for entry of multi-line text.
  • timezones provides a drop down list of time zones.
  • usergroups provides a drop down list of user groups.