classes.[classname]

Defines the classes available in the RTE. classname is the actual name of the style-class you're configuring. Notice you must specifically assign the classes to the various facilities also. See later.

Properties:

.name = Label of the class

.value = The style for the class

.noShow = Boolean; if set, the style of the class is not used to render it in the pop-up selector.

Example:

# General configuration of the available classes:

RTE.classes {

  mainBodyText {

    name = Body Text (Primary)

    value = font:bold; color:blue;

  }

}

# Specific configuration for the Character/Text Style menu:

RTE.default.classesCharacter = mainBodyText

colors.[id-string]

Defines the colors available in the RTE.

Properties:

.name = Label of the color in menu

.value = The HTML-color value

Example:

# General configuration of the available colors:

RTE.colors {

  color1 {

    name = Background color

    value = blue

  }

  color2 {

    name = Another color I like!

    value = #775533

  }

  noColor {

    name = No color

    value =

  }

}

# Specific setting for the font color selector:

RTE.default.colors = color1, color2, noColor

fonts.[id-string]

Defines the fonts available in the RTE.

Properties:

.name = Label of the font in menu

.value = The font face value

Example:

# General configuration of the available fonts:

RTE.fonts {

  face1 {

    name = Verdana

    value = verdana, arial

  }

  face2 {

    name = Comic Sans

    value = Comic Sans MS

  }

  noFace {

    name = No font

    value =

  }

}

# Specific setting for the fontstyle selector:

RTE.default.fontFace = face2 , face1, noFace

default.[...]

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

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

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.

disabled

boolean

If set, the editor is disabled.

classesParagraph

list of id-strings

Classes available in the Paragraph Style selector.

The Paragraph Style selector lets you format a block of content also known typographically as a paragraph (the section between two linebreaks). The content of the paragraph is wrapped in block-tags and by default you can select between <Hx>, <P> and <PRE> formatting (you can disable any or all of these default values by the 'hidePStyleItems', see later).

Example:

This configuration would result in this Paragraph style selector (provided that the classes 'mainBodyText' and 'header2' are found in the RTE.classes definition, see above):

RTE.default {

  classesParagraph = mainBodyText, header2

}

In the case of htmlArea RTE, the classes must be defined either in one of the occurrences of  the inlineStyle property or in the CSS file specified contentCSS property.

In the case of the Classic RTE, the classes defined in the 'classesParagraph' value are prepended to the types of paragraphs options. They are inserted as <DIV>-tags with a class-parameter.

classesCharacter

list of id-strings

Classes available for the Text Style selector.

The Character Style selector is used to format any string of text inside a paragraph, tablecell. So this formatting relates to the selected piece of text in opposition to the Paragraph Styles which always formats the current paragraph no matter the selection.

In the case of htmlArea RTE, the classes must be defined either in one of the occurrences of  the inlineStyle property or in the CSS file specified contentCSS property.

In the case of htmlArea RTE, if the property is empty, classes associated with the span tag in either the inlineSyle properties or in the contentCSS file are used.

In the case of the Classic RTE, although the Character Style selector is aimed at text-formatting, it will also apply classes to other elements, for instance tables or images if selected as well as links and table-cells. The allowed classes for these operations may be configured separately by listing the classes with the options, you find below.

showTagFreeClasses

(htmlArea RTE only)

boolean

Specifies that CSS classes  not associated with any tag in the contentCSS style sheet should be or should not be shown in the paragraph style and the text style selection lists.

Default: 0

disablePCexamples

boolean

If set, the examples of classes in Paragraph and Character selectors are disabled.

Note: In the case of htmlArea RTE, the styling is removed on the options of the Paragraph and Text style selector lists.

disableTYPO3Browsers

(htmlArea RTE only)

boolean

If set, the TYPO3 element and image browsers are disabled.

Default: 0

Note: If set, the htmlArea plugin TYPO3Browsers is disabled.

Note: The TYPO3Browsers plugin is not available when the editor is used in the TYPO3 front end.

classesImage

list of id-strings

Classes available for images.

In the case of htmlArea RTE, each of the listed class must be defined either in one of the occurrences of  the inlineStyle property or in the CSS file specified by contentCSS property.

