RTE interface configuration objects:

These objects contain the actual configuration of the RTE interface.

default.[…]

Property

default.[…]

config.[ tablename ].[ field ].[…]

config.[ tablename ].[ field ].types.[ type ].[…]

Description

These objects contain the actual configuration of the RTE interface. For the properties available, refer to the table below.This is a description of how you can customize in general and override for specific fields/types.

‘RTE.default’ configures the RTE for all tables/fields/types

‘RTE.config.[ tablename ].[ field ]’ configures a specific field. The values inherit the values from ‘RTE.default’ in fact this is overriding values.

‘RTE.config.[ tablename ].[ field ].types.[ type ]’ configures a specific field in case the ‘type’-value of the field matches type . Again this overrides the former settings.

[page:RTE]

RTE interface configuration properties:

These properties may be set for each RTE interface configuration object.

disabled

Property

disabled

Data type

boolean

Description

If set, the editor is disabled.

showButtons

Property

showButtons

Data type

list of id-strings

Description

List of buttons that should be enabled in the editor toolbar.

Note: showButtons = * shows all available buttons.

Available buttons are: blockstylelabel, blockstyle, textstylelabel, textstyle, fontstyle, fontsize, formatblock, blockquote, insertparagraphbefore, insertparagraphafter, lefttoright, righttoleft, language, showlanguagemarks, left, center, right, justifyfull, orderedlist, unorderedlist, definitionlist, definitionitem, outdent, indent, formattext, bidioverride, big, bold, citation, code, definition, deletedtext, emphasis, insertedtext, italic, keyboard, monospaced, quotation, sample, small, span, strikethrough, strong, subscript, superscript, underline, variable, textcolor, bgcolor, textindicator, editelement, showmicrodata, emoticon, insertcharacter, insertsofthyphen, line, link, unlink, image, table, user, abbreviation, findreplace, spellcheck, chMode, inserttag, removeformat, copy, cut, paste, pastetoggle, pastebehaviour, undo, redo, about, toggleborders, tableproperties, tablerestyle, rowproperties, rowinsertabove, rowinsertunder, rowdelete, rowsplit, columnproperties, columninsertbefore, columninsertafter, columndelete, columnsplit, cellproperties, cellinsertbefore, cellinsertafter, celldelete, cellsplit, cellmerge

Note: Buttons textcolor, bgcolor, fontstyle and fontsize are enabled only if «Enable features that use the style attribute> is checked in the extension manager.

Note: If extension static_info_tables is not installed, the spellcheck, language and abbreviation buttons are not enabled.

Note: If the encoding of the content element is not either iso-8859-1 or utf-8, the spellcheck button is not enabled.

Note: Buttons user and abbreviation are never available in the front end.

Note: Button unlink is not available if button link is not available.

Note: None of the table operations buttons is available if the button table is not available.

Note: Firefox 29+, Opera, Safari 5+ and Chrome 6+ do not support the copy, cut and paste buttons.

hideButtons

Property

hideButtons

Data type

list of id-strings

Description

List of buttons that should not be enabled in the editor toolbar.

toolbarOrder

Property

toolbarOrder

Data type

list of id-strings

Description

Specifies the order and grouping of buttons in the RTE tool bar. The keywords space, bar and linebreak may be used to insert a space, a separator or a line break at the corresponding position in the tool bar.

Default: blockstylelabel, blockstyle, space, textstylelabel, textstyle, linebreak,

bar, formattext, bold, strong, italic, emphasis, big, small, insertedtext, deletedtext, citation, code, definition, keyboard, monospaced, quotation, sample, variable, bidioverride, strikethrough, subscript, superscript, underline, span, bar, fontstyle, space, fontsize, bar, formatblock, blockquote, insertparagraphbefore, insertparagraphafter, bar, lefttoright, righttoleft, language, showlanguagemarks, bar, left, center, right, justifyfull, bar, orderedlist, unorderedlist, definitionlist, definitionitem, outdent, indent, bar, textcolor, bgcolor, textindicator, bar, editelement, showmicrodata, emoticon, insertcharacter, insertsofthyphen, line, link, unlink, image, table, user, abbreviation, bar, findreplace, spellcheck, bar, chMode, inserttag, removeformat, bar, copy, cut, paste, pastetoggle, pastebehaviour, bar, undo, redo, bar, about, linebreak, toggleborders, bar, tableproperties, tablerestyle, bar, rowproperties, rowinsertabove, rowinsertunder, rowdelete, rowsplit, bar, columnproperties, columninsertbefore, columninsertafter, columndelete, columnsplit, bar, cellproperties, cellinsertbefore, cellinsertafter, celldelete, cellsplit, cellmerge

defaultContentLanguage

Property

defaultContentLanguage

Data type

string

Description

ISO code of default language of content elements. This language is used by RTE features that insert content, usually in the form of values of html tag attributes, when the language of the content element is not specified. This property applies to TYPO3 BE only.

Default: en

Note: Any value other than ‘en’ requires Static Info Tables to be installed.

contextMenu.disabled

Property

contextMenu.disabled

Data type

boolean

Description

If set, the context menu of the RTE triggered by mouse right click is disabled.

Default: 0

Note: Context menu is not available in Opera.

contextMenu.showButtons

Property

contextMenu.showButtons

Data type

list of id-strings

Description

List of buttons that should be shown in the context menu For the list of available buttons see property showButtons above.

Default: If not specified, all buttons available in the editor toolbar will appear in the context menu, unless they are removed by property contextMenu.hideButtons.

Note: Drop-down lists or select boxes will not be shown in the context menu.

Note: The buttons must be enabled in the editor toolbar.

Note: The buttons will appear in the same order as in the editor toolbar (see property toolbarOrderabove).

contextmenu.hideButtons

Property

contextmenu.hideButtons

Data type

list of id-strings

Description

List of buttons that should not be shown in the context menu.

contextMenu.maxHeight

Property

contextMenu.maxHeight

Data type

int+

Description

Maximum height of the context menu in pixels.

Default: 300

showStatusBar

Property

showStatusBar

Data type

boolean

Description

Specifies that the editor status bar should be displayed or not.

Default: 0

Note: showStatusBar is set to 1 in the Typical and Demo default configurations (see chapter on default configurations).

buttons.editelement.removeFieldsets

Property

buttons.editelement.removeFieldsets

Data type

