[TASK] RTE: Update some references to core documentation
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / Documentation / DefaultConfigurations / Default / Index.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6 .. include:: ../../Includes.txt
7
8
9
10 .. _default-configuration:
11
12 Default configuration of RTE content transformation
13 ---------------------------------------------------
14
15 This default configuration establishes default settings in Page
16 TSconfig for RTE content transformation.
17
18 For documentation of RTE tranformations, see:
19 :ref:`RTE tranformations <t3api:transformations>`
20
21 For documentation of Page TSconfig configuration of RTE processing, see:
22 :ref:`RTE tranformations Page TSconfig <t3api:transformations-tsconfig>`
23
24 For documentation of the HTMLparser, see:
25 :ref:`TypoScript HTMLparser <t3tsref:htmlparser>`
26
27 For documentation of RTE settings in TCA, see:
28 :ref:`Special Configuration Options <t3tca:special-configuration-options>`
29
30
31 .. _default-configuration-page-tsconfig:
32
33 The following is inserted in Page TSconfig:
34 """""""""""""""""""""""""""""""""""""""""""
35
36 ## Default RTE processing rules
37
38 ::
39
40 RTE.default.proc {
41
42 ## TRANSFORMATION METHOD
43
44 ## We assume that CSS Styled Content is used.
45
46 ::
47
48 overruleMode = ts_css
49
50 ## DO NOT CONVERT BR TAGS INTO LINEBREAKS
51
52 ## br tags in the content are assumed to be intentional.
53
54 ::
55
56 dontConvBRtoParagraph = 1
57
58 ## PRESERVE DIV SECTIONS - DO NOT REMAP TO P
59
60 ::
61
62 preserveDIVSections = 1
63
64 ## TAGS ALLOWED OUTSIDE P & DIV
65
66 ::
67
68 allowTagsOutside = address, article, aside, blockquote, footer, header, hr, nav, section
69
70 ## TAGS ALLOWED
71
72 ## Added to the default internal list: b,i,u,a,img,br,div,center,pre,f
73 ont,hr,sub,sup,p,strong,em,li,ul,ol,blockquote,strike,span
74
75 ## But, for the sake of clarity, we use a complete list in alphabetic
76 order.
77
78 ## center, font, link, meta, o:p, strike, sdfield, style, title and u
79 will be removed on entry (see below).
80
81 ## b and i will be remapped on exit (see below).
82
83 ## Note that the link accessibility feature of htmlArea RTE does
84 insert img tags.
85
86 ::
87
88 allowTags = a, abbr, acronym, address, article, aside, b, bdo, big, blockquote, br, caption, center, cite, code, col, colgroup, dd, del, dfn, dl, div, dt, em, font, footer
89 allowTags := addToList(header, h1, h2, h3, h4, h5, h6, hr, i, img, ins, kbd, label, li, link, meta, nav, ol, p, pre, q, samp, sdfield, section, small)
90 allowTags := addToList(span, strike, strong, style, sub, sup, table, thead, tbody, tfoot, td, th, tr, title, tt, u, ul, var)
91
92 ## TAGS DENIED
93
94 ## Make sure we can set rules on any tag listed in allowTags.
95
96 ::
97
98 denyTags >
99
100 ## ALLOWED P & DIV ATTRIBUTES
101
102 ## Attributes class and align are always preserved
103
104 ## Align attribute will be unset on entry (see below)
105
106 ## This is a list of additional attributes to keep
107
108 ::
109
110 keepPDIVattribs = id, title, dir, lang, xml:lang, itemscope, itemtype, itemprop
111
112 ## ALLOW TO WRITE ABOUT HTML
113
114 ::
115
116 dontUndoHSC_db = 1
117 dontHSC_rte = 1
118
119 ## CONTENT TO DATABASE
120
121 ::
122
123 entryHTMLparser_db = 1
124 entryHTMLparser_db {
125
126 ## TAGS ALLOWED
127
128 ## Always use the same list of allowed tags.
129
130 ::
131
132 allowTags < RTE.default.proc.allowTags
133
134 ## TAGS DENIED
135
136 ## Make sure we can set rules on any tag listed in allowTags.
137
138 ::
139
140 denyTags >
141
142 ## AVOID CONTENT BEING HSC'ed TWICE
143
144 ::
145
146 htmlSpecialChars = 0
147
148 ::
149
150 tags {
151
152 ## REMOVE IMG TAGS
153
154 ::
155
156 img.allowedAttribs = 0
157 img.rmTagIfNoAttrib = 1
158
159 ## CLEAN ATTRIBUTES ON THE FOLLOWING TAGS
160
161 ::
162
163 span.fixAttrib.style.unset = 1
164 span.allowedAttribs = id, title, dir, lang, xml:lang, class, itemscope, itemtype, itemprop
165 span.rmTagIfNoAttrib = 1
166 p {
167 allowedAttribs = id, title, dir, lang, xml:lang, class, itemscope, itemtype, itemprop
168 fixAttrib.align.unset = 1
169 }
170 div < .p
171 hr.allowedAttribs = class
172 b.allowedAttribs < .span.allowedAttribs
173 bdo.allowedAttribs < .span.allowedAttribs
174 big.allowedAttribs < .span.allowedAttribs
175 blockquote.allowedAttribs < .span.allowedAttribs
176 cite.allowedAttribs < .span.allowedAttribs
177 code.allowedAttribs < .span.allowedAttribs
178 del.allowedAttribs < .span.allowedAttribs
179 dfn.allowedAttribs < .span.allowedAttribs
180 em.allowedAttribs < .span.allowedAttribs
181 i.allowedAttribs < .span.allowedAttribs
182 ins.allowedAttribs < .span.allowedAttribs
183 kbd.allowedAttribs < .span.allowedAttribs
184 label.allowedAttribs < .span.allowedAttribs
185 q.allowedAttribs < .span.allowedAttribs
186 samp.allowedAttribs < .span.allowedAttribs
187 small.allowedAttribs < .span.allowedAttribs
188 strike.allowedAttribs < .span.allowedAttribs
189 strong.allowedAttribs < .span.allowedAttribs
190 sub.allowedAttribs < .span.allowedAttribs
191 sup.allowedAttribs < .span.allowedAttribs
192 tt.allowedAttribs < .span.allowedAttribs
193 u.allowedAttribs < .span.allowedAttribs
194 var.allowedAttribs < .span.allowedAttribs
195 }
196
197 ## REMOVE OPEN OFFICE META DATA TAGS, WORD 2003 TAGS, LINK, META,
198 STYLE AND TITLE TAGS, AND DEPRECATED HTML TAGS
199
200 ## We use this rule instead of the denyTags rule so that we can
201 protect custom tags without protecting these unwanted tags.
202
203 ::
204
205 removeTags = center, font, link, o:p, sdfield, meta, style, title, strike, u
206
207 ## PROTECT CUSTOM TAGS
208
209 ::
210
211 keepNonMatchedTags = protect
212 }
213
214 ::
215
216 HTMLparser_db {
217
218 ## STRIP ALL ATTRIBUTES FROM THESE TAGS
219
220 ## If this list of tags is not set, it will default to:
221 b,i,u,br,center,hr,sub,sup,strong,em,li,ul,ol,blockquote,strike.
222
223 ## However, we want to keep xml:lang attribute on most tags and tags
224 from the default list where cleaned on entry.
225
226 ::
227
228 noAttrib = br
229
230 ## XHTML COMPLIANCE
231
232 ## Note that applying xhtml\_cleaning on exit would break non-standard
233 attributes of typolink tags
234
235 ::
236
237 xhtml_cleaning = 1
238 }
239
240 ::
241
242 exitHTMLparser_db = 1
243 exitHTMLparser_db {
244
245 ## KEEP ALL TAGS
246
247 ## Unwanted tags were removed on entry.
248
249 ## Without this rule, the parser will remove all tags! Presumably,
250 this rule will be more efficient than repeating the allowTags rule
251
252 ::
253
254 keepNonMatchedTags = 1
255
256 ## AVOID CONTENT BEING HSC'ed TWICE
257
258 ::
259
260 htmlSpecialChars = 0
261 }
262 }
263
264 ## Use same RTE processing rules in FE
265
266 ::
267
268 RTE.default.FE.proc < RTE.default.proc
269
270 ## RTE processing rules for bodytext column of tt\_content table
271
272 ## Erase settings from other extensions
273
274 ::
275
276 RTE.config.tt_content.bodytext >
277
278 ## Make sure we use ts\_css transformation
279
280 ::
281
282 RTE.config.tt_content.bodytext.proc.overruleMode = ts_css
283 RTE.config.tt_content.bodytext.types.text.proc.overruleMode = ts_css
284 RTE.config.tt_content.bodytext.types.textpic.proc.overruleMode = ts_css
285
286
287