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.

EXT: tinyRTE¶

Author:	Kasper Skårhøj
Created:	2002-11-01T00:32:00
Changed by:	Thomas Schulze
Changed:	2007-05-08T21:27:09
Author:	Thomas Schulze [outraxX]
Email:	kontakt@outraxx.de
Info 3:
Info 4:

EXT: tinyRTE¶

Extension Key: tinyrte

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents¶

EXT: tinyRTE 1

Introduction 1

What does it do? 1

Screenshots 1

Users manual 2

FAQ 2

Adminstration 2

Configuration 4

Known problems 4

Button list 5

To-Do list 6

Changelog 6

Introduction¶

What does it do?¶

This extension provides a brand new Rich-Text-Editor for Typo3.

Screenshots¶

Users manual¶

For handle this Extension by a user, there is nothing to say but use it like Microsoft Word or OpenOffice-Writer ;-)

FAQ¶

No FAQ´s of users at this time.

Adminstration¶

There are some options you can give via TSconfig. Some of them are used by other RTE, some are only for tinyRTE. You define it with RTE.default. and one of the following option:

RTE.default.

disabled¶

Option

disabled

Type

boolean

Description

This disabled the RTE if set to true.

showButtons¶

Option

showButtons

Type

string

Description

A comma-separated value of Buttons to show. This can easier configured in the BE-User or BE-Group. But if needed of course in TSconfig

hideButtons¶

Option

hideButtons

Type

string

Description

Similar to showButtons. This override the value in showButton.

disableColorPicker¶

Option

disableColorPicker

Type

boolean

Description

If set to true, both, foreground and background colorpicker are disabled.

cssFile¶

Option

cssFile

Type

string

Description

Path and Filename to a new CSS-File, used in the RTE-Selectorbox

classes¶

Option

classes

Type

string

Description

Classes to use from the CSS-File. If this Option not given, all classes found in the CSS-File are available in the selectorbox.Example: Header 1=header1;Header 2=header2

fontFace¶

Option

fontFace

Type

string

Description

Here you can enable Fontfaces for the RTE.Example: Arial=arial,helvetica,sans-serif;Courier New=courier new,courier,monospace

buttonlist¶

Option

buttonlist

Type

string

Description

You can define here the 4 possible rows of the RTE. You can do this in the “old” way per handwork (see Button-List later) or by using the Configurator on tinyrte.outraxx.de . A semicolon separates the 4 rows, a pipe define a Separator and a comma separate the buttons.

templates¶

Option

templates

Type

string

Description

If you enable the Template-Button for the User you can define some Templates he ca use. To test this, insert the following code in you TSconfig:

RTE.default.templates.path=typo3conf/ext/tinyrte/