list of id-strings

Description

List of fieldsets to remove from the edit element dialogue.

Possible string values are: identification, style, language, microdata, events.

buttons.editelement.properties.removed

Property

buttons.editelement.properties.removed

Data type

list of id-strings

Description

List of fields to remove from the edit element dialogue.

Possible string values are: id, title, language, direction, onkeydown, onkeypress, onkeyup, onclick, ondblclick, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup.

buttons.formatblock.orderItems

Property

buttons.formatblock.orderItems

Data type

list of id-strings

Description

Specifies the order in which the block element types are presented in the block formating drop-down list.

The standard block element types are: p, h1, h2, h3, h4, h5, h6, pre, address, article, aside, blockquote, div, footer, header, nav, section

The list may also contain custom items as specified by the buttons.formatblock.addItems property.

If not set, the default order will be alphabetical, in the language of the current backend user.

Note: If set, any option not in the list will be removed from the drop-down list.

buttons.formatblock.removeItems

Property

buttons.formatblock.removeItems

Data type

list of id-strings

Description

List of default items to be removed from the block formating drop-down list.

The default items are: p, h1, h2, h3, h4, h5, h6, pre, address, article, aside, blockquote, div, footer, header, nav, section

buttons.formatblock.addItems

Property

buttons.formatblock.addItems

Data type

list of id-strings

Description

List of custom items to be added to the block formating drop-down list.

Each of the added items should be configured.

buttons.formatblock.items.[ item-name ].label

Property

buttons.formatblock.items.[ item-name ].label

Data type

string

Description

Alternative label for the option identified by the item name in the block formating drop-down list.

Note: The string may be a reference to an entry in a localization file of the form LLL:EXT:[ fileref ]:[ labelkey ]

buttons.formatblock.items.[ item-name ].addClass

Property

buttons.formatblock.items.[ item-name ].addClass

Data type

string

Description

A class name to be assigned to the blocks whenever the item is applied to selected text.

Note: The specified class should be allowed on elements of the block type (using property RTE.default.buttons.blockstyle.tags.[ tagName ].allowedClasses).

buttons.formatblock.items.[ item-name ].tagName

Property

buttons.formatblock.items.[ item-name ].tagName

Data type

string

Description

A tag name to be assigned to the block elements whenever the (custom) item is applied to selected text.

The value of this property must be equal to one of the standard block element types.

Note: [ item-name ] must not be a standard block tag name.

Note: If [ item-name ] also has property addClass, then the specified class should be allowed on elements of block type tagName (using property RTE.default.buttons.blockstyle.tags.[ tagName ].allowedClasses).

buttons.formatblock.prefixLabelWithTag

Property

buttons.formatblock.prefixLabelWithTag

Data type

boolean

Description

If set, the option label in the block formating drop-down list is prefixed with the tagname.

Default: 0

buttons.formatblock.postfixLabelWithTag

Property

buttons.formatblock.postfixLabelWithTag

Data type

boolean

Description

If set, the option label in the block formating drop-down list is postfixed with the tagname.

Default: 0

buttons.formatblock.items.[ item-name ].hotKey

Property

buttons.formatblock.items.[ item-name ].hotKey

Data type

character

Description

A hotkey will be associated with the option of the block formating drop-down list identified by the item name.

buttons.indent.useClass

Property

buttons.indent.useClass

Data type

string

Description

Class name to be used when indenting by means of div sections with class attribute.

Default: indent

buttons.indent.useBlockquote

Property

buttons.indent.useBlockquote

Data type

boolean

Description

If set, indentation will be produced by means of blockquote tags instead of div sections with class attribute.

Default: 0

buttons.left.useClass

Property

buttons.left.useClass

Data type

string

Description

Class name to be used when aligning blocks of text to the left by means of class attribute.

Default: align-left

Note: This property is also used for text aligment in table operations.

buttons.center.useClass

Property

buttons.center.useClass

Data type

string

Description

Class name to be used when centering blocks of text by means of class attribute.

Default: align-center

Note: This property is also used for text aligment in table operations.

buttons.right.useClass

Property

buttons.right.useClass

Data type

string

Description

Class name to be used when aligning blocks of text to the right by means of class attribute.

Default: align-right

Note: This property is also used for text aligment in table operations.

buttons.justifyfull.useClass

Property

buttons.justifyfull.useClass

Data type

string

Description

Class name to be used when justifying blocks of text to both left and right by means of class attribute.

Default: align-justify

Note: This property is also used for text aligment in table operations.

buttons.left.useAlignAttribute

Property

buttons.left.useAlignAttribute

buttons.center.useAlignAttribute

buttons.right.useAlignAttribute

buttons.justifyfull.useAlignAttribute

Data type

boolean

Description

If anyone of these four properties is set, alignment will be produced by means of align attributes instead of class attributes.

Default: 0

buttons.blockstyle.tags.[ tag-name ].allowedClasses

Property

buttons.blockstyle.tags.[ tag-name ].allowedClasses

Data type

list of id-strings

Description

Specifies the classes allowed for the block element identified by the tag name. Any string in the list may contain wild card characters. The wild card character is “*” and stands for any sequence of characters.

The classes must also be defined, using the specific tag selector, in the CSS file specified by the contentCSS property.

If the property is empty for any tag, classes associated with the given tag in the contentCSS file are used.

The classes are presented in the drop-down list in alphabetical order in the language used by the backend user.

buttons.blockstyle.tags.all.allowedClasses

Property

buttons.blockstyle.tags.all.allowedClasses

Data type

list of id-strings

Description

Specifies the classes allowed for all block elements, in addition to the classes allowed for each specific element (see above).

The classes must also be defined, without any tag selector, in the CSS file specified contentCSS property.

The classes are presented in the drop-down list in alphabetical order in the language used by the backend user.

buttons.blockstyle.showTagFreeClasses

Property

buttons.blockstyle.showTagFreeClasses

Data type

boolean

Description

Specifies that classes not associated with any tag in the contentCSS style sheet should be or should not be shown in the block style drop- down list.

Default: 0

buttons.blockstyle.prefixLabelWithClassName

Property

buttons.blockstyle.prefixLabelWithClassName

Data type

boolean

Description

If set, the option name in the block style drop-down list is prefixed with the class name.

Default: 0

buttons.blockstyle.postfixLabelWithClassName

Property

