TYPO3 Configuration Basics

Just in case you are not familiar with how to configure TYPO3, we will give you a very brief introduction. Otherwise, you can safely skip this part and continue reading Configuration Concepts.

We only cover configuration methods that are used to configure rte_ckeditor.

Page TSconfig

We recommend you to put all configurations for the preset in the YAML configuration. However, it is still possible to override these settings through the page TSconfig.

You can find a list of configuration properties in the Page TSconfig reference, chapter RTE.

Relevant Settings for rte_ckeditor

Page TSconfig can be used to change:

  1. Default preset:

    RTE.default.preset = full

  2. Override for one field (RTE.config.[tableName].[fieldName].preset):

    RTE.config.tt_content.bodytext.preset = myCustomPreset
RTE.config.tx_news_domain_model_news.bodytext.preset = minimal

  3. Override for one field defined in flexform (RTE.config.[tableName].[flexForm.field.name].preset):

    RTE.config.tt_content.settings.notifications.emailText.preset = myCustomPreset

  4. Override for one field, if type matches (RTE.config.[tableName].[fieldName].types.[type].preset):

    RTE.config.tt_content.bodytext.types.textmedia.preset = minimal

How to change values

See the Page TSconfig reference, chapter Setting Page TSconfig. This chapter also expains how to verify the settings.

Global Configuration

Global Configuration is a system-wide general configuration.

Relevant Settings for rte_ckeditor

The setting $GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets'] is used to configure the available presets for rich text editing.

By default, the presets "minimal", "default" and "full" are defined.

If you add a new preset, you must add it to this array.

How to change values

Usually, Global Configuration can be configured in the backend in Admin Tools > Settings > Configure Installation-Wide Options.

However, the settings relevant for rich text editing, $GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets'] cannot be configured in the backend.

You must either configure this in:

  1. The file typo3conf/AdditionalConfiguration.php

  2. Or in an extension in the file EXT:<extkey>/ext_localconf.php

if (empty($GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets']['myCustomPreset'])) {
    $GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets']['myCustomPreset'] = 'EXT:<extkey>/Configuration/RTE/MyCustomPreset.yaml';
}

How to view settings

You can view the Global Configuration in System > Configuration > $GLOBAL['TYPO3_CONF_VARS'] (Global Configuration) > RTE.

../_images/global-configuration-rte.png

Global Configuration: RTE > Presets

YAML

Most of the configuration of rte_ckeditor will be done in a YAML file.

Relevant Settings for rte_ckeditor

See Configuration Reference

How to change values

This is done directly in the file. The YAML file should be included in a sitepackage extension, see Use a Sitepackage extension.

TCA

The table configuration array is used to configure database fields and how they will behave in the backend when edited. It is for example used to define that tt_content.bodytext should be edited with a rich text editor.

Relevant Settings for rte_ckeditor

How to change values

This must be done in an extension in Configuration/TCA. Usually this is done within a custom sitepackage extension, see Use a Sitepackage extension.

How to view settings

You can view TCA in the backend: System > Configuration > $GLOBAL['TCA'] (Table configuration array).

For example, look at tt_content > columns > bodytext.

However, you will find that neither enableRichtext, nor richtextConfiguration is set here. They are configured in tt_content > types for various content types, for example look at tt_content > types > text > columnsOverrides.

../_images/column_overrides.png

TCA: tt_content > types > text > columnsOverrides > bodytext