Documentation Center

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-insertLike 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.
blockquoteThis element has may-split and auto-insert behaviors. The HTML equivalent is <blockquote>.
buttonThe HTML equivalent is <button>. This role is used to map clipboard data in HTML format to the document's schema.
cellcolspanThe 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.
cellendcolumnnameSpecifies the name of the rightmost column of a CALS table cell span.
cellstartcolumnnameSpecifies the name of the leftmost column of a CALS table cell span.
cellmorerowsSpecifies the number of additional rows in a CALS table cell.
cellrowspanThe table editor uses this attribute to specify the number of rows a cell spans. The HTML equivalent is rowspan. See also tablecell.
checkboxThe HTML equivalent is <input type="checkbox">. This role is used to map clipboard data in HTML format to the document's schema.
checkedThe 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.
citationThe HTML equivalent is <cite>. This role is used to map clipboard data in HTML format to the document's schema.
colorIf 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.
contentThis attribute will be included in spell checking and search actions. By default attributes are treated as non-content. See also non-content.
definitionlistThe 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.
dividerThe HTML equivalent is a <hr>. This role is used to map clipboard data in HTML format to the document's schema.
do-not-duplicateThis 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:
  • @cid
  • @id
emphasisAn 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>.
fileinputThe HTML equivalent is <input type="file">. This role is used to map clipboard data in HTML format to the document's schema.
formThe HTML equivalent is <form>. This role is used to map clipboard data in HTML format to the document's schema.
headerThe HTML equivalent is a <h>, <h1>, <h2> etc.
heightThe 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-uiThis 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.
hiddeninputThe HTML equivalent is <input type="hidden">. This role is used to map clipboard data in HTML format to the document's schema.
hyperlinkThe 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>.
imagebuttonThe HTML equivalent is <input type="image">. This role is used to map clipboard data in HTML format to the document's schema.
imagesourceThe 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-ratioThis 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.
labelThe HTML equivalent is <label>. This role is used to map clipboard data in HTML format to the document's schema.
labelforThe 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>.
listCurrently 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.
passwordinputThe HTML equivalent is <input type="password">. This role is used to map clipboard data in HTML format to the document's schema.
preformattedThe 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.)
quoteA button will appear in the toolbar of the editor's UI , and has may-split and auto-insert behaviors. The HTML equivalent is <blockquote>.
radiobuttonThe HTML equivalent is <input type="radio">. This role is used to map clipboard data in HTML format to the document's schema.
resetbuttonThe HTML equivalent is <input type="reset">. This role is used to map clipboard data in HTML format to the document's schema.
sectionA 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)
selectboxThe HTML equivalent is <select>. This role is used to map clipboard data in HTML format to the document's schema.
selectboxoptionThe 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.
significantAssign 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.
strongA 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>.
subheaderA subheader role element follows a header role element.
submitbuttonThe HTML equivalent is <input type="submit">. This role is used to map clipboard data in HTML format to the document's schema.
subscriptA 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>.
superscriptA 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>.
symbolThe 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.
tableThis element will be inserted by the table editor. The HTML equivalent is <table>.
tablebodyThis element can be inserted by the table editor. The HTML equivalent is a row group <tbody>.
tableborderThe 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.
tablecaptionThe 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>.
tablecellThe table editor can insert this element in the tablecellcontainer. The HTML equivalent is <td>. See also cellrowspan and cellcolspan.
tablecellpaddingThe 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.
tablecellspacingThe 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.
tablecolumncontainerThe table editor will mark the element as tablecolumncontainer. The CALS equivalent is a table section <tgroup>.
tablecolumncountThe number of columns in a CALS table group (tablecolumncontainer).
tablecolumnspecSpecifies 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>.
tablerowThe table editor will insert this element in the tablerowcontainer. The HTML equivalent is <tr>.
tablerowcontainerThe table editor will insert table rows in this element.
textlineinputThe HTML equivalent is <input type="text>. This role is used to map clipboard data in HTML format to the document's schema.
textareainputThe HTML equivalent is <textarea>. This role is used to map clipboard data in HTML format to the document's schema.
underllineA 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>.
unorderedlistThe toolbar will add an unordered list button to insert and remove this element. The HTML equivalent is <ul>.
valignThe HTML equivalent is the valign attribute. This role is used to map clipboard data in HTML format to the document's schema.
videoThe HTML equivalent is <video>.
widthThe 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 .