buttons.blockstyle.postfixLabelWithClassName

Data type

boolean

Description

If set, the option name e in the block style drop-down list is postfixed with the class name.

Default: 0

buttons.blocktstyle.disableStyleOnOptionLabel

Property

buttons.blocktstyle.disableStyleOnOptionLabel

Data type

boolean

Description

If set, the styling is removed on the options block styling drop-down list.

Default: 0

See value property of RTE.classes array.

buttons.formattext.orderItems

Property

buttons.formattext.orderItems

Data type

list of id-strings

Description

Specifies the order in which the options, or inline element types, are presented in the text formating drop-down list.

If not set, the default order will be alphabetical, in the language of the current backend user.

buttons.formattext.removeItems

Property

buttons.formattext.removeItems

Data type

list of id-strings

Description

List of options to be removed from the text formating drop-down list using same names as toolbar elements.

buttons.formattext.prefixLabelWithTag

Property

buttons.formattext.prefixLabelWithTag

Data type

boolean

Description

If set, the option name in the text formating drop-down list is prefixed with the tagname.

Default: 0

buttons.formattext.postfixLabelWithTag

Property

buttons.formattext.postfixLabelWithTag

Data type

boolean

Description

If set, the option name e in the text formating drop-down list is postfixed with the tagname.

Default: 0

buttons.textstyle.tags.[ tag-name ].allowedClasses

Property

buttons.textstyle.tags.[ tag-name ].allowedClasses

Data type

list of id-strings

Description

Specifies the classes allowed for each inline element (tag) in the text styling drop-down list. Any string in the list may contain wild card characters. The wild card character is “*” and stands for any sequence of characters.

Supported tags are: abbr, acronym, b, bdo, big, cite, code, del, dfn, em, i, ins, kbd, q, samp, small, span, strike, strong, sub, sup, tt, u, var

The classes must also be defined in the CSS file specified by contentCSS property.

If the property is empty for any tag, classes associated with the given tag in the contentCSS file are used.

The classes are presented in the textstyle drop-down list in alphabetical order in the language used by the backend user.

buttons.textstyle.tags.all.allowedClasses

Property

buttons.textstyle.tags.all.allowedClasses

Data type

list of id-strings

Description

Specifies the classes allowed for all inline elements, in addition to the classes allowed for each specific element (see above).

The classes must also be defined in the CSS file specified by contentCSS property.

The classes are presented in the drop-down list in alphabetical order in the language used by the backend user.

buttons.textstyle.showTagFreeClasses

Property

buttons.textstyle.showTagFreeClasses

Data type

boolean

Description

Specifies that classes not associated with any tag in the contentCSS style sheet should be or should not be shown in the text styling drop- down list.

Default: 0

buttons.textstyle.prefixLabelWithClassName

Property

buttons.textstyle.prefixLabelWithClassName

Data type

boolean

Description

If set, the option name in the text styling drop-down list is prefixed with the class name.

Default: 0

buttons.textstyle.postfixLabelWithClassName

Property

buttons.textstyle.postfixLabelWithClassName

Data type

boolean

Description

If set, the option name e in the text styling drop-down list is postfixed with the class name.

Default: 0

buttons.textstyle.disableStyleOnOptionLabel

Property

buttons.textstyle.disableStyleOnOptionLabel

Data type

boolean

Description

If set, the styling is removed on the options text styling drop-down list.

Default: 0

See value property of RTE.classes array.

buttons.language.restrictToItems

Property

buttons.language.restrictToItems

Data type

list of strings

Description

List of language ISO codes to which the language marking drop-down list is limited to.

Note: If not set, all languages found in the static_languages table will appear in the drop-down list.

buttons.language.useLangAttribute

Property

buttons.language.useLangAttribute

Data type

boolean

Description

If set, the lang attribute is used fro language marks.

Default: 1

Note: If both useLangAttribute and useXmlLangAttribute are unset, the lang attribute will be used.

buttons.language.useXmlLangAttribute

Property

buttons.language.useXmlLangAttribute

Data type

boolean

Description

If set, the xml:lang attribute is used fro language marks.

Default: 0

buttons.language.prefixLabelWithCode

Property

buttons.language.prefixLabelWithCode

Data type

boolean

Description

If set, the option name e in the language marking drop-down list is prefixed with the language ISO code.

Default: 0

buttons.language.postfixLabelWithCode

Property

buttons.language.postfixLabelWithCode

Data type

boolean

Description

If set, the option name e in the language marking drop-down list is postfixed with the language ISO code.

Default: 0

buttons.spellcheck.enablePersonalDictionaries

Property

buttons.spellcheck.enablePersonalDictionaries

Data type

boolean

Description

If set, personal dictionaries are enabled.

Default: 0

Note: The feature must also be enabled in User TSconfig.

Note: Personal dictionaries are stored in subdirectories of uploads/tx_rtehtmlarea

buttons.spellcheck.dictionaries.restrictToItems

Property

buttons.spellcheck.dictionaries.restrictToItems

Data type

list-of-id-strings

Description

List of Aspell dictionary codes to which the drop-down list of dictionaries is limited in the spell checker dialogue.

Note: If not set, all dictionaries obtained from Aspell will appear in the drop-down list.

buttons.spellcheck.dictionaries.[ language-iso-code ].defaultValue

Property

buttons.spellcheck.dictionaries.[ language-iso-code ].defaultValue

Data type

string

Description

Aspell dictionary code of the dictionary to be used by default to spell check a content element in the language specified by the ISO code. The specified dictionary will be pre-selected in the drop-down list of dictionaries.

Default: the language ISO code.

buttons.image.TYPO3Browser.disabled

Property

buttons.image.TYPO3Browser.disabled

Data type

boolean

Description

If set, the TYPO3 image browser is disabled.

Default: 0

Note: The TYPO3 image browser is never available when the editor is used in the frontend.

buttons.image.options.imageHandler

Property

buttons.image.options.imageHandler

Data type

array

Description

Configuration of available image handlers.

Extension developers may add their own handler by adding their own entry to this array. The syntax is:

For a detailed description of the options, please refer to the link handler documentation.

buttons.image.options.magic.maxWidth

Property

buttons.image.options.magic.maxWidth

Data type

int+

Description

Maximum width of a magic image in pixels at the time of its initial insertion.

Default: 300

