Rich Text Field
The Rich Text Field represents a field that can be created in Model Builder, allowing the inclusion of mainly text that can be formatted with common options, such as font size, bold, italics, underline, and other basic content like code, lists, images, and links in Entries.
The following section explains the configuration of the Rich Text field in the model builder and its usage in an entry, depending on these configurations.
Rich Text Field in Model Builder
When adding a Rich Text field in the model builder, you can configure its settings in the right sidebar. The field information that needs to be filled in includes:
Field name: This is the name of the field that will be displayed in entries and other relevant areas.
Alias: A required and unique identifier for the field, which cannot be modified once the field is saved.
Description: An optional field that allows you to describe the purpose or use case of the Rich Text field.
Once you have filled in the necessary field information in the configuration sidebar, you can click the "Create" button at the bottom, and the Rich Text field will be successfully added to the model editor.
Rich Text Field in Model Builder
Rich Text Field Configuration
By selecting the Rich Text field in the model editor, you have access to several quick actions. These actions enable you to delete the field, open the configuration sidebar, and adjust the field's position within the model.
The Configuration sidebar consists of four tabs: General, Appearance, Validations, and other Configuration. These tabs provide various settings and options for customizing the behavior and appearance of the Rich Text field.
General tab
The General tab in the configuration of the Rich Text field contains essential field information, including Field name, Alias, Description, Calculate metrics option, Formatting Options, and Hyperlinks.
The Calculate metrics option is represented by a switch toggle, which determines whether you want the words, characters, sentences, and media files added in this field to be calculated and displayed in the Metrics section on the right sidebar of the entry.
The Formatting Options section includes all the available formatting options for displaying and using the Rich Text field in the entry, such as Headings (from H1 to H6), Bold, Italic, Underline, Code, Bullet List, Ordered List, Blockquote, Subscript, and Superscript. You can specify which formatting options are shown in the toolbar of the Rich Text field in the entry according to your needs and requirements by enabling or disabling them.
Besides these, there is also the Hyperlinks option, which can be specified to be enabled or disabled in the toolbar of the Rich Text field in the entry.
Note that while Field name, Description, Calculate metrics option, Formatting Options, and Hyperlinks can be modified even after saving the field, the Alias cannot be modified once the field has been saved in the model builder.
Appearance tab
The Appearance tab in the configuration of the Rich Text field focuses on how the field will be displayed in the entries created by the model. For this field, there is only one available option: "Rich Text" which is selected by default.
The Appearance tab also includes the Help Text field. This field can be used to display a tooltip or inline text in the entry based on the selection, providing users with additional guidance and understanding of how to use the text field effectively.
Furthermore, the Appearance tab offers the option to show character counting in the entry. When enabled, this option will display the number of characters in the Rich Text field, allowing users to keep track of the text length as they type or edit content.
Validations tab
In the Validations tab, you have the ability to apply constraints to the Rich Text field. These constraints enforce specific requirements on the field's input, ensuring that the entry cannot be published unless the Rich Text field adheres to these restrictions. The available options for validation include:
Required field: If you select this option, the Rich Text field must be filled when creating an entry. It becomes mandatory to input a value in the Rich Text field before the entry can be published.
In addition to this option, you can enable a condition that makes this field required depending on the value of another text field. After enabling this option, you can continue to fill in the fields as follows:
Field: Opens a dropdown menu listing all the text fields of the current model.
Operator: Opens a dropdown menu with operators such as contains, does not contain, equals, does not equal, exists, and does not exist.
Value: Enter the desired value.
Read-only: This option allows you to make the field read-only for users.
Additionally, you can set a condition that makes this field read-only depending on the value of another field. After enabling this option, you can continue to fill in the fields as follows:
Field: Opens a dropdown menu listing all the text fields of the current model.
Operator: Opens a dropdown menu with operators such as contains, does not contain, equals, does not equal, exists, and does not exist.
Value: Enter the desired value.
Limit character count: This option allows you to limit character count of characters that users can input into the Rich Text field. Users will only be able to enter characters within this specified range. The available options are:
Between: With this option, you can set both a minimum and a maximum value, limiting users to input characters that fall between these two values.
At least: This option sets a minimum value, and users must input characters that are equal to or exceed the specified minimum.
At most: This option sets a maximum value, and users must input characters that are equal to or below the specified maximum.
Exactly: With this option, you can set an exact character count range, and users will be restricted to input characters within this defined range.
By leveraging the Validations tab, you can ensure that the Rich Text field in your model enforces specific constraints, maintaining data integrity and consistency in your entries.
Validations Tab
Other Configuration
This tab includes additional configuration options for the Rich Text field, such as:
Enable field in search: When enabled, this option allows the selected rich text field to be searchable in the entries listing for the corresponding model.
Rich Text Field in Entry Editor
The Rich Text field in the entry will be displayed and can be used based on the configuration in the model. Let's explore some appearances and use cases of the Rich Text field in the entry editor.
Formatting options: The formatting options displayed in the toolbar of the Rich Text field will depend on the model's configuration. The enabled formatting options in the model's configuration will be shown in the toolbar of the Rich Text field, while the disabled options will not be displayed.
Metrics: If the "Calculate metrics" option is selected in the model, the added words, characters, sentences, and media files will be calculated for the respective field, and the metrics will be displayed in the entry.
Help Text Tooltip: If help text is added to the rich text field in the model's configuration and its display is set to "Tooltip", it will be displayed as a tooltip near the field's title in the entry editor, providing additional guidance.
Help Text Inline: If help text is added to the rich text field in the model's configuration and its display is set to "Inline text", it will be displayed as inline text near the field's title in the entry editor, providing additional guidance.
Required field: If the Rich Text field is marked as a required field in the model, the user cannot publish the entry without filling in the respective field. A warning message with a red color will be displayed under the field, indicating that the Rich Text field is required.
Read-only: If the Read-only option is enabled in the model, the user can view this field as read-only.
Limit character count: If a specific character limit is defined for the Rich Text field in the model, the user cannot publish the entry if the entered value does not fall within the specified limit. A warning error with a red color will be displayed under the field, depending on the template configuration in the model.
Rich Text Field in Entry Editor