Roles- full list
Alphabetical listing of all roles with descriptions.
address | The HTML equivalent is <address>. This role is used to map clipboard data in HTML format to the document's schema. |
align | The HTML equivalent is the align attribute of an any HTML element. This role is used to map clipboard data in HTML format to the document's schema. |
audio | The HTML equivalent is <audio>. |
auto-insert | Like the paragraph role, this role can be used to configure an item as the default choice for an element that ought to contain at least one of a choice. |
blockquote | This element has may-split and auto-insert behaviors. The HTML equivalent is <blockquote>. |
button | The HTML equivalent is <button>. This role is used to map clipboard data in HTML format to the document's schema. |
cellcolspan | The table editor uses this attribute to specify the the The table editor uses this attribute to specify the the number of columns a cell spans. The HTML equivalent is colspan. See also tablecell. |
cellendcolumnname | Specifies the name of the rightmost column of a CALS table cell span. |
cellstartcolumnname | Specifies the name of the leftmost column of a CALS table cell span. |
cellmorerows | Specifies the number of additional rows in a CALS table cell. |
cellrowspan | The table editor uses this attribute to specify the number of rows a cell spans. The HTML equivalent is rowspan. See also tablecell. |
checkbox | The HTML equivalent is <input type="checkbox">. This role is used to map clipboard data in HTML format to the document's schema. |
checked | The HTML equivalent is the checked attribute on the <input> element. This role is used to map clipboard data in HTML format to the document's schema. |
citation | The HTML equivalent is <cite>. This role is used to map clipboard data in HTML format to the document's schema. |
color | If this attribute is defined as an enumeration in the schema it receives an icon in the UI. The property editor will use a color picker with hexadecimal color values on attributes or simple type elements with the color role. |
content | This attribute will be included in spell checking and search actions. By default attributes are treated as non-content. See also non-content. |
definitionlist | The HTML equivalent is a <dl>. |
definitionlistdefinition | The HTML equivalent is a <dd>. This role is used to map clipboard data in HTML format to the document's schema. |
definitionlistdefinitionterm | The HTML equivalent is a <dt>. This role is used to map clipboard data in HTML format to the document's schema. |
directorylist | The HTML equivalent is a <dir>. This role is used to map clipboard data in HTML format to the document's schema. |
divider | The HTML equivalent is a <hr>. This role is used to map clipboard data in HTML format to the document's schema. |
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:
|
emphasis | An I button will appear in the toolbar of the editor's UI to allow users to insert and remove this element. The HTML equivalent is <em>. |
fileinput | The HTML equivalent is <input type="file">. This role is used to map clipboard data in HTML format to the document's schema. |
form | The HTML equivalent is <form>. This role is used to map clipboard data in HTML format to the document's schema. |
header | The HTML equivalent is a <h>, <h1>, <h2> etc. |
height | The HTML equivalent is the height attribute. This role is used to map clipboard data in HTML format to the document's schema. This role is also used to indicate that this attribute may be used to scale the element with resize handles. This role can be used in combination with the keep-aspect-ratio and width roles. |
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 interface. The nodes will no longer show up in lists of options for adding elements. |
hiddeninput | The HTML equivalent is <input type="hidden">. This role is used to map clipboard data in HTML format to the document's schema. |
hyperlink | The toolbar will add an insert hyperlink button to insert and remove this element. The HTML equivalent is <a>. |
hyperlinkreference | The HTML equivalent is the href attribute on the <a> element. This role is used to map clipboard data in HTML format to the document's schema. |
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>. |
imagebutton | The HTML equivalent is <input type="image">. This role is used to map clipboard data in HTML format to the document's schema. |
imagesource | The HTML equivalent is the src attribute of an <img>. |
inline-object | This role is for inline objects, for example footnotes, that need different behavior from inline formatting. |
keep-aspect-ratio | This role is used to force resize handles to keep the aspect ratio as defined by the width and height of the element. This role should be used in combination with the width and height role. |
label | The HTML equivalent is <label>. This role is used to map clipboard data in HTML format to the document's schema. |
labelfor | The HTML equivalent is the for attribute on the <label> element. This role is used to map clipboard data in HTML format to the document's schema. |
linebreak | This element will be inserted when the user presses Shift+Enter. The HTML equivalent is <br>. |
list | Currently not used; See definitionlist, ordered-list and unorderedlist. |
listitem | The HTML equivalent is <li>. |
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. |
mediaalign | The HTML equivalent is the align attribute of an <img>. |
non-content | This element will not be included in spell checking and search actions. By default, elements are treated as content. See also content. |
orderedlist | The toolbar will add an ordered list button to insert and remove this element. The HTML equivalent is <ol>. |
paragraph | This element will often be inserted when the user presses Enter. The HTML equivalent is <p>. The paragraph role includes the auto-insert role. |
passwordinput | The HTML equivalent is <input type="password">. This role is used to map clipboard data in HTML format to the document's schema. |
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.) |
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>. |
radiobutton | The HTML equivalent is <input type="radio">. This role is used to map clipboard data in HTML format to the document's schema. |
resetbutton | The HTML equivalent is <input type="reset">. This role is used to map clipboard data in HTML format to the document's schema. |
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) |
selectbox | The HTML equivalent is <select>. This role is used to map clipboard data in HTML format to the document's schema. |
selectboxoption | The HTML equivalent is <option>. This role is used to map clipboard data in HTML format to the document's schema. |
selectboxselectedindex | The HTML equivalent is the selectedindex attribute on the <select> element. This role is used to map clipboard data in HTML format to the document's schema. |
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. |
strikethrough | The HTML equivalent is <s>. This role is used to map clipboard data in HTML format to the document's schema. |
strong | A B button will appear in the toolbar of the editor's UI to allow users to insert and remove this element. The HTML equivalent is <strong>. |
subheader | A subheader role element follows a header role element. |
submitbutton | The HTML equivalent is <input type="submit">. This role is used to map clipboard data in HTML format to the document's schema. |
subscript | A subscript button will appear in the toolbar of the editor's UI and allow users to insert and remove this element. The HTML equivalent is <sub>. |
superscript | A superscript button will appear in the toolbar of the editor's UI and allow users to insert and remove this element. The HTML equivalent is <sup>. |
symbol | The role allows people 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. |
table | This element will be inserted by the table editor. The HTML equivalent is <table>. |
tablebody | This element can be inserted by the table editor. The HTML equivalent is a row group <tbody>. |
tableborder | The HTML equivalent is the border attribute on a <table>. This role is used to map clipboard data in HTML format to the document's schema. |
tablecaption | The HTML equivalent is <caption>. This role is used to map clipboard data in HTML format to the document's schema. |
tablecellcontainer | The table editor will insert table cells in this element. The HTML equivalent is <tr>. |
tablecell | The table editor can insert this element in the tablecellcontainer. The HTML equivalent is <td>. See also cellrowspan and cellcolspan. |
tablecellpadding | The HTML equivalent is the cellpadding attribute on a <table>. This role is used to map clipboard data in HTML format to the document's schema. |
tablecellspacing | The HTML equivalent is the cellspacing attribute on a <table>. This role is used to map clipboard data in HTML format to the document's schema. |
tablecolumncontainer | The table editor will mark the element as tablecolumncontainer. The CALS equivalent is a table section <tgroup>. |
tablecolumncount | The number of columns in a CALS table group (tablecolumncontainer). |
tablecolumnspec | Specifies a CALS column element. |
tablecolumnnumber | Specifies the attribute that contains the number of a CALS column. |
tablecolumnname | Specifies the attribute that contains the name of a CALS column. |
tablefooter | This element can be inserted by the table editor. The HTML equivalent is a row group <tfoot>. |
tableheader | This element can be inserted by the table editor. The HTML equivalent is a row group <thead>. |
tableheadercell | The table editor can insert this element in the tablecellcontainer. The HTML equivalent is <th>. |
tableheaderrow | The table editor can insert this element in the tablerowcontainer. The DITA equivalent is a simpleheader table header <sthead>. |
tablerow | The table editor will insert this element in the tablerowcontainer. The HTML equivalent is <tr>. |
tablerowcontainer | The table editor will insert table rows in this element. |
textlineinput | The HTML equivalent is <input type="text>. This role is used to map clipboard data in HTML format to the document's schema. |
textareainput | The HTML equivalent is <textarea>. This role is used to map clipboard data in HTML format to the document's schema. |
underlline | A U button will appear in the toolbar of the editor's UI to allow users to insert and remove this element. The HTML equivalent is <u>. |
unorderedlist | The toolbar will add an unordered list button to insert and remove this element. The HTML equivalent is <ul>. |
valign | The HTML equivalent is the valign attribute. This role is used to map clipboard data in HTML format to the document's schema. |
video | The HTML equivalent is <video>. |
width | The HTML equivalent is the width attribute. This role is used to map clipboard data in HTML format to the document's schema. This role is also used to indicate that this attribute may be used to scale the element with resize handles. This role can be used in combination with keep-aspect-ratio and height . |