Add Field Mask

You are here: Administrators Reference > Site Administration > Elements & Forms > Field Types and Masks > Custom Field Type State > Add Field Mask

Add Field Mask

Use the Add Field Mask dialog to register a Field Mask for a Field Type. A Field Mask controls the rendering of an instance of a field within a Display Template or Rich Text Block. Contributors can "drop" fields into the rich text editor using the Insert Field icon and select a Field Mask to control how the field displays on page output.

For example, contributors using a date field - one of the pre-defined Field Types - to include a Page Last Modified, Page Creation, or custom metadata date field, first select the field in the Insert Field dialog (as shown below) and click Next to display Output Mask options.

The options under the Available Masks selection list in the Output Masks dialog are rendered by the Field Masks Input Module. They determine the parameters of how to render the output, and are passed to the Output Module at render time.

The Add Field Mask dialog displays in edit mode for existing masks, as shown below.

Field Type - For existing masks, you can change the type of field to which the current mask applies. Click the drop down to select from available field types.
Mask Name - A unique name for the field mask. This name displays in the Available Masks list box within the Output Mask dialog.
Description - Text describing the purpose of the field mask.
Input Module Name - The script module that will render options for determining field output. This module displays in the Output Masks dialog under the Available Masks field. Scripts located in the site's /masks folder display in the Custom Input Module drop down. Specify a custom module located in another directory by placing its CF Mapping value in the Explicit Module field.
Output Module Name - The name of the script module that will render the output of the field when the field is rendered for the page. This module will be passed the options selected within the Input Module, so that the output can be formatted as specified. Scripts located in the site's /masks folder will display in the Custom Output Module drop down. Specify a custom module located in another directory by placing it's CF Mapping value in the Explicit Module field.
Default mask for fields of this type - If checked, this Field Mask will be the default mask selected within the Field Mask dialog.

Related Links

You can download PDF versions of the Content Contributor's, Administrator's, and Elements Reference documents from the support section of paperthin.com (requires login).

The following guides are available locally on your CommonSpot Server:

You can also download these other guides from the support section of paperthin.com (with login):

For technical support:

http://www.paperthin.com/support/