Note: The width of the magic image may be made larger when updating the image properties. However, the image is not recreated, only its HTML width attribute is updated.

buttons.image.options.magic.maxHeight

Property

buttons.image.options.magic.maxHeight

Data type

int+

Description

Maximum height of a magic image in pixels at the time of its initial insertion.

Default: 1000

Note: By setting a large enough height, images should be resized based on their width.

Note: The height of the magic image may be made larger when updating the image properties. However, the image is not recreated, only its HTML height attribute is updated.

buttons.image.options.plain.maxWidth

Property

buttons.image.options.plain.maxWidth

Data type

int+

Description

Maximum width of selectable plain images in pixels.

Default: 640

buttons.image.options.plain.maxHeight

Property

buttons.image.options.plain.maxHeight

Data type

int+

Description

Maximum height of selectable plain images in pixels.

Default: 680

buttons.image.properties.removeItems

Property

buttons.image.properties.removeItems

Data type

list of strings

Description

List of properties to remove from the image properties editing window. Key list is align, alt, border, class, clickenlarge, float, height, paddingTop, paddingRight, paddingBottom, paddingLeft, title, width

Note: When a plain image is edited, if proc.plainImageMode is set to lockDimentions, lockRatio or lockRatioWhenSmaller, the height property is removed from the properties window. If proc.plainImageMode is set to lockDimensions, both the width and height properties are removed.

buttons.image.properties.class.allowedClasses

Property

buttons.image.properties.class.allowedClasses

Data type

list of id-strings

Description

Classes available in the Insert/Modify image dialogue.

Each of the listed classes must be defined in the CSS file specified by the contentCSS property.

buttons.image.properties.class.default

Property

buttons.image.properties.class.default

Data type

string

Description

Class to be assigned by default to an image when it is inserted in the RTE.

buttons.abbreviation.pages

Property

buttons.abbreviation.pages

Data type

list of page id’s

Description

List of page id’s from which to obtain the abbreviation records.

Note: If not set, the list of current webmounts is used.

Note: In IE, before IE7, the abbreviation tab of the abbreviation dialogue is never shown.

buttons.abbreviation.recursive

Property

buttons.abbreviation.recursive

Data type

int

Description

The number of levels in the page tree, under each page listed in buttons.abbreviation.pages or under each webmount, from which abbreviations are retrieved.

Default: 0

buttons.abbreviation.lockBeUserToDBmounts

Property

buttons.abbreviation.lockBeUserToDBmounts

Data type

boolean

Description

If set, the pid’s listed under buttons.abbreviation.pages (see above) are validated against the user’s current webmounts.

If not set or if the user is admin, buttons.abbreviation.pages is ignored and abbreviations from all pages are retrieved.

Default: The default value of this property is the value of the property with same name in the backend section of theTYPO3 configuration as set by the Install Tool.

buttons.abbreviation.removeFieldsets

Property

buttons.abbreviation.removeFieldsets

Data type

list of strings

Description

List of fieldsets to remove from the abbreviation dialogue.

Possible string values are: acronym, definedAcronym, abbreviation, definedAbbreviation

buttons.acronym.pages

Property

This property is deprecated. Use buttons.abbreviation.pages

buttons.acronym.recursive

Property

This property is deprecated. Use buttons.abbreviation.recursive

buttons.acronym.lockBeUserToDBmounts

Property

This property is deprecated. Use buttons.abbreviation.lockBeUserToDBmounts

disableColorPicker

Property

disableColorPicker

Data type

boolean

Description

Disables the color picker matrix in all color dialogs. The color picker lets you select web-colors.

buttons.fontstyle.removeItems

Property

buttons.fontstyle.removeItems

Data type

list of id-numbers,

* removes all

Description

Lets you remove any of the default font faces in the Font Style selector. Values are ranging from 1 to 9. These are the possible options, and their respective name => value pairs, that you can remove:

1: Arial => Arial,sans-serif

2: Arial Black => ‘Arial Black’,sans-serif

3: Verdana => Verdana,Arial,sans-serif

4: ‘Times New Roman’ => ‘Times New Roman’,Times,serif

5: Garamond => Garamond

6: Lucida Handwriting => Lucida Handwriting

7: Courier => Courier

8: Webdings => Webdings

9: Wingdings => Wingdings

buttons.fontstyle.addItems

Property

buttons.fontstyle.addItems

Data type

list of id-strings

Description

Defines additional fonts available in the font selector. The id- strings must be configured in the RTE.fonts array (see description earlier).

buttons.fontstyle.defaultItem

Property

buttons.fontstyle.defaultItem

Data type

string

Description

Specifies the name of the default font style. The name is the name of one of the default font faces, or the name associated to one of fonts configured in the RTE.fonts array (see description earlier).

Note: The value associated to the default font style should be exactly the same as the value of the default font-family property specified in the site style sheet as referred to by property RTE.default.contentCSS.

buttons.fontsize.removeItems

Property

buttons.fontsize.removeItems

Data type

list of size-numbers,

* removes all

Description

Lets you disable any of the default font sizes available in the Font Size selector. Values are ranging from 1 to 7. These are the possible options, and their respective name => value pairs, that you can remove:

1: Extra small => 8px

2: Very small => 9px

3: Small => 10px

4: Medium => 12px

5: Large => 16px

6: Very large => 24px

7: Extra large => 32px

buttons.fontsize.addItems

Property

buttons.fontsize.addItems

Data type

list of id-strings

Description

Defines additional font sizes available in the font size selector. The id-strings must be configured in the RTE.fontSizes array (see description earlier).

buttons.fontsize.defaultItem

Property

buttons.fontsize.defaultItem

Data type

string

Description

Specifies the name of the default font size. The name is the name of one of the default font sizes, or the name associated to one of font sizes configured in the RTE.fontSizes array (see description earlier).

Note: The value associated to the default font size should be exactly the same as the value of the default font-size property specified in the site style sheet as referred to by property RTE.default.contentCSS. For correct behaviour in non-IE browsers, the value of the default font size should be specified in px units.

hideTableOperationsInToolbar

Property

hideTableOperationsInToolbar

Data type

boolean

Description

Specifies that table operations buttons should be hidden in the tool bar or not.

Default: 0

Note: If enabled, table operations will appear only in the context menu, provided that they may be enabled in the given context.

buttons.toggleborders.keepInToolbar

Property