In the case of htmlArea RTE, the same list of classes is used in the class selection list of the Insert/Modify image dialog.

In the case of the Classic RTE, see description of 'classesCharacter'.

blindImageOptions

list of strings

List of tab items in the image selector to remove. Key list is magic,plain,dragdrop

buttons.image.options.removeItems

(htmlArea RTE only)

list of strings

List of tab items to remove from the dialog of the image button. Possible tab items are: page,file,url,mail,spec

Note: If integration with DAM is enabled, upload is also a possible tab.

Note: This property is a synonymous of property blindImageOptions.

buttons.image.options.magic.maxWidth

(htmlArea RTE only)

int+

Maximum width of magic images in pixels.

Default: 300

buttons.image.options.magic.maxHeight

(htmlArea RTE only)

int+

Maximum height of magic images in pixels.

Default: 1000

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

buttons.image.options.plain.maxWidth

(htmlArea RTE only)

int+

Maximum width of selectable plain images in pixels.

Default:  640

buttons.image.options.plain.maxHeight

(htmlArea RTE only)

int+

Maximum height of selectable plain images in pixels.

Default: 680

buttons.image.title.useDAMColumn

string

Name of the column of the tx_dam table that will be used to set the image title attribute.

Default: caption

Note: This property is ignore if the extension configuration variable “Enable the DAM media browser” is not set.

classesAnchor

(htmlArea RTE only)

list of id-strings

Classes available in the Insert/Modify link dialog.

These classes must be defined by the RTE.classesAnchor property.

The following property specifies the default class of the class selector of the corresponding tab:

.default {

page = className

url = className

file = className

mail = className

}

classesLinks

list of id-strings

Classes available for links. See description of 'classesCharacter'.

In the case of htmlArea RTE, classesAnchor offers more options.

defaultLinkTarget

string

This sets the default target for new links in the RTE.

blindLinkOptions

list of strings

List of tab items in the link selector to remove. Key list is page,file,url,mail,spec

buttons.link.options.removeItems

(htmlArea RTE only)

list of strings

List of tab items to remove from the dialog of the link button.  Possible tab items are: page,file,url,mail,spec

Note: This property is a synonymous of property blindLinkOptions.

buttons.link.targetSelector.disabled

(htmlArea RTE only)

boolean

If set, the selection of link target is removed from the link insertion/update dialog.

Default : 0

buttons.link.popupSelector.disabled

(htmlArea RTE only)

boolean

If set the selection of a popup window as link target is removed from the link insertion/update dialog.

Default: 0

classesTable

list of id-strings

Classes available for tables. See description of 'classesCharacter'.

In the case of htmlArea RTE, each of the listed class must be defined either in one of the occurrences of  the inlineStyle property or in the CSS file specified contentCSS property.

In the case of htmlArea RTE, the same list of classes is used in the class selection list of the Table Properties dialog.

classesTD

list of id-strings

Classes available for tablecells. See description of 'classesCharacter'.

In the case of htmlArea RTE, each of the listed class must be defined either in one of the occurrences of  the inlineStyle property or in the CSS file specified contentCSS property.

In the case of htmlArea RTE, the same list of classes is used in the class selection list of the Cell Properties dialog.

colors

list of id-strings

Defines the specific colors generally available in the color selectors. The id-strings must be configured in the RTE.colors array (see description earlier).

Example:

RTE.default {

  colors = color1, color2,noColor

}

disableColorPicker

boolean

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

Note: In the case of htmlArea RTE, this applies only when the TYPO3 configurable color selection dialog is enabled (plugin SelectColor).

disableSelectColor

(htmlArea RTE only)

boolean

If set, the TYPO3 configurable color selection dialog is disabled.

Default: 0

Note: If set, the htmlArea plugin SelectColor is disabled.

hideFontFaces

list of id-numbers,

* removes all

Lets you disable any of the default font faces in the Font Style selector. These are the possible values you can set:

1: Arial

2: Arial Black

3: Verdana

4: Times New Roman

5: Garamond

6: Lucida Handwriting

7: Courier

8: Webdings

9: Wingdings

fontFace

list of id-strings

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

hideFontSizes

