Template:Dataformfield plugin info

TBC

Usage

TBC

Settings

General settings

• Name - Short name for the field. Since the field name is used in field patterns, long convoluted names may make the view template less readable.
• Description - Short description of the field purpose and characteristics to allow managers to see at a glance what each field is intended for. This description is displayed only in the field management list.
• Visibile – To whom the field (label and content in browse and editing modes) is visible when displaying entries (in views that contain the field pattern).
  • Managers only: Users with manageentries capability.
  • Owner and managers: Users with manageentries capability and the entry author.
  • Everyone: All users.
• Editable – Whether the field content can be updated by an entry author without manageentries capability.
• Label - The field label allows for specifying a designated field label that can be added to the view by means of the [[fieldname@]] field pattern. This field pattern observes the field visibility and is hidden if the field is set to be hidden. The field label can also serve as a field display template and it interprets patterns of that field if included in the label. For example, with a number field called Number and the field label defined as 'You have earned [[Number]] credits.' and an entry where the number value is 47 the pattern [[Number@]] would be displayed as 'You have earned 47 credits.'

Patterns

Common field patterns

[[field name@]]: Displays the field label/template.

Other patterns

This field does not provide additional patterns.

Sort

The following field elements are available for defining sort criteria in Dataform Filters.

• Content – The textual content of the field.

Search

The following field elements are available for defining search criteria in Dataform Filters.

• Content – The textual content of the field.

Import

Settings

• Name – The heading of the corresponding column in the csv import file. Defaults to the pattern name.

Content

Depending on the imported pattern.

Copy and complete the following code to document a dataformfield plugin:

{{Dataformfield plugin info
|description = Enter a short description of the field with an illustration if applicable.
|usage = Enter usage description if the field provides specialized functionality in addition to or instead of the standard field functionality of displaying and updating content. For example, the dataformfield_entrystate field provides a specialized ajax functionality for changing state in browse mode. The content of this parameter resides under a level 2 Usage heading and sub-headings should start from level 3. 
|general settings = Enter description of general settings if different from the base general settings. Defaults to base general settings.
|other settings = Enter description of any other settings available in the field configuration form.
|common patterns = Enter description of common field patterns if different from the base common field patterns. Defaults to base common field patterns.
|other patterns = Enter description of any additional patterns provided by the field if any.
 
[[pattren name]]: Pattern description.


|sort = Enter list of sort elements.
*'''Element name'''
*'''Element name'''
|search = Enter list of search elements.
*'''Element name'''
*'''Element name'''
|import = Enter description of import settings if different from the standard and import content.
}}