Editor-specific roles
List of editor-specific roles that have specific functions. An alphabetical listing of all roles is available in the related topic "Roles-full list".
| Role | Description |
|---|---|
| Spell checker | |
content | This attribute will be included in spell checking and search actions. By default attributes are treated as non-content. See also non-content. |
non-content | This element will not be included in spell checking and search actions. By default, elements are treated as content. See also content. |
| User interface | |
color | If this attribute is defined as an enumeration in the schema, a toolbar color button will appear in the toolbar of the editor's UI. The property editor will use a color picker with hexadecimal color values on attributes or simple type elements with the color role. |
hidden-from-ui | This role, which can be configured for both elements and attributes, hides the configured elements and attributes from the user in the UI. The nodes will no longer show up in lists of options for adding elements. |
hyperlink | A hyperlink button will appear in the toolbar of the editor's UI to allow users to insert and remove this element. The HTML equivalent is <a>. |
image | An image button will appear in the toolbar of the editor's UI to allow users to insert and remove this element. The HTML equivalent is <img>. |
quote | A button will appear in the toolbar of the editor's UI , and has may-split and auto-insert behaviors. The HTML equivalent is <blockquote>. |
section | A button will appear in the toolbar of the editor's UI and has may-split and auto-insert behaviors. The HTML equivalent is <section> (not <div> since it is too often used for layout) |
| User actions | |
do-not-duplicate | This role is applied to attributes, and allows users to copy or split an element without copying the element's attributes. Some attributes are inherently unique, so should not be copied.
In Content Editor , the default configuration applies this role to the following attributes:
|
symbol | The role allows users to use backspace and delete to remove inline elements that do not contain text content themselves, such as inline images. The role linebreak automatically receives this role. |
linebreak | This element will be inserted when the user presses Shift+Enter. The HTML equivalent is <br>. |
may-split | This is indicates that the element may be split when the user presses Enter. When an element is split, the editor will try to split the element's parent. |
may-not-split | This indicates that the element may not be split when the user presses Enter. The may-not-split role can now also be used to prevent an inline element's content that is copied and pasted to be wrapped in a copy of the inline element. This can be used to prevent links from being copied into the document when copying link text. |
| Miscellaneous roles | |
preformatted | The HTML equivalent is <pre>. (Note: Use a xml:space="preserve" attribute on an element to obtain the similar space and newline behavior as in HTML.) |
inline-object | This role is for inline objects, for example footnotes, that need different behavior from inline formatting. |
significant | Assign this role to an attribute if the editor should consider an element significant and should not remove empty elements if the element has this attribute. In several situations, the editor will automatically remove elements if they are considered empty. For example, an align attribute is not significant, but an href attribute is. |