RTE.default.templates.items {

Template {

src=template_sample.php

description=a simple Template

}

Snippet {

src=snippet_sample.php

description=a simple snippet

}

RTE.default.templates.replace {

username=realName

email=email

}

Now enable the Template-Button for the user and place it in one of the 4 possible rows. Call this function by click on the Button and select “Template” in the selectorbox.The path in RTE.default.templates.path should be the path to the Extension. "typo3conf/ext/tinyrte/" if the Extension is as local installed, "typo3/ext/tinyrte/" if the Extension is as global installed.

initial¶

Option

initial

Type

string

Description

Here you can define all values from the initialconfiguration. So you can configure the RTE completely via TSconfig to share the same configuration with other Typo3-Instances. For naming look at the table “Configuration”.

RTE.default.initial {

MCEconvert_fonts_to_spans=0

}

addParams¶

Option

addParams

Type

string

Description

Since version 1.6.4 there is no fixed preconfiguration. With “addParams” you can give any option which TinyMCE (the core) understand. Therefore you can look at http://wiki.moxiecode.com/index.php/TinyMCE:Configuration .

Example: verify_html=false

Of course there is a preconfiguration to prevent tinyRTE works after install:

RTE.default.addParams {

cleanup=true

remove_script_host=false

relative_urls=false

theme_advanced_toolbar_location="top"

theme_advanced_toolbar_align="left"

theme_advanced_statusbar_location="bottom"

verify_html=true

cleanup_on_startup=true

apply_source_formatting=true

spellchecker_languages="+Deutsch=de,Englisch=en"

}

These parameters can be override in TSconfig.

Note: The TSconfig override all other Values!

To enable given Buttons per TSconfig or in the Extension-Manager- Section you can use the function in BE-User and/or BE-Group, where setups in Groups override the setup in User. Open a BE-User or a BE- Group, you will see following:

Just click the Button the User/Group should have. For more than one Button hold the CTRL-Button on your keyboard. To disable all selected Buttons click the first entry and save the setup. Note that you have to put a Button you enable here in one of the 4 possible Rows via TSconfig or in the Extension-Manager. Otherwise this will not have an effect.

Configuration¶

Just install the RTE over the Extension Manager or download the .t3x- package from typo3.org (Extension-Key: tinyrte).

Please make sure, that no other RTE is running. Deinstall some other RTE before you install tinyRTE.

While installing you can a little bit configure RTE:

Styles¶

Option

Styles

Description

You can give here a CSS-File that contains Stylesheets. Later i will show you to select one out of this file to provide in the RTE. But make sure this styles are available in FE, too.

RTE-Width¶

Option

RTE-Width

Description

This is the initial width of the RTE in Backend.

RTE-Height¶

Option

RTE-Height

Description

Similar to RTE-Width.

Visible Buttons¶

Option

Visible Buttons

Description

You can define here the 4 possible rows of the RTE. You can do this in the “old” way per handwork (see Button-List later) or by using the Configurator on tinyrte.outraxx.de . A semicolon separates the 4 rows, a pipe define a Separator and a comma separate the buttons.

Entities¶

Option

Entities

Description

You can give here some entities to use instead of characters

Fonts¶

Option

Fonts

Description

Available fonts in the fontlist of the RTE. Example: font_family1=font1,font2,font3; font_family2=font1,font2,font3

Date-Format¶

Option

Date-Format

Description

The Format used by insert the Date via plugin “datetime”, button date. For naming see some php-manual.

Time-Format¶

Option

Time-Format

Description

Similar to Date-Format.

Invalid elements¶

Option

Invalid elements

Description

Tags you don´t wont have in the source of the RTE-Content. It will be filtered.

force_p_newlines¶

Option

force_p_newlines

Description

This option enables you to disable/enable the creation of paragraphs on return/enter in Mozilla/Firefox. The default value of this option is true.

force_br_newlines¶

Option

force_br_newlines

Description

If you set this option to true, tinyRTE will force BR elements on newlines instead of inserting paragraphs.

convert_newlines_to_brs¶

Option

convert_newlines_to_brs

Description

If you set this option to true newline characters codes gets converted in to br elements.

convert_fonts_to_spans¶

Option

convert_fonts_to_spans

Description

If you set this option to true the <font>-Tag will be replaced as <span>.

Resizing¶

Option

Resizing

Description

This option gives you the ability to enable/disable the resizing button.

Resizing horizontal¶

Option

Resizing horizontal

Description

This option gives you the ability to enable/disable the horizontal resizing.

Use compressed Script¶

Option

Use compressed Script

Description

Serverside GZip compresses TinyMCE to reduce overall download size. Makes TinyMCE 75% smaller and a lot faster to load.

Notice: You can override all these options in TSconfig. This is the simple way to copy one configuration between other Typo3-Instances. See Table above (“Administration”).

Known problems¶

Are there problems? ;-)

Button list¶

Here is the Button list. If you don´t use the Buttonconfigurator on tinyrte.outraxx.de you have to configure this by Handwork. Therefore you have to know the naming of the buttons:

¶

a

b

newdocument

c

d

bold

e

f

italic

¶

a

b

underline

c

d

strikethrough

e

f

sub

¶

a

b

sup

c

d

justifyleft

e

f

justifycenter

¶

a

b

justifyright

c

d

justifyfull

e

f

cut

¶

a

b

copy

c

d

paste

e

f

pastetext

¶

a

b

pasteword

c

d

search

e

f

replace

¶

a

b

bullist

c

d

numlist

e

f

outdent

¶

a

b

indent

c

d

undo

e

f

redo

¶

a

b

typo3link

c

d

unlink

e

f

anchor

¶

a

b

typo3image

c

d

table

e

f

visualaid

¶

a

b

emotions

c

d

flash

e

f

advhr

¶

a

b

hr

c

d

removeformat

e

f

charmap

¶

a

b

ltr

c

d

rtl

e

f

print

¶

a

b

insertdate

c

d

inserttime

e

f

preview

¶

a

b

help

c

d

cleanup

e

f

code

¶

a

b

forecolor

c

d

backcolor

e

f

spellchecker

¶

a

b

zoom

c

d

insertlayer

e

f

absolute

¶

a

b

moveforward

c

d

movebackward

e

f

visualchars

¶

a

b

cite

c

d

abbr

e

f

acronym

¶

a

b

del

c

d

ins

e

f

media

¶

a

b

lorem

c

d

| (pipe)

e

f

styleprops

¶

a

b

template

c

For the Selectorboxes use:

formatselect,fontselect,fontsizeselect,styleselect

To-Do list¶

Yes... there is something to do. Through this point, the result of the tinyRTE (not TinyMCE), is only my job. My wish is to work together with other to provide the Typo3-Community a better, stable and more usefully RTE.

Changelog¶

To see what changed in the different versions go to http://tinyrte.outraxx.de/changelog0/

EXT: tinyRTE - 6