DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

userElements:

Properties of each user elements setup.

mode

Property

mode

Data type

string

Description

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

Property

description

Data type

string

Description

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

content

Property

content

Data type

string

Description

The content inserted/wrapped into the RTE

submitToScript

Property

submitToScript

Data type

string

Description

(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

Property

dontInsertSiteUrl

Data type

boolean

Description

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!

[page:->userElements]