Format templates
Formatting options in the DOM Editor
FirstSpirit supports a large number of input components for different types of editorial contents. The input components DOM Editor and DOM Table are made available for extensive text inputs. These components enable the editor to use formatting.
If the editor selects section formatting from the left-hand selection list the formatting affects the whole section in the input component up to the next line break. Section formats can only be selected if no text is highlighted (selected).
If, on the other hand, the editor selects individual text formatting from the right-hand selection list or via a button the formatting affects the previously highlighted text only.
Standard format templates
FirstSpirit provides a range of default format templates. The standard format templates are made available as an export file (for further information see FirstSpirit Developer's Manual) and can be imported into the project's Template Store under “Format Templates” node:
 |
These default format templates are required for a smooth operation in many respects and must not be deleted. |
The format templates
- “Deleted”
- “Deleted (Block)”
- “Inserted” and
- “Inserted (Block)”
are used for example for the display of version comparisons (“version history”). So you can influence the display of modifications in version comparisons by changing the properties of these format templates (color, font size, background color) (see page Properties). The representation of the other default format templates in the DOM-Editor can be changed too.
Standard format template | Tag / Unique name | Description for default setting |
|---|---|---|
Bold | b | Highlighted text is set to bold |
Line break | br | Line break through the key combination (key shortcut) SHORTCUT |
Link | CMS_LINK | Formatting for links |
Deleted | deleted | for displaying deleted individual text in version comparisons |
Deleted (Block) | deleted_block | for displaying deleted blocks in version comparisons |
Italic | i | Highlighted text is set to italics |
Inserted | inserted | for displaying inserted individual text in version comparisons |
Inserted (Block) | inserted_block | for displaying inserted blocks in version comparisons |
List entry | li | Formatting for list entries |
Standard | p | Formatting for standard sections |
Preformatted | pre | Selected text is displayed in equal density lettering; this means that all letters and spaces have exactly the same width. Is particularly suitable for displaying code examples. |
Default style template | default_style_template | Layout of inline tables (see also #style) |
Table | table | Formatting for tables |
Default inline table | default_inline_table | Layout of inline tables (see also #style) |
Table cell | td | Formatting for table cells |
Table row | tr | Formatting for table rows |
Underline | u | Highlighted text is displayed underlined. |
List | ul | Formatting for lists |
Project-specific format templates
Apart from the available Standard format templates template developers can also add their own, project-specific formatting. New formatting can be created in the Template Store below the “Format Templates” node.
The properties of a format template can be defined in the editing area using the “Properties” tab. The individual fields of the screen form are explained in the Properties chapter.
Apart from the “Properties” tab, further tabs are displayed for each output channel of the project. A conversion rule can be specified here for each output channel (see Chapter Conversion).
The template developer must define the output for each output channel in the “Templates” area so that the formatted contents of the DOM input component are visible in the respective output channel (see Chapter Output of formatted texts).
The format template can then be used in a DOM input component. To this end it must be given in the form area of the required page or section template (see Chapter Using format templates). The new format templates created are then available in the corresponding DOM input components for formatting the editorial contents.