list of size-numbers,

* removes all

Lets you disable any of the default font sizes available in the Font Size selector. Values are ranging from 1-7.

showButtons

hideButtons

list of id-strings

Note: In the case of htmlArea RTE, available buttons are: blockstylelabel, blockstyle, textstylelabel, textstyle, fontstyle, fontsize, formatblock, bold, italic, underline, strikethrough, subscript, superscript, lefttoright, righttoleft, left, center, right, justifyfull, orderedlist, unorderedlist, outdent, indent, textcolor, bgcolor, textindicator, emoticon, insertcharacter, line, link, image, table, user, acronym, findreplace, spellcheck, chMode, inserttag, removeformat, copy, cut, paste, undo, redo, showhelp, about, toggleborders, tableproperties, rowproperties, rowinsertabove, rowinsertunder, rowdelete, rowsplit, columninsertbefore, columninsertafter, columndelete, columnsplit, cellproperties, cellinsertbefore, cellinsertafter, celldelete, cellsplit, cellmerge

Note: In the case of htmlArea RTE, if extension sr_static_info is not installed, the spellcheck button is not enabled.

Note:In the case of htmlArea RTE,  the following elements will always be shown: undo redo, about.

Note: In the case of htmlArea RTE, buttons user and acronym are never available in the front end.

Note:  In the case of htmlArea RTE, button Acronym is not currently available in IE.

toolbarOrder

(htmlArea RTE only)

list of id-strings

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, bar, linebreak, fontstyle, space, fontsize, space, formatblock, bar, bold, italic, underline, bar, strikethrough, subscript, superscript, bar, lefttoright, righttoleft, bar, left, center, right, justifyfull, bar, orderedlist, unorderedlist, outdent, indent, bar, textcolor, bgcolor, textindicator, bar, emoticon, insertcharacter, line, link, image, table, user, acronym, bar, findreplace, spellcheck, bar, chMode, inserttag, removeformat, bar, copy, cut, paste, bar, undo, redo, bar, showhelp, about, linebreak,  toggleborders, bar, tableproperties, bar, rowproperties, rowinsertabove, rowinsertunder, rowdelete, rowsplit, bar, columninsertbefore, columninsertafter, columndelete, columnsplit, bar, cellproperties, cellinsertbefore, cellinsertafter, celldelete, cellsplit, cellmerge

keepButtonGroupTogether

(htmlArea RTE only)

boolean

Specifies that all buttons of a button group are displayed on the same line of the tool bar. A button group is delimited by a linebreak or by a bar.

Default: 0

Note: If enabled, the setting is honored only by Mozilla/Firefox. It is ignored when  the browser is Internet Explorer, Safari, Opera or Mozilla 1.3.

hideTableOperationsInToolbar

(htmlArea RTE only)

boolean

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.

keepToggleBordersInToolbar

(htmlArea RTE only)

boolean

This property is deprecated. Use property buttons.toggleborders.keepInToolbar

buttons.toggleborders.keepInToolbar

(htmlArea RTE only)

boolean

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

Default: 0

buttons.toggleborders.setOnTableCreation

(htmlArea RTE only)

boolean

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

Default : 0

disableContextMenu

(htmlArea RTE only)

boolean

Specifies that the context menu should be disabled or not.

Default: 0

Note: This property is a synonymous of disableRightClick property.

disableRightClick

boolean

If set, the right click (context) menu of the RTE is disabled.

showStatusBar

(htmlArea RTE only)

boolean

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

Default: 0

mainStyleOverride

string

By default the editor style section is set with the CSS-code below. However you may override this by this option.

Default for Classic RTE:

BODY {

  border: 1px black solid;

  border-top: none;

  margin : 2 2 2 2;

  font-family:Verdana;

  font-size:10px;

  color:black;

  background-color:white;

}

TD {font-family:Verdana; font-size:10px;}

P {margin-top:0px; margin-bottom:5px;}

DIV {margin-top:0px; margin-bottom:5px;}

OL {margin: 5px 10px 5px;}

UL {margin: 5px 10px 5px;}

BLOCKQUOTE {margin-top:0px; margin-bottom:0px;}

Default for htmlArea RTE:

