Difference between revisions of "Template:FieldOptions"
From SmartWiki
(→Field Options) |
|||
Line 2: | Line 2: | ||
* '''Field type''': The list of available Field Types | * '''Field type''': The list of available Field Types | ||
* '''Field Name''': The name of the field, used internally to reference the user's input. | * '''Field Name''': The name of the field, used internally to reference the user's input. | ||
+ | * '''[[Caption]]''': The leading question or prologue before the field. If left blank, the Field Name will be displayed as the caption. | ||
+ | * '''Display Order''': The order (relative to other fields) in which this field is displayed. | ||
* '''Description''': Definition and general description of the custom field. Will not be displayed. | * '''Description''': Definition and general description of the custom field. Will not be displayed. | ||
− | + | * '''Caption Location''': Determines the positioning and visibility of the [[caption]] relative to the field. Options include: Left of Field, Above Field, No Caption, Hide Caption. '''Note:''' this option was previously called '''Label Display'''. ([[Label Display Options|See examples here.]]) | |
− | + | * '''Instructions''': Text input here displays under the caption. If caption has Hide Caption enabled then any defined instructions will continue to be displayed above the input. | |
− | * '''Caption Location''': Determines the positioning and visibility of the [[caption]] relative to the field. Options include: Left of Field, Above Field, No Caption, Hide Caption. '''Note:''' this option was previously called '''Label Display'''. ([[Label Display Options|See examples here.]]) | ||
* '''Placeholder''': Text input here displays within the text box as placeholder text that will disappear once the user clicks into the field to enter content. '''Note:''' this function is different from Default Text, as Placeholder text will not create content to be stored within the field. | * '''Placeholder''': Text input here displays within the text box as placeholder text that will disappear once the user clicks into the field to enter content. '''Note:''' this function is different from Default Text, as Placeholder text will not create content to be stored within the field. | ||
− | * ''' | + | {{ToolTip}} |
+ | * '''Classify as Personal Data''': Flag this field for use in storing personal data. When enabled, the field will present the data use policy without a tooltip. | ||
+ | {{SmartFieldView}} | ||
+ | * '''SmartFields PDF Formatting''': PDF formatting option when rendered from SmartFields Views. | ||
+ | * '''Width''': Width of text box. | ||
* '''Button label''': Specify a text and or an icon for the file upload button. Will have an adjacent '''Select Icon''' button to allow icons to be included on the button. | * '''Button label''': Specify a text and or an icon for the file upload button. Will have an adjacent '''Select Icon''' button to allow icons to be included on the button. | ||
* '''Default Text''': The default text that will be displayed in the text box. | * '''Default Text''': The default text that will be displayed in the text box. | ||
* '''Tab Name''': Displays the field under a given [[Tabs_(Disambiguation)#Custom_Field_Tabs|tab]]. | * '''Tab Name''': Displays the field under a given [[Tabs_(Disambiguation)#Custom_Field_Tabs|tab]]. | ||
* '''Mandatory''': The option appears under general tab to make the field mandatory. | * '''Mandatory''': The option appears under general tab to make the field mandatory. | ||
+ | |||
+ | <!-- This template was updated: order of options; Classify as Personal Data, {{SmartFieldView}}, SmartFields PDF Formatting, Width were added --> |
Revision as of 14:47, 23 August 2018
Field Options
- Field type: The list of available Field Types
- Field Name: The name of the field, used internally to reference the user's input.
- Caption: The leading question or prologue before the field. If left blank, the Field Name will be displayed as the caption.
- Display Order: The order (relative to other fields) in which this field is displayed.
- Description: Definition and general description of the custom field. Will not be displayed.
- Caption Location: Determines the positioning and visibility of the caption relative to the field. Options include: Left of Field, Above Field, No Caption, Hide Caption. Note: this option was previously called Label Display. (See examples here.)
- Instructions: Text input here displays under the caption. If caption has Hide Caption enabled then any defined instructions will continue to be displayed above the input.
- Placeholder: Text input here displays within the text box as placeholder text that will disappear once the user clicks into the field to enter content. Note: this function is different from Default Text, as Placeholder text will not create content to be stored within the field.
- Tool Tip: When the user hovers their mouse pointer over the caption of a field, the text in this section will appear.
- Classify as Personal Data: Flag this field for use in storing personal data. When enabled, the field will present the data use policy without a tooltip.
- SmartField View - Include or exclude this field from SmartField Views (@SmartFields@) or only display this field for SmartField Views. See SmartField View for further details.
- SmartFields PDF Formatting: PDF formatting option when rendered from SmartFields Views.
- Width: Width of text box.
- Button label: Specify a text and or an icon for the file upload button. Will have an adjacent Select Icon button to allow icons to be included on the button.
- Default Text: The default text that will be displayed in the text box.
- Tab Name: Displays the field under a given tab.
- Mandatory: The option appears under general tab to make the field mandatory.