[!!!][TASK] RTE: locallang inferno
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / Documentation / DefaultConfigurations / Demo / Index.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6 .. include:: ../../Includes.txt
7
8
9
10 .. _demo-configuration:
11
12 Demo default configuration
13 --------------------------
14
15 This default configuration sets Page TSconfig and User TSconfig with
16 as many features as possible for users who want to explore the
17 features of the RTE. This is  **not** recommended for production
18 environments.
19
20
21 .. _demo-page-tsconfig:
22
23 The following is inserted in Page TSconfig:
24 """""""""""""""""""""""""""""""""""""""""""
25
26 ## Define labels and styles to be applied to class selectors in the
27 interface of the RTE
28
29 ## Partial re-use of color scheme and frame scheme from CSS Styled
30 Content extension
31
32 ::
33
34    RTE.classes {
35            align-left {
36                    name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_tooltips.xlf:justifyleft
37                    value = text-align: left;
38            }
39            align-center {
40                    name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_tooltips.xlf:justifycenter
41                    value = text-align: center;
42            }
43            align-right {
44                    name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_tooltips.xlf:justifyright
45                    value = text-align: right;
46            }
47            csc-frame-frame1 {
48                    name = LLL:EXT:rtehtmlarea/res/contentcss/locallang.xlf:frame-frame1
49                    value = background-color: #EDEBF1; border: 1px solid #333333;
50            }
51            csc-frame-frame2 {
52                    name = LLL:EXT:rtehtmlarea/res/contentcss/locallang.xlf:frame-frame2
53                    value = background-color: #F5FFAA; border: 1px solid #333333;
54            }
55            important {
56                    name = LLL:EXT:rtehtmlarea/res/contentcss/locallang.xlf:important
57                    value = color: #8A0020;
58            }
59            name-of-person {
60                    name = LLL:EXT:rtehtmlarea/res/contentcss/locallang.xlf:name-of-person
61                    value = color: #10007B;
62            }
63            detail {
64                    name = LLL:EXT:rtehtmlarea/res/contentcss/locallang.xlf:detail
65                    value = color: #186900;
66            }
67            component-items {
68                    name = LLL:EXT:rtehtmlarea/res/contentcss/locallang.xlf:component-items
69                    value = color: #186900;
70            }
71            action-items {
72                    name = LLL:EXT:rtehtmlarea/res/contentcss/locallang.xlf:action-items
73                    value = color: #8A0020;
74            }
75            component-items-ordered {
76                    name = LLL:EXT:rtehtmlarea/res/contentcss/locallang.xlf:component-items
77                    value = color: #186900;
78            }
79            action-items-ordered {
80                    name = LLL:EXT:rtehtmlarea/res/contentcss/locallang.xlf:action-items
81                    value = color: #8A0020;
82            }
83    }
84
85 ## Anchor classes configuration for use by the anchor accessibility
86 feature
87
88 ::
89
90    RTE.classesAnchor {
91            externalLink {
92                    class = external-link
93                    type = url
94                    image = EXT:rtehtmlarea/res/accessibilityicons/img/external_link.gif
95                    altText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:external_link_altText
96                    titleText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:external_link_titleText
97            }
98            externalLinkInNewWindow {
99                    class = external-link-new-window
100                    type = url
101                    image = EXT:rtehtmlarea/res/accessibilityicons/img/external_link_new_window.gif
102                    altText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:external_link_new_window_altText
103                    titleText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:external_link_new_window_titleText
104            }
105            internalLink {
106                    class = internal-link
107                    type = page
108                    image = EXT:rtehtmlarea/res/accessibilityicons/img/internal_link.gif
109                    altText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:internal_link_altText
110                    titleText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:internal_link_titleText
111            }
112            internalLinkInNewWindow {
113                    class = internal-link-new-window
114                    type = page
115                    image = EXT:rtehtmlarea/res/accessibilityicons/img/internal_link_new_window.gif
116                    altText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:internal_link_new_window_altText
117                    titleText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:internal_link_new_window_titleText
118            }
119            download {
120                    class = download
121                    type = file
122                    image = EXT:rtehtmlarea/res/accessibilityicons/img/download.gif
123                    altText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:download_altText
124                    titleText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:download_titleText
125            }
126            mail {
127                    class = mail
128                    type = mail
129                    image = EXT:rtehtmlarea/res/accessibilityicons/img/mail.gif
130                    altText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:mail_altText
131                    titleText = LLL:EXT:rtehtmlarea/res/accessibilityicons/locallang.xlf:mail_titleText
132            }
133    }
134
135 ## Default RTE configuration
136
137 ::
138
139    RTE.default {
140
141 ## Markup options
142
143 ::
144
145       enableWordClean = 1
146       removeTrailingBR = 1
147       removeComments = 1
148       removeTags = center, o:p, sdfield
149       removeTagsAndContents = link, meta, script, style, title
150
151 ## Allow img tags
152
153 ::
154
155       proc.entryHTMLparser_db.tags.img >
156
157 ## Allow style attributes on p and span tags
158
159 ::
160
161       proc.entryHTMLparser_db.tags {
162               p.allowedAttribs := addToList(style)
163               span.fixAttrib.style.unset >
164       }
165
166 ## Toolbar options
167
168 ::
169
170       showButtons = *
171
172 ## More toolbar options
173
174 ::
175
176       keepButtonGroupTogether = 1
177
178 ## Enable status bar
179
180 ::
181
182       showStatusBar = 1
183
184            )
185
186 ## For this demo, do not remove font, strike and u tags
187
188 ::
189
190       proc.entryHTMLparser_db.removeTags := removeFromList(font,strike,u)
191
192
193 ## List all class selectors that are allowed on the way to the
194 database
195
196 ::
197
198       proc.allowedClasses = external-link, external-link-new-window, internal-link, internal-link-new-window, download, mail
199       proc.allowedClasses := addToList(align-left, align-center, align-right, align-justify)
200       proc.allowedClasses := addToList(csc-frame-frame1, csc-frame-frame2)
201       proc.allowedClasses := addToList(component-items, action-items)
202       proc.allowedClasses := addToList(component-items-ordered, action-items-ordered)
203       proc.allowedClasses := addToList(important, name-of-person, detail)
204       proc.allowedClasses := addToList(indent)
205
206 ## Restrict the list of class selectors presented by the RTE to the
207 following for the specified tags:
208
209 ::
210
211       buttons.blockstyle.tags.div.allowedClasses = align-left, align-center, align-right
212       buttons.blockstyle.tags.div.allowedClasses := addToList(csc-frame-frame1, csc-frame-frame2)
213       buttons.blockstyle.tags.table.allowedClasses = csc-frame-frame1, csc-frame-frame2
214       buttons.blockstyle.tags.td.allowedClasses = align-left, align-center, align-right
215       buttons.textstyle.tags.span.allowedClasses = important, name-of-person, detail
216
217 ## Configuration of classes for links
218
219 ## These classes should also be in the list proc.allowedClasses
220
221 ::
222
223       buttons.link.properties.class.allowedClasses = external-link, external-link-new-window, internal-link, internal-link-new-window, download, mail
224       buttons.link.page.properties.class.default = internal-link
225       buttons.link.url.properties.class.default = external-link-new-window
226       buttons.link.file.properties.class.default = download
227       buttons.link.mail.properties.class.default = mail
228
229 ## Show all applicable class selectors available in the style sheet
230 file
231
232 ::
233
234       buttons.blockstyle.showTagFreeClasses = 1
235       buttons.textstyle.showTagFreeClasses = 1
236
237 ## Configuration specific to the table button or TableOperations
238 feature
239
240 ## Use the context menu instead of the toolbar for table operations,
241 but keep toggleborders button in toolbar
242
243 ## Show borders on table creation
244
245 ::
246
247       hideTableOperationsInToolbar = 1
248       buttons.toggleborders.keepInToolbar = 1
249       buttons.toggleborders.setOnTableCreation = 1
250
251 ## Configuration specific to the inserttag button or QuickTag feature
252
253 ## Do not allow insertion of the following tags
254
255 ::
256
257       buttons.inserttag.denyTags = font, underline, strike, table
258
259 ## Configuration specific to the bold and italic buttons
260
261 ## Add hotkeys associated with bold, italic, strikethrough and
262 underline buttons
263
264 ::
265
266       buttons.bold.hotKey = b
267       buttons.italic.hotKey = i
268       buttons.strikethrough.hotKey = s
269       buttons.underline.hotkey = u
270
271 ## Configuration specific to the spellcheck button or SpellCheck
272 feature
273
274 ## Enable the use of personal dictionaries
275
276 ::
277
278       buttons.spellcheck.enablePersonalDictionaries = 1
279
280 ## Configuration of microdata schema
281
282 ::
283
284       schema {
285                    sources {
286                            schemaOrg = EXT:rtehtmlarea/extensions/MicrodataSchema/res/schemaOrgAll.rdf
287                    }
288            }
289    }
290
291 ## Use same processing as on entry to database to clean content pasted
292 into the editor
293
294 ::
295
296    RTE.default.enableWordClean.HTMLparser < RTE.default.proc.entryHTMLparser_db
297
298 ## front end RTE configuration
299
300 ::
301
302    RTE.default.FE < RTE.default
303    RTE.default.FE.userElements >
304    RTE.default.FE.userLinks >
305
306 ## tt\_content TCEFORM configuration
307
308 ## Let use all the space available for more comfort.
309
310 ::
311
312    TCEFORM.tt_content.bodytext.RTEfullScreenWidth = 100%
313
314
315 .. _the-following-is-inserted-in-user-tsconfig:
316
317 The following is inserted in User TSconfig:
318 """""""""""""""""""""""""""""""""""""""""""
319
320 ## Enable the RTE by default for all users
321
322 ::
323
324    setup.default.edit_RTE = 1
325
326 ## Enable the file upload feature of the element browser by default
327 for all users
328
329 ::
330
331    options.uploadFieldsInTopOfEB = 1
332
333 ## Set the default spelling ability of the check speller for all users
334
335 ::
336
337    options.HTMLAreaPspellMode = bad-spellers
338
339 ## Enable the personal dictionary feature of the check speller by
340 default for all users
341
342 ::
343
344    options.enablePersonalDicts = 1
345
346
347