body.htmlarea-content-body {

font-family: Verdana,sans-serif;

font-size: 12px;

color: black;

background-color: white;

}

td { }

div { }

pre { }

ol { }

ul { }

blockquote { }

Note: In the case of htmlArea RTE, see also property ignoreMainStyleOverride.

mainStyleOverride_add.[key]

string (css-style)

Allows to add style configuration to the values above (for .mainStyleOverride above)

Keys are:

.P / .DIV / .TD /.BODY / .BLOCKQUOTE /.OL / .UL / .PRE / .Hx will all take values which are prepended to the above settings.

Note: In the case of htmlArea RTE, see also property ignoreMainStyleOverride.

mainStyle_font

mainStyle_size

mainStyle_color

mainStyle_bgcolor

string

Setting the default font-family (verdana) , font-size (10px), font-color (black) and background color (white)

The default is shown in “.mainStyleOverride” above.

Note: In the case of htmlArea RTE, see also property ignoreMainStyleOverride.

inlineStyle.[any keysting]

string

CSS code to be included in the editor style section. This will be included after the default code.

Note: In the case of htmlArea RTE, see also property ignoreMainStyleOverride.

skin

(htmlArea RTE only)

resource

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: Extensions sr_rtehtmlarea_bluelook and sr_rtehtmlarea_xpblue provide two additional example skins.

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.

Note: See also property ignoreMainStyleOverride.

contentCSS

(htmlArea RTE only)

resource

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 by the DynamicCSS and InlineCSS plugins in the block style and text style selection lists.

Default: EXT:rtehtmlarea/htmlarea/plugins/DynamicCSS/dynamiccss.css

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

Note: See also property ignoreMainStyleOverride.

ignoreMainStyleOverride

(htmlArea RTE only)

boolean

Instruct htmlArea RTE to ignore properties mainStyleOverride and inlineStyle.

Default: 0

Note: In htmlArea RTE, the following style sheets apply to the contents of the editing area and are linked in the following order:

1. the htmlarea-edited-content.css file from the skin being used (contains selectors for use in the editor but not intended to be applied in the frontend);

2. a css file generated from the mainStyleOverride and inlineStyle assignments;

3. the css file specified by contentCSS in Page TSConfig.

When ignoreMainStyleOverride is enabled, the middle style sheet is ignored and only the first and third style sheets are used.

proc

->PROC

Customization of the server processing of the content - also called 'transformations'.

See http://typo3.org/documentation/document-library/core-documentation/doc_core_api/current/view/5/2/

enableWordClean

(htmlArea RTE only)

boolean/

->HTMLparser

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: The HTMLparser configuration is ignored If TYPO3HtmlParser plugin is disabled.

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

removeComments

(htmlArea RTE only)

boolean

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

Default: 0

removeTags

(htmlArea RTE only)

list of tags

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

removeTagsAndContents

(htmlArea RTE only)

list of tags

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.

useCSS

(htmlArea RTE only)

boolean

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

(htmlArea RTE only)

boolean

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

Default: 0

Note: If NOT enabled, the behavior of Mozilla/Firefox, Safari and Opera 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, Safari and Opera is not modified: a br tag is inserted when the Enter key is pressed.

removeTrailingBR

(htmlArea RTE only)

boolean

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.

hideTags

(htmlArea RTE only)

list of tags

This property is deprecated. Use property buttons.inserttag.denyTags

buttons.inserttag.denyTags

(htmlArea RTE only)

list of tags

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

(htmlArea RTE only)

list of attributes

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

(htmlArea RTE only)

list of attributes

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.

disableAlignmentFieldsetInTableOperations

disableSpacingFieldsetInTableOperations

disableColorFieldsetInTableOperations

disableLayoutFieldsetInTableOperations

disableBordersFieldsetInTableOperations

(htmlArea RTE only)

boolean

Disables the corresponding fieldsets of the table operations dialogs.

Default: 0

enablePersonalDicts

(htmlArea RTE only)

boolean

Specify that personal dictionaries should be enabled or not.

Default: 0

Note: The SpellChecker plgin must be enabled.

Note: The option is ignored if PHP safe_mode is enabled on the server.

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

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

userElements.[#]

string/->userCategory

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.

userLinks.[#]

string/->userLinks

Configuration of user defined links.

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

classesAnchor.[id-string]

(htmlArea RTE only)

Attaches special properties to the classes available in the Insert/Modify link dialog.

Properties:

.class = CSS-class-name: the name of the CSS class to which the properties are attached

.type = page, url, file, mail or spec: specifies that the class applies to anchors for internal pages, external URL's, files, email addresses or special user-defined links respectively; the class will be presented only in the corresponding tab of the TYPO3 link browser

.image = URL of an icon file that will prefix the content of the anchor when the class is applied to an anchor; the TYPO3 syntax EXT:extension-key/sub-directory/image-file-name may be used

.altText = the text that will be used as altText for the image when the class is applied to an anchor; may be language-splitted; the TYPO3 syntax LLL:EXT:extension-key/sub-directory/locallang.php:label-index may also be used in order for the text to be localized to the language of the content using the specified language file and label index

.titleText = the text that will be used as title for the anchor when the class is applied to an anchor; may be language-splitted; the TYPO3 syntax LLL:EXT:extension-key/sub-directory/locallang.php:label-index may also be used in order for the text to be localized to the language of the content using the specified language file and label index

See the Demo default configuration for a complete example.

load

string

If set, the a predefined set of user element is loaded into this category. They are always loaded in the key starting with 100 and then forward in steps of 10.

Current options are:

“images_from_folder”: Loads gif,jpg,jpeg,png images from the specified folder (defined by the .path property)

merge

Boolean

If set, then any manually configured user elements are merged onto the ones loaded by the .load operation.

path

String

(Applies for load=images_from_folder only)

Sets the path of the folder from which to fetch the images (gif,jpg,jpeg,png)

Example:

.path = fileadmin/istate/

[#]

string/->userElements

Configuration of the user elements.

The string value is the name of the user element. Language-splitted.

Example:

RTE.default.userElements {

    # Category with various elements

  10 = Various elements | Diverse elements

  10 {

      # An image is inserted

    1 = Logo 1 | Bomærke 1

    1.description = This is the logo number 1. | Dette er logo nummer 1

    1.content = <img src="###_URL###fileadmin/istate/curro.png">

      # The text-selection is wrapped with <sup> tags.

    2 = Subscript

    2.description = Selected text is wrapped in <sup>-tags.

    2.mode = wrap

    2.content = ^|

      # This submits the selected text content to the script, rte_cleaner.php

    5 = Strip all tags

    5.description = All HTML-codes are removed from selection.

    5.mode = processor

    5.submitToScript = typo3/rte_cleaner.php

  }

    # Category with images from the fileadmin/istate/ folder

  2.load = images_from_folder

  2.merge = 1

  2.path = fileadmin/istate/

    # here the logo from “Various elements” is included as well

  2.1 < .10.1

}

  # Show the user-button, if not existing

RTE.default.showButtons = user

mode

string

Which kind of object it is.

Options:

“wrap”: If a wrap, then the content is exploded by “|” and wrapped around the current text selection.

“processor”: The content is submitted to the php-script defined by .submitToScript. GPvar(“processContent”) carries the selection content of the RTE and GPvar(“returnUrl”) contains the return url. (The “content” property is not used here!)

default: The content is just inserted (pasted into) at the cursor or substituting any current selection.

description

string

A short description shown beneath the user element title (which is in bold)

content

string

The content inserted/wrapped into the RTE

submitToScript

string

(Applies only to mode=processor)

PHP script to which the current text selection of the RTE is submitted. The script must be relative to the site-url or a full url starting with http://...

Example:

.submitToScript = typo3/rte_cleaner.php

or

.submitToScript = http://www.domain.org/some_extenal_script.php

dontInsertSiteUrl

boolean

If set, the marker ###_URL### in the content property's content IS NOT substituted by the current site url. Normally you wish to do this for all  image-references which must be prepended with the absolute url in order to display correctly in the RTE!

url

string

The url.

If set, the marker ###_URL### in the content property's content is substituted by the current site url.

description

string

A short description shown beneath the link  title (which is in bold)

target

string

Default target (if isset())