DEPRECATED
This rich text field definition has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework.
For the updated implementation, see Rich text field for Magnolia 6 UI instead.
RichTextFieldDefinition renders a rich text editor. This is a custom Magnolia field that implements the CKEditor component.
class: info.magnolia.ui.form.field.definition.RichTextFieldDefinition
fieldType: richText
Rich Text field properties
Simple rich text field definition.
form: tabs: - name: tabText label: Text fields: - name: text fieldType: richText tables: true height: 500 label: Text Editor
Node name | Value |
---|---|
form | |
tabs | |
tabText | |
fields | |
text | |
fieldType | richText |
tables | true |
height | 500 |
label | Text Editor |
Field-specific properties:
| optional, default is Text alignment for paragraphs. When set to |
| optional Colors displayed in the color selectors. Comma-separated a string of hexadecimal color codes without the |
| optional Location of a custom CKEditor configuration file, e.g. The default configuration files can be found in
If you use a custom configuration file Magnolia will ignore all other configured properties. A custom configuration allows you control over the |
| optional List of font names displayed in the Font selector in the toolbar, for example CKEditor documentation for more. |
| optional List of fonts size displayed in the Font selector in the toolbar, for example |
| optional, default is The height of the editing area, including the toolbar, for example |
| optional, default is Allows images to be added from the DAM. When set to |
| optional, default is Allows bulleted and numbered lists. When set to |
| optional, default is Allows toggling between text and HTML editing. When set to |
| optional, default is Allows tables to be added. When set to |
Link buttons
There are three link buttons:
- Links to external pages
- Links to internal pages
- Links to documents in the DAM
Loading order for custom configuration
Note that any configuration done in a RichTextFieldFactory will override configuration settings from the config.js
file. This is why we ignore other properties in the field definition as soon as a configJsFile
is configured.
Decode text
CKEditor produces HTML such as <p>
elements for paragraphs. However, text stored in JCR usually escapes HTML code. To render text which originates from a rich text field you need to decode the stored content to make sure the HTML tags are rendered properly again.
Decode the content
object and then get the desired property from it:
${cmsfn.decode(content).text!""}
See cmsfn
decodeHtml.
Impact on the search index
Keep in mind that using the RTE introduces HTML into your content. The impact of this is that the HTML will be indexed along with the content.