[BUGFIX] Fix PageTS config example of CKEditor RTE
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Documentation / Changelog / 8.6 / Deprecation-79341-TCARichtextConfigurationInDefaultExtrasDropped.rst
1 .. include:: ../../Includes.txt
2
3 =========================================================================
4 Deprecation: #79341 - TCA richtext configuration in defaultExtras dropped
5 =========================================================================
6
7 See :issue:`79341`
8
9 Description
10 ===========
11
12 Enabling richtext rendering for fields in the Backend record editor has been simplified.
13
14 In the past, a typical :php:`TCA` configuration of a richtext field looked like:
15
16 .. code-block:: php
17     'columns' => [
18         'content' => [
19             'config' => [
20                 'type' => 'text',
21             ],
22             'defaultExtras' => 'richtext:rte_transform',
23         ],
24     ];
25
26 The :php:`defaultExtras` is obsolete and substituted with :php:`enableRichtext` within the :php:`config` section:
27
28 .. code-block:: php
29     'columns' => [
30         'content' => [
31             'config' => [
32                 'type' => 'text',
33                 'enableRichtext' => true,
34             ],
35         ],
36     ];
37
38
39 If the RTE was enabled for a specific type only, it looked like this:
40
41 .. code-block:: php
42     'columns' => [
43         'content' => [
44             'config' => [
45                 'type' => 'text',
46             ],
47         ],
48     ],
49     'types' => [
50         'myType' => [
51             'columnsOverrides' => [
52                 'aField' => [
53                     'defaultExtras' => 'richtext:rte_transform',
54                 ],
55             ],
56         ],
57     ],
58
59 This is now:
60
61 .. code-block:: php
62
63     'columns' => [
64         'content' => [
65             'config' => [
66                 'type' => 'text',
67             ],
68         ],
69     ],
70     'types' => [
71         'myType' => [
72             'columnsOverrides' => [
73                 'aField' => [
74                     'config' => [
75                         'enableRichtext' => true,
76                     ],
77                 ],
78             ],
79         ],
80     ],
81
82
83 Impact
84 ======
85
86 Using defaultExtras to enable richtext editor will stop working in TYPO3 v9. An automatic :php:`TCA` migration
87 transfers to the new syntax in TYPO3 v8 and logs deprecations.
88
89
90 Affected Installations
91 ======================
92
93 All installations using :php:`defaultExtras` for richtext configuration.
94
95
96 Migration
97 =========
98
99 Remove the defaultExtras line and set :php:`'enableRichtext' => true,` within the config section of the field.
100 This is allowed in :php:`columnsOverrides` for specific record types, too.
101
102 .. index:: Backend, FlexForm, RTE, TCA