[BUGFIX] Fix PageTS config example of CKEditor RTE
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / 8.6 / Feature-79216-AddYAMLConfigurationForCKEditorRTE.rst
1 .. include:: ../../Includes.txt
2
3 =========================================================
4 Feature: #79216 - Add YAML configuration for CKEditor RTE
5 =========================================================
6
7 See :issue:`79216`
8
9 Description
10 ===========
11
12 The CKEditor-flavored RTE can now be configured via YAML files, defined as *presets*.
13
14 A preset contains both the RTE configuration and the HTML processing when storing the content
15 in the database.
16
17 A YAML file for RTE configurations can be registered by any extension in `ext_localconf.php`:
18
19 :php:`$GLOBALS['TYPO3_CONF_VARS']['RTE']['Presets']['default'] = 'EXT:rte_ckeditor/Configuration/RTE/Default.yaml';`
20
21 The TYPO3 Core ships with three flavors for the RTE configuration which can also be overridden via
22 PageTSconfig on a per-field/type level:
23
24 .. code-block:: typoscript
25
26 RTE.default.preset = minimal
27 RTE.config.tt_content.bodytext.types.textmedia.preset = full
28
29
30 The PageTSconfig allows to use the minimal configuration everywhere, but to use the full
31 configuration on the tt_content.bodytext field (but only for textmedia content types).
32
33 With the YAML configuration files, an "imports" functionality allows to import other
34 configuration and just override the necessary values for a custom configuration for a specific site.
35 This way, the processing part of EXT:rte_ckeditor can be used directly (which acts as best practice)
36 but the editor part can be completely customized.
37
38 The YAML format thus states three important parts considered by the RTE configuration preset:
39
40 1. "imports"
41 Allows to import other files via the "resource" sub-property
42 2. "processing"
43 uses the former "proc" options to hand over to RteHtmlParser to sanitize the content - the option
44 are the same as for RTEHtmlArea
45 3. "editor"
46 A configuration for CKEditor, where all CKEditor-related options can be set which are available
47 from the ckeditor configuration specifications (see http://docs.ckeditor.com/#!/api/CKEDITOR.config
48 for all options).
49
50 .. index:: LocalConfiguration, RTE