Template:Dataformfield plugin info

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.

Template

The field template allows for creating a complex display of the field content by interpreting patterns of the field if included in the template. For example, with a number field called Number and the field template 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.' The field template can also be used as a simple label for the field (rather than labels as static content in the view template) with the advantage that it observes the field visibility and is hidden if the field is set to be hidden. The field template can be added to the view by means of the [[fieldname@]] pattern.

Patterns

Common field patterns

[[fieldname@]]

Displays the field label/template.

Sort / Search

The following field elements are available for defining sort and search criteria in Dataform Filters:

Sort

• Content – The textual content of the field.

Search

• Content – The textual content of the field.

Import / Export

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.
|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. Example:
===Field specific patterns===
====pattren name====
Pattern description.

|sort search = Enter list of sort and search elements. Example

The following field elements are available for defining sort and search criteria in [[Dataform Filters]]:

'''Sort'''
*'''Element name'''
*'''Element name'''
'''Search'''
*'''Element name'''
*'''Element name'''
|import export = 
Enter description of import settings if different from the standard and import content.
}}