buttons.toggleborders.keepInToolbar

Data type

boolean

Description

If set, the toggleborders button will be kept in the tool bar even if property hideTableOperationsInToolbar is set.

Default: 0

buttons.toggleborders.setOnTableCreation

Property

buttons.toggleborders.setOnTableCreation

Data type

boolean

Description

If set, and if the toggleborders button is enabled, the table borders will be toggled on when a new table is created.

Default : 0

buttons.toggleborders.setOnRTEOpen

Property

buttons.toggleborders.setOnRTEOpen

Data type

boolean

Description

If set, and if the toggleborders button is enabled, the table borders will be toggled on when the RTE opens.

Default : 0

buttons.[ button-name ].hotKey

Property

buttons.[ button-name ].hotKey

Data type

character

Description

A hotkey will be associated with the specified button-name.

Note: Care should be taken that the hotkey does not conflict with pre- defined hotkeys. If it does, the hotkey will override any previously registered hotkey.

buttons.[ button-name ].width

Property

buttons.[ button-name ].width

Data type

int+

Description

The width of the field in the toolbar when the button is a dropdown list.

buttons.[ button-name ].listWidth

Property

buttons.[ button-name ].listWidth

Data type

int+

Description

The width of the dropdown list when the button is a dropdown list.

Defauls to the width of the field in the toolbar.

buttons.[ button-name ].maxHeight

Property

buttons.[ button-name ].maxHeight

Data type

int+

Description

The maximum height of the dropdown list when the button is a dropdown list.

buttons.[ button-name ].dialogueWindow.width

Property

buttons.[ button-name ].dialogueWindow.width

Data type

int+

Description

The opening width of the dialogue window opened when the button is pressed.

buttons.[ button-name ].dialogueWindow.height

Property

buttons.[ button-name ].dialogueWindow.height

Data type

int+

Description

The opening height of the dialogue window opened when the button is pressed.

buttons.[ button-name ].dialogueWindow.positionFromTop

Property

buttons.[ button-name ].dialogueWindow.positionFromTop

Data type

int+

Description

The opening position from the top of the screen of the dialogue window opened when the button is pressed.

buttons.[ button-name ].dialogueWindow.positionFromLeft

Property

buttons.[ button-name ].dialogueWindow.positionFromLeft

Data type

int+

Description

The opening position from the left of the screen of the dialogue window opened when the button is pressed.

buttons.[ button-name ].dialogueWindow.doNotResize

Property

buttons.[ button-name ].dialogueWindow.doNotResize

Data type

boolean

Description

If set, the window that is opened when the button is pressed will not be resized to its contents.

Default: 0

buttons.[ button-name ].dialogueWindow.doNotCenter

Property

buttons.[ button-name ].dialogueWindow.doNotCenter

Data type

boolean

Description

If set, the window that is opened when the button is pressed will not be centered in the parent window.

Default: 0

skin

Property

skin

Data type

resource

Description

The skin contains the CSS files and the images used to style the editor.

The skin is specified by specifying the location of the main CSS file to be used to style the editor. The folder containing the CSS file MUST also contain a structure of folders and files identical to the structure found in the folder of the default skin. All folder names and all file names must be identical.

Default: EXT:rtehtmlarea/htmlarea/skins/default/htmlarea.css

Note: these example skins do not work in Mozilla 1.3; if the property is set to one of them, the default skin will be used when the browser is Mozilla 1.3.

contentCSS

Property

contentCSS contentCSS.[id-string]

Data type

resource(s)

Description

The CSS file that contains the style definitions that should be applied to the edited contents.

The selectors defined in this file will also be used in the block style and text style selection lists.

Default: EXT:rtehtmlarea/res/contentcss/default.css

For example, this default could be overridden with: fileadmin/styles/my_contentCSS.css

Multiple files may be specified by using contentCSS.[id-string]. For example:

contentCSS {
    file1 = fileadmin/myStylesheet1.css
    file2 = fileadmin/myStylesheet2.css
}

proc

Property

proc

Data type

->PROC

Description

Customization of the server processing of the content - also called ‘transformations’.

See RTE Transformations

enableWordClean

Property

enableWordClean

Data type

boolean

Description

Specifies that text pasted from external sources, presumably from Microsoft Word, should be “cleaned” or not.

Default: 0

Note:If no HTMLparser configuration is specified, a limited default cleaning operation will be performed. If a HTMLparser specification is specified, parsing will be performed on the server at the time of the paste operation.

Note: Additional cleanup may be performed by the user when the removeformat button is enabled.

Note: Cleaning on paste cannot be performed in Opera.

Note: The same cleaning operation is performed with hotkey CTRL+0, including in Opera.

enableWordClean.HTMLparser

Property

enableWordClean.HTMLparser

Data type

boolean/

->HTMLparser

Description

HTMLparser specification use by the enableWordClean feature.

Default: 0

Note:If no HTMLparser configuration is specified, a limited default cleaning operation will be performed. If a HTMLparser specification is specified, parsing will be performed on the server at the time of the paste operation.

Note: If an HTMLparser configuration is specified, care should be taken that span tags with id attribute are not removed by the cleaning operation. If they are removed, the cursor position will not be restored in non-IE browsers after the paste operation, and the cursor will then be positionned at the start of the text.

enableWordClean.hotKey

Property

enableWordClean.hotKey

Data type

character

Description

The default hotkey of the cleaning operation, CTRL+0, is replaced by CTRL+the specified character.

removeComments

Property

removeComments

Data type

boolean

Description

Specifies that html comments should be removed or not by the editor on save and on toggle to HTML source mode.

Default: 0

removeTags

Property

removeTags

Data type

list of tags

Description

List of tags that should be removed by the editor on save and on toggle to HTML source mode.

removeTagsAndContents

Property

removeTagsAndContents

Data type

list of tags

Description

List of tags that should be removed by the editor, contents included, on save and on toggle to HTML source mode. The tags and the contents inside the tags will be removed.

customTags

Property

customTags

Data type

list of tags

Description

List of custom tags that may appear in content.

Note: When IE is used with standards mode older than IE9, custom tags are not correctly handle. This list of custom tags is then used to let them be known to IE so that they are correctly handled by this browser.

useCSS

Property

useCSS

Data type

boolean

Description

Specifies that Mozilla/Firefox should use style attributes or not. When enabled, Mozilla/Firefox use span tags with style attributes rather than tags such as b, i, font, etc.

Default: 0

disableEnterParagraphs

Property

disableEnterParagraphs

Data type

boolean

Description

Specifies that the insertion of paragraphs when hitting the Enter key in Mozilla/Firefox and Safari should be disabled.

Default: 0

Note: If NOT enabled, the behavior of Mozilla/Firefox and Safari is modified as follows: when the Enter key is pressed, instead of inserting a br tag, the behavior of Internet Explorer is simulated and a new paragraph is created.

Note: If enabled, the behavior of Mozilla/Firefox and Safari is not modified: a br tag is inserted when the Enter key is pressed.

disableObjectResizing

Property

disableObjectResizing

Data type

boolean

Description

Specifies that Mozilla/Firefox should not provide handles for resizing objects such as images and tables.

Default: 0

removeTrailingBR

Property

removeTrailingBR

Data type

boolean

Description

Specifies that trailing br tags should be removed from block elements.

Default: 0

Note: If set, any trailing br tag in a block element will be removed on save and/or change mode. However, multiple trailing br tags will be preserved.

Note: In Mozilla/Firefox/Netscape, whenever some text is entered in an empty block, a trailing br tag is added by the browser.

buttons.inserttag.denyTags

Property

buttons.inserttag.denyTags

Data type

list of tags

Description

List of tag names that should NOT be shown by the dialog of the inserttag button.

Note: Listed tag names should be among the following: a, abbr, acronym, address, b, big, blockquote, cite, code, div, em, fieldset, font, h1, h2, h3, h4, h5, h6, i, legend, li, ol, p, pre, q, small, span, strong, sub, sup, table, tt, ul

buttons.inserttag.allowedAttribs

Property

buttons.inserttag.allowedAttribs

Data type

list of attributes

Description

List of attribute names that should be shown for all tags in the dialog of the inserttag button.

Note: Listed attribute names should be among the following: class, dir, id, lang, onFocus, onBlur, onClick, onDblClick, onMouseDown, onMouseUp, onMouseOver, onMouseMove, onMouseOut, onKeyPress, onKeyDown, onKeyUp, style, title, xml:lang

buttons.inserttag.tags. [tagname] .allowedAttribs

Property

buttons.inserttag.tags. [tagname] .allowedAttribs

Data type

list of attributes

Description

List of attribute names that should be shown for the specified tagname in the dialog of the inserttag button, in addition to the attribute names specified by property buttons.inserttag.allowedAttribs.

buttons.table.disableEnterParagraphs

Property

buttons.table.disableEnterParagraphs

Data type

boolean

Description

If set, this property will prevent the insertion of paragraphs in table cells when the enter key is pressed.

Default: 0

buttons.table.enableHandles

Property

buttons.table.enableHandles

Data type

boolean

Description

If set, table handles will be enabled in Firefox. These Firefox- specific handles allow to delete/insert rows and columns using small handles displayed on table borders. However, insert operations also add a style attribute on inserted cells.

Default: 0

disableAlignmentFieldsetInTableOperations

Property

disableAlignmentFieldsetInTableOperations

disableSpacingFieldsetInTableOperations

disableColorFieldsetInTableOperations

disableLayoutFieldsetInTableOperations

disableBordersFieldsetInTableOperations

Data type

boolean

Description

Disables the corresponding fieldset in all table operations dialogues.

Default: 0

buttons.table.removeFieldsets

Property

buttons.table.removeFieldsets

Data type

list of strings

Description

List of fieldsets to remove from the table creation dialogue. Key list is alignment, borders, color, description, language, layout, spacing, style

buttons.tableproperties.removeFieldsets

Property

buttons.tableproperties.removeFieldsets

Data type

list of strings

Description

List of fieldsets to remove from the table properties edition dialogue. Key list is alignment, borders, color, description, language, layout, spacing, style

buttons.table.properties.required

Property

buttons.table.properties.required

Data type

list of strings

Description

List of fields for which a value is required in the table creation and table properties edition dialogues. Possible values are: caption, summary, captionOrSummary

buttons.table.properties.removed

Property

buttons.table.properties.removed

Data type

list of strings

Description

List of fields to remove from the table creation and table properties edition dialogues. Possible values are: width, height, float, headers, language, direction

buttons.table.properties.numberOfRows.defaultValue

Property

buttons.table.properties.numberOfRows.defaultValue

Data type

int+

Description

Default value for the number of rows to include in a table on creation.

Default: 2

buttons.table.properties.numberOfColumns.defaultValue

Property

buttons.table.properties.numberOfColumns.defaultValue

Data type

int+

Description

Default value for the number of columns to include in a table on creation.

Default: 4

buttons.table.properties.headers.defaultValue

Property

buttons.table.properties.headers.defaultValue

Data type

string

Description

Default selected option in the headers layout selector in the table creation dialogue. Possible values are: none, top, left, both

Default: top

buttons.table.properties.headers.removeItems

Property

buttons.table.properties.headers.removeItems

Data type

list of strings

Description

List of items to remove from the headers layout selector in the table creation dialogue. Key list is: none, top, left, both

Default: void

buttons.table.properties.headers.both.useHeaderClass

Property

buttons.table.properties.headers.both.useHeaderClass

Data type

list of strings

Description

A class to be assigned to the top row when the headers property specifies both.

Default: thead

buttons.table.properties.tableClass.defaultValue

Property

buttons.table.properties.tableClass.defaultValue

Data type

string

Description

Default selected class in the table class selector in the table creation dialogue.

Default: void

buttons.table.properties.width.defaultValue

Property

buttons.table.properties.width.defaultValue

Data type

+int

Description

Default value of the table wdth in the table creation dialogue.

Default: void

buttons.table.properties.widthUnit.defaultValue

Property

buttons.table.properties.widthUnit.defaultValue

Data type

string

Description

Default selected unit in the width unit selector in the table creation dialogue. Possible values are: %, px or em

Default: %

buttons.table.properties.widthUnit.removeItems

Property

buttons.table.properties.widthUnit.removeItems

Data type

list of strings

Description

List of items to remove from the table width unit selector in the table creation dialogue. Key list is: %, px, em

Default: void

buttons.table.properties.height.defaultValue

Property

buttons.table.properties.height.defaultValue

Data type

+int

Description

Default value of the table height in the table creation dialogue.

Default: void

buttons.table.properties.heightUnit.defaultValue

Property

buttons.table.properties.heightUnit.defaultValue

Data type

string

Description

Default selected unit in the height unit selector in the table creation dialogue. Possible values are: %, px or em

Default: %

buttons.table.properties.heightUnit.removeItems

Property

buttons.table.properties.heightUnit.removeItems

Data type

list of strings

Description

List of items to remove from the table height unit selector in the table creation dialogue. Key list is: %, px, em

Default: void

buttons.table.properties.float.defaultValue

Property

buttons.table.properties.float.defaultValue

Data type

string

Description

Default selected option in the table float selector in the table creation and properties edition dialogues.. Possible values are: not set, left, right

Default: not set

buttons.table.properties.float.left.useClass

Property

buttons.table.properties.float.left.useClass

Data type

string

Description

Class name to be assigned when left is selected in the table float selector in the table creation and properties edition dialogues.

Default: float-left

buttons.table.properties.float.right.useClass

Property

buttons.table.properties.float.right.useClass

Data type

string

Description

Class name to be assigned when right is selected in the table float selector in the table creation and properties edition dialogues.

Default: float-right

buttons.table.properties.float.removeItems

Property

buttons.table.properties.float.removeItems

Data type

list of strings

Description

List of items to remove from the table float selector in the table creation and properties edition dialogues. Key list is: not set, left, right

Default: void

buttons.table.properties.cellpadding.defaultValue

Property

buttons.table.properties.cellpadding.defaultValue

Data type

+int

Description

Default value of the table cellpadding attribute in the table creation and properties edition dialogues

Default: void

buttons.table.properties.cellspacing.defaultValue

Property

buttons.table.properties.cellspacing.defaultValue

Data type

+int

Description

Default value of the table cellspacing attribute in the table creation and properties edition dialogues .

Default: void

buttons.table.properties.borderWidth.defaultValue

Property

buttons.table.properties.borderWidth.defaultValue

Data type

+int

Description

Default value of the table border width attribute in the table creation and properties edition dialogues

Default: void

buttons.table.properties.borderStyle.defaultValue

Property

buttons.table.properties.borderStyle.defaultValue

Data type

string

Description

Default selected style in the border style selector in the table creation dialogue. Possible values are: not set, none, dotted, dashed, solid, double, groove, ridge, inset, outset

Default: not set

buttons.table.properties.borderStyle.removeItems

Property

buttons.table.properties.borderStyle.removeItems

Data type

list of strings

Description

List of items to remove from the table border style selector in the table creation dialogue. Key list is: not set, none, dotted, dashed, solid, double, groove, ridge, inset, outset

Default: void

buttons.rowproperties.removeFieldsets

Property

buttons.rowproperties.removeFieldsets

Data type

list of strings

Description

List of fieldsets to remove from the table row properties edition dialogue. Key list is alignment, borders, color, language, layout, rowgroup, style

Default: void

buttons.rowproperties.properties.removed

Property

buttons.rowproperties.properties.removed

Data type

list of strings

Description

List of fields to remove from the table row properties edition dialogue. Possible values are: width, height, language, direction

Default: void

buttons.rowproperties.properties.width.defaultValue

Property

buttons.rowproperties.properties.width.defaultValue

Data type

+int

Description

Default value of the row wdth in the table row properties edition dialogue.

Default: void

buttons.rowproperties.properties.widthUnit.defaultValue

Property

buttons.rowproperties.properties.widthUnit.defaultValue

Data type

string

Description

Default selected unit in the row width unit selector in the table row properties edition dialogue. Possible values are: %, px or em

Default: %

buttons.rowproperties.properties.widthUnit.removeItems

Property

buttons.rowproperties.properties.widthUnit.removeItems

Data type

list of strings

Description

List of items to remove from the row width unit selector in the table row properties edition dialogue. Key list is: %, px, em

Default: void

buttons.rowproperties.properties.height.defaultValue

Property

buttons.rowproperties.properties.height.defaultValue

Data type

+int

Description

Default value of the row height in the table row properties edition dialogue.

Default: void

buttons.rowproperties.properties.heightUnit.defaultValue

Property

buttons.rowproperties.properties.heightUnit.defaultValue

Data type

string

Description

Default selected unit in the row height unit selector iin the table row properties edition dialogue. Possible values are: %, px or em

Default: %

buttons.rowproperties.properties.heightUnit.removeItems

Property

buttons.rowproperties.properties.heightUnit.removeItems

Data type

list of strings

Description

List of items to remove from the row height unit selector in the table row properties edition dialogue. Key list is: %, px, em

Default: void

buttons.rowproperties.properties.borderStyle.removeItems

Property

buttons.rowproperties.properties.borderStyle.removeItems

Data type

list of strings

Description

List of items to remove from the row border style selector in the table row properties edition dialogue. Key list is: not set, none, dotted, dashed, solid, double, groove, ridge, inset, outset

Default: void

buttons.columnproperties.removeFieldsets

Property

buttons.columnproperties.removeFieldsets

Data type

list of strings

Description

List of fieldsets to remove from the column cells properties edition dialogue. Key list is alignment, borders, color, language, layout, style

buttons.cellproperties.removeFieldsets

Property

buttons.cellproperties.removeFieldsets

Data type

list of strings

Description

List of fieldsets to remove from the cell properties edition dialogue. Key list is alignment, borders, color, language, layout, style

buttons.cellproperties.properties.removed

Property

buttons.cellproperties.properties.removed

Data type

list of strings

Description

List of fields to remove from the cell properties and column cells properties edition dialogues. Possible values are: width, height, language, direction

Default: void

buttons.cellproperties.properties.width.defaultValue

Property

buttons.cellproperties.properties.width.defaultValue

Data type

+int

Description

Default value of the row wdth in the cell properties and column cells properties edition dialogues.

Default: void

buttons.cellproperties.properties.widthUnit.defaultValue

Property

buttons.cellproperties.properties.widthUnit.defaultValue

Data type

string

Description

Default selected unit in the row width unit selector in the cell properties and column cells properties edition dialogues. Possible values are: %, px or em

Default: %

buttons.cellproperties.properties.widthUnit.removeItems

Property

buttons.cellproperties.properties.widthUnit.removeItems

Data type

list of strings

Description

List of items to remove from the row width unit selector in the cell properties and column cells properties edition dialogues. Key list is: %, px, em

Default: void

buttons.cellproperties.properties.height.defaultValue

Property

buttons.cellproperties.properties.height.defaultValue

Data type

+int

Description

Default value of the row height in the cell properties and column cells properties edition dialogues.

Default: void

buttons.cellproperties.properties.heightUnit.defaultValue

Property

buttons.cellproperties.properties.heightUnit.defaultValue

Data type

string

Description

Default selected unit in the row height unit selector in the cell properties and column cells properties edition dialogues. Possible values are: %, px or em

Default: %

buttons.cellproperties.properties.heightUnit.removeItems

Property

buttons.cellproperties.properties.heightUnit.removeItems

Data type

list of strings

Description

List of items to remove from the row height unit selector in the cell properties and column cells properties edition dialogues. Key list is: %, px, em

Default: void

buttons.cellproperties.properties.borderStyle.removeItems

Property

buttons.cellproperties.properties.borderStyle.removeItems

Data type

list of strings

Description

List of items to remove from the cell border style selector in the cell properties and column cells properties edition dialogues. Key list is: not set, none, dotted, dashed, solid, double, groove, ridge, inset, outset

Default: void

buttons.pastetoggle.setActiveOnRteOpen

Property

buttons.pastetoggle.setActiveOnRteOpen

Data type

boolean

Description

If set, and if the pastetoggle button is enabled, the button is toggled to ON when the RTE opens.

Default : 0

buttons.pastetoggle.hidden

Property

buttons.pastetoggle.hidden

Data type

boolean

Description

If set, and if the pastetoggle button is enabled, the button is hidden in both the toolbar and the context menu. Hence, if buttons.pastetoggle.setActiveOnRteOpen is also set, all paste operations will be performed using the set clean paste behaviour.

Default : 0

Note: For BE operations, the default or overriding clean paste behaviour may be set in User TSconfig.

buttons.pastebehaviour.[ behaviour ].keepTags

Property

buttons.pastebehaviour.[ behaviour ].keepTags

Data type

list of strings

Description

List of tags to be kept when pasting content while the specified behaviour is enabled. The behaviour may be pasteStructure or pasteFormat.

Default:

- for pasteStructure: a, p, h[0-6], pre, address, article, aside, blockquote, div, footer, header, nav, section, hr, br, table, thead, tbody, tfoot, caption, tr, th, td, ul, ol, dl, li, dt, dd

- for pasteFormat: a, p, h[0-6], pre, address, article, aside, blockquote, div, footer, header, nav, section, hr, br, table, thead, tbody, tfoot, caption, tr, th, td, ul, ol, dl, li, dt, dd, b, bdo, big, cite, code, del, dfn, em, i, ins, kbd, label, q, samp, small, strike, strong, sub, sup, tt, u, var

buttons.pastebehaviour.[ behaviour ].removeAttributes

Property

buttons.pastebehaviour.[ behaviour ].removeAttributes

Data type

list of strings

Description

List of attributes to be removed from all tags when pasting content while the specified behaviour is enabled. The behaviour may be pasteStructure or pasteFormat.

Default:

- for pasteStructure: id, on*, style, class, className, lang, align, valign, bgcolor, color, border, face, .*:.*

- for pasteFormat: id, on*, style, class, className, lang, align, valign, bgcolor, color, border, face, .*:.*

RTEHeightOverride

Property

RTEHeightOverride

Data type

int+

Description

If set, the specified value will override the calculated height of the RTE. This includes the height of the toolbar, of the editing area and of the status bar.

See also User TSconfig options.RTESmallHeight and options.RTELargeHeightIncrement

Note: This property may be overridden by the BE user configuration. See User TSconfig.

RTEWidthOverride

Property

RTEWidthOverride

Data type

int+/%

Description

If set, the specified value will override the calculated width of the RTE editing area. Note that a percentage may be specified.

Note: The property is ignored in IE if the value is a percentage.

Note: This property may be overridden by the BE user configuration. See User TSconfig.

rteResize

Property

rteResize

Data type

boolean

Description

If set, the RTE is resizable.

Default: 0

Note: This property may be overridden by the BE user configuration. See User TSconfig.

rteMaxHeight

Property

rteMaxHeight

Data type

int+

Description

If the RTE is resizable, this is the maximal height of the RTE, including the tool bar, the editing area and the status bar.

Default: 2000

Note: This property may be overridden by the BE user configuration. See User TSconfig.

dialogueWindows.defaultPositionFromTop

Property

dialogueWindows.defaultPositionFromTop

Data type

int+

Description

The default opening position from the top of the screen of a dialogue window opened when a button is pressed.

Note: May be averridden by a specific button configuration.

dialogueWindows.defaultPositionFromLeft

Property

dialogueWindows.defaultPositionFromLeft

Data type

int+

Description

The default opening position from the left of the screen of a dialogue window opened when a button is pressed.

Note: May be averridden by a specific button configuration.

dialogueWindows.doNotResize

Property

dialogueWindows.doNotResize

Data type

boolean

Description

If set, the window that is opened when any button is pressed will not be resized to its contents.

Default: 0

dialogueWindows.doNotCenter

Property

dialogueWindows.doNotCenter

Data type

boolean

Description

If set, the window that is opened when any button is pressed will not be centered in the parent window.

Default: 0

userElements.[#]

Property

userElements.[#]

Data type

string/->userCategory

Description

Configuration of the categories of user elements

The string value sets the name of the category. Value is language- splitted (by |) to allow for multiple languages.

logDeprecatedProperties.disabled

Property

logDeprecatedProperties.disabled

Data type

boolean

Description

If set, usage of deprecated Page TS Config properties is not logged to the deprecation log.

Default: 0

logDeprecatedProperties.logAlsoToBELog

Property

logDeprecatedProperties.logAlsoToBELog

Data type

boolean

Description

If set, usage of deprecated Page TS Config properties is also logged to the BE log.

Default: 0

schema.sources.[#]

Property

schema.sources.[#]

Data type

array

Description

An array of filenames containing vocabulary definitions inXML/RDF format.

Default: schemaOrg = EXT:rtehtmlarea/extensions/MicrodataSchema/res/schemaOrgAll.rdf

[page:RTE.default/RTE.default.FE/RTE.config.(table).(field)/RTE.config .(table).(field).types.(type)]