[TASK] Add action selector in toolbar in workspaces menu
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / Documentation / Configuration / UserTsconfig / Index.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6 .. include:: ../../Includes.txt
7
8
9
10 .. _user-tsconfig:
11
12 User TSconfig
13 -------------
14
15 Upon installation, the extension will set default properties in User
16 TSconfig as specified by the extension configuration variable:
17 **Default configuration settings**. Three default configurations are
18 available: Minimal, Typical, and Demo. These default configurations
19 are documented in the next section of the present document.
20
21 These properties may be modified for any particular BE user or BE user
22 group, with the TYPO3 User Admin Tool. Properties of User TSconfig are
23 documented in the :ref:`TSconfig reference <t3tsconfig:usertsconfig>`.
24
25
26 .. _setup-default-edit-rte:
27
28 setup.default.edit\_RTE
29 ^^^^^^^^^^^^^^^^^^^^^^^
30
31 .. container:: table-row
32
33    Property
34          setup.default.edit\_RTE
35
36    Data type
37          boolean
38
39    Description
40          Specifies that RTE editing should be enabled or disabled by default.
41
42
43
44 .. _setup-override-edit-rte:
45
46 setup.override.edit\_RTE
47 ^^^^^^^^^^^^^^^^^^^^^^^^
48
49 .. container:: table-row
50
51    Property
52          setup.override.edit\_RTE
53
54    Data type
55          boolean
56
57    Description
58          Specifies that RTE editing should be enabled or disabled, the user not
59          being allowed to change the setting.
60
61
62
63 .. _setup-default-rtewidth:
64
65 setup.default.rteWidth
66 ^^^^^^^^^^^^^^^^^^^^^^
67
68 .. container:: table-row
69
70    Property
71          setup.default.rteWidth
72
73    Data type
74          int+/%
75
76    Description
77          If set, specifies the default width of the RTE editing area. The
78          specified value overrides the calculated width of the RTE editing
79          area. Note that a percentage may be specified.
80
81          Note: The property is ignored in IE if the value is a percentage.
82
83
84
85 .. _setup-override-rtewidth:
86
87 setup.override.rteWidth
88 ^^^^^^^^^^^^^^^^^^^^^^^
89
90 .. container:: table-row
91
92    Property
93          setup.override.rteWidth
94
95    Data type
96          int+/%
97
98    Description
99          If set, specifies the width of the RTE editing area, the user not
100          being allowed to change the setting. The specified value overrides the
101          calculated width of the RTE editing area. Note that a percentage may
102          be specified.
103
104          Note: The property is ignored in IE if the value is a percentage.
105
106
107
108 .. _setup-default-rteheight:
109
110 setup.default.rteHeight
111 ^^^^^^^^^^^^^^^^^^^^^^^
112
113 .. container:: table-row
114
115    Property
116          setup.default.rteHeight
117
118    Data type
119          int+
120
121    Description
122          If set, specifies the default height of the RTE editing area. The
123          specified value overrides the calculated height of the RTE editing
124          area. This includes the height of the toolbar, of the editing area and
125          of the status bar.
126
127
128
129 .. _setup-override-rteheight:
130
131 setup.override.rteHeight
132 ^^^^^^^^^^^^^^^^^^^^^^^^
133
134 .. container:: table-row
135
136    Property
137          setup.override.rteHeight
138
139    Data type
140          int+
141
142    Description
143          If set, specifies the height of the RTE editing area, the user not
144          being allowed to change the setting. The specified value overrides the
145          calculated height of the RTE editing area. This includes the height of
146          the toolbar, of the editing area and of the status bar.
147
148
149
150 .. _setup-default-rteresize:
151
152 setup.default.rteResize
153 ^^^^^^^^^^^^^^^^^^^^^^^
154
155 .. container:: table-row
156
157    Property
158          setup.default.rteResize
159
160    Data type
161          boolean
162
163    Description
164          Specifies whether or not the RTE is resizable by default.
165
166
167
168 .. _setup-override-rteresize:
169
170 setup.override.rteResize
171 ^^^^^^^^^^^^^^^^^^^^^^^^
172
173 .. container:: table-row
174
175    Property
176          setup.override.rteResize
177
178    Data type
179          boolean
180
181    Description
182          Specifies whether or not the RTE is resizable, the user not being
183          allowed to change the setting.
184
185
186
187 .. _setup-default-rtemaxheight:
188
189 setup.default.rteMaxHeight
190 ^^^^^^^^^^^^^^^^^^^^^^^^^^
191
192 .. container:: table-row
193
194    Property
195          setup.default.rteMaxHeight
196
197    Data type
198          int+
199
200    Description
201          If set, and if the RTE is resizable, specifies the default maximal
202          height of the RTE, including the tool bar, the editing area and the
203          status bar.
204
205
206
207 .. _setup-override-rtemaxheight:
208
209 setup.override.rteMaxHeight
210 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
211
212 .. container:: table-row
213
214    Property
215          setup.override.rteMaxHeight
216
217    Data type
218          int+
219
220    Description
221          If set, and if the RTE is resizable, specifies the default maximal
222          height of the RTE, including the tool bar, the editing area and the
223          status bar, the user not being allowed to change the setting.
224
225
226
227 .. _setup-default-rtecleanpastebehaviour:
228
229 setup.default.rteCleanPasteBehaviour
230 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
231
232 .. container:: table-row
233
234    Property
235          setup.default.rteCleanPasteBehaviour
236
237    Data type
238          string
239
240    Description
241          If set, specifies the default clean paste behaviour when the
242          pastetoggle button is ON.
243
244          Possible values are: plainText, pasteStructure, pasteFormat.
245
246
247
248 .. _setup-override-rtecleanpastebehaviour:
249
250 setup.override.rteCleanPasteBehaviour
251 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
252
253 .. container:: table-row
254
255    Property
256          setup.override.rteCleanPasteBehaviour
257
258    Data type
259          string
260
261    Description
262          If set, specifies the clean paste behaviour when the pastetoggle
263          button is ON, the user not being allowed to change the setting
264
265          Possible values are: plainText, pasteStructure, pasteFormat.
266
267
268
269 .. _options-rtekeylist:
270
271 options.RTEkeyList
272 ^^^^^^^^^^^^^^^^^^
273
274 .. container:: table-row
275
276    Property
277          options.RTEkeyList
278
279    Data type
280          list of id-strings
281
282    Description
283          Specifies the list of RTE buttons to which the BE user or BE user
284          group is restricted.
285
286          Default: \* (means all)
287
288          Note: For the list of possible buttons, see property showButtons of
289          Page TsConfig.
290
291
292
293 .. _options-htmlareapspellmode:
294
295 options.HTMLAreaPspellMode
296 ^^^^^^^^^^^^^^^^^^^^^^^^^^
297
298 .. container:: table-row
299
300    Property
301          options.HTMLAreaPspellMode
302
303    Data type
304          string
305
306    Description
307          Specifies the mode of spelling suggestions. Possible values are:
308          ultra, fast, normal or bad-spellers.
309
310          Default: normal
311
312          Note: For more information on spelling suggestions modes, see `Notes
313          on the Different Suggestion Modes <http://aspell.net/man-html/Notes-
314          on-the-Different-Suggestion-
315          Modes.html#Notes%20on%20the%20Different%20Suggestion%20Modes>`_ ).
316
317
318
319 .. _options-enablepersonaldicts:
320
321 options.enablePersonalDicts
322 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
323
324 .. container:: table-row
325
326    Property
327          options.enablePersonalDicts
328
329    Data type
330          boolean
331
332    Description
333          Enables the personal dictionaries feature for the user or user group,
334          when the feature is enabled in Page TSconfig.
335
336          Default: 0
337
338          Note: The feature must also be enabled in Page TSconfig.
339
340
341
342 .. _options-uploadfieldsintopofeb:
343
344 options.uploadFieldsInTopOfEB
345 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
346
347 .. container:: table-row
348
349    Property
350          options.uploadFieldsInTopOfEB
351
352    Data type
353          boolean
354
355    Description
356          Inserts a file uploader on the 'file' tab of the Insert/Modify link
357          dialogue as well as on the magic, plain and dragdrop tabs of the
358          Insert/modify image dialogue.
359
360          Note: This applies only when buttons.link.TYPO3Browser.disabled and/or
361          buttons.image.TYPO3Browser.disabled is not set.
362
363          Default: 0
364
365
366
367 .. _options-createfoldersineb:
368
369 options.createFoldersInEB
370 ^^^^^^^^^^^^^^^^^^^^^^^^^
371
372 .. container:: table-row
373
374    Property
375          options.createFoldersInEB
376
377    Data type
378          boolean
379
380    Description
381          If set, a create folders option appears in the TYPO3 file browser.
382
383          Note: This applies only when buttons.link.TYPO3Browser.disabled and/or
384          buttons.image.TYPO3Browser.disabled is not set.
385
386          Note: For admin-users this is always enabled.
387
388          Default: 0
389
390
391
392 .. _options-nothumbsinrteimageselect:
393
394 options.noThumbsInRTEimageSelect
395 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
396
397 .. container:: table-row
398
399    Property
400          options.noThumbsInRTEimageSelect
401
402    Data type
403          boolean
404
405    Description
406          If set, then image thumbnails are not shown in the image selector.
407
408          Default: 0
409
410
411
412 .. _options-rtesmallwidth:
413
414 options.RTESmallWidth
415 ^^^^^^^^^^^^^^^^^^^^^
416
417 .. container:: table-row
418
419    Property
420          options.RTESmallWidth
421
422          options.RTESmallHeight
423
424    Data type
425          pixels
426
427    Description
428          Width and height of the editor area when edit\_wideDocument is NOT
429          set.
430
431          Default: RTESmallWidth = 530, RTESmallHeight = 380
432
433
434
435 .. _options-rtelargewidthincrement:
436
437 options.RTELargeWidthIncrement
438 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
439
440 .. container:: table-row
441
442    Property
443          options.RTELargeWidthIncrement
444
445          options.RTELargeHeightIncrement
446
447    Data type
448          pixels
449
450    Description
451          Increments applied to the width and height of the editor area when
452          edit\_wideDocument IS set.
453
454          Default: RTELargeWidthIncrement= 150, RTELargeHeilghtIncrement = 0
455
456
457
458 .. _page-rte-default-buttons-formatblock-restricttoitems:
459
460 page.RTE.default.buttons.formatblock.restrictToItems
461 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
462
463 .. container:: table-row
464
465    Property
466          page.RTE.default.buttons.formatblock.restrictToItems
467
468    Data type
469          list of id-strings
470
471    Description
472          List of options to which the user will be restricted in the block
473          formating drop-down list.
474
475          The available options are: p, h1, h2, h3, h4, h5, h6, pre, address,
476          article, aside, blockquote, div, footer, header, nav, section
477
478
479
480 .. _page-rte-default-buttons-formattext-restrictto:
481
482 page.RTE.default.buttons.formattext.restrictTo
483 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
484
485 .. container:: table-row
486
487    Property
488          page.RTE.default.buttons.formattext.restrictTo
489
490    Data type
491          list of id-strings
492
493    Description
494          Restricts the availability of options, or inline element types, in the
495          text formating drop-down list.
496
497          Default: \* (means all)
498
499