[BUGFIX] RTE Image Wizard
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / Documentation / Configuration / PageTsconfig / interfaceConfiguration / Index.rst
1 .. include:: ../../../Includes.txt
2 .. highlight:: typoscript
3
4
5 .. _rte-interface-configuration-objects:
6
7 RTE interface configuration objects:
8 """"""""""""""""""""""""""""""""""""
9
10 These objects contain the actual configuration of the RTE interface.
11
12
13 .. _default:
14
15 default.[...]
16 ~~~~~~~~~~~~~
17
18 .. container:: table-row
19
20    Property
21          default.[...]
22
23          config.[ *tablename* ].[ *field* ].[...]
24
25          config.[ *tablename* ].[ *field* ].types.[ *type* ].[...]
26
27    Description
28          These objects contain the actual configuration of the RTE interface.
29          For the properties available, refer to the table below.This is a
30          description of how you can customize in general and override for
31          specific fields/types.
32
33          'RTE.default' configures the RTE for all tables/fields/types
34
35          'RTE.config.[ *tablename* ].[ *field* ]' configures a specific field.
36          The values inherit the values from 'RTE.default' in fact this is
37          overriding values.
38
39          'RTE.config.[ *tablename* ].[ *field* ].types.[ *type* ]' configures a
40          specific field in case the 'type'-value of the field matches  *type* .
41          Again this overrides the former settings.
42
43
44 [page:RTE]
45
46
47
48 .. _rte-interface-configuration-properties:
49
50 RTE interface configuration properties:
51 """""""""""""""""""""""""""""""""""""""
52
53 These properties may be set for each RTE interface configuration
54 object.
55
56
57 .. _disabled:
58
59 disabled
60 ~~~~~~~~
61
62 .. container:: table-row
63
64    Property
65          disabled
66
67    Data type
68          boolean
69
70    Description
71          If set, the editor is disabled.
72
73
74
75 .. _showbuttons:
76
77 showButtons
78 ~~~~~~~~~~~
79
80 .. container:: table-row
81
82    Property
83          showButtons
84
85    Data type
86          list of id-strings
87
88    Description
89          List of buttons that should be enabled in the editor toolbar.
90
91          Note: showButtons = \* shows all available buttons.
92
93          Available buttons are: blockstylelabel, blockstyle, textstylelabel,
94          textstyle, fontstyle, fontsize, formatblock, blockquote,
95          insertparagraphbefore, insertparagraphafter, lefttoright, righttoleft,
96          language, showlanguagemarks, left, center, right, justifyfull,
97          orderedlist, unorderedlist, definitionlist, definitionitem, outdent,
98          indent, formattext, bidioverride, big, bold, citation, code,
99          definition, deletedtext, emphasis, insertedtext, italic, keyboard,
100          monospaced, quotation, sample, small, span, strikethrough, strong,
101          subscript, superscript, underline, variable, textcolor, bgcolor,
102          textindicator, editelement, showmicrodata, emoticon, insertcharacter,
103          insertsofthyphen, line, link, unlink, image, table, user, abbreviation,
104          findreplace, spellcheck, chMode, inserttag, removeformat, copy, cut,
105          paste, pastetoggle, pastebehaviour, undo, redo, about, toggleborders,
106          tableproperties, tablerestyle, rowproperties, rowinsertabove,
107          rowinsertunder, rowdelete, rowsplit, columnproperties,
108          columninsertbefore, columninsertafter, columndelete, columnsplit,
109          cellproperties, cellinsertbefore, cellinsertafter, celldelete,
110          cellsplit, cellmerge
111
112          Note: Buttons textcolor, bgcolor, fontstyle and fontsize are enabled
113          only if «Enable features that use the style attribute> is checked in
114          the extension manager.
115
116          Note: If extension static\_info\_tables is not installed, the
117          spellcheck, language and abbreviation buttons are not enabled.
118
119          Note: If the encoding of the content element is not either iso-8859-1
120          or utf-8, the spellcheck button is not enabled.
121
122          Note: Buttons user and abbreviation are never available in the front end.
123
124          Note: Button unlink is not available if button link is not available.
125
126          Note: None of the table operations buttons is available if the button
127          table is not available.
128
129          Note: Firefox 29+, Opera, Safari 5+ and Chrome 6+ do not support the copy,
130          cut and paste buttons.
131
132
133
134 .. _hidebuttons:
135
136 hideButtons
137 ~~~~~~~~~~~
138
139 .. container:: table-row
140
141    Property
142          hideButtons
143
144    Data type
145          list of id-strings
146
147    Description
148          List of buttons that should not be enabled in the editor toolbar.
149
150
151
152 .. _toolbarorder:
153
154 toolbarOrder
155 ~~~~~~~~~~~~
156
157 .. container:: table-row
158
159    Property
160          toolbarOrder
161
162    Data type
163          list of id-strings
164
165    Description
166          Specifies the order and grouping of buttons in the RTE tool bar. The
167          keywords space, bar and linebreak may be used to insert a space, a
168          separator or a line break at the corresponding position in the tool
169          bar.
170
171          Default: blockstylelabel, blockstyle, space, textstylelabel,
172          textstyle, linebreak,
173
174          bar, formattext, bold, strong, italic, emphasis, big, small,
175          insertedtext, deletedtext, citation, code, definition, keyboard,
176          monospaced, quotation, sample, variable, bidioverride, strikethrough,
177          subscript, superscript, underline, span, bar, fontstyle, space,
178          fontsize, bar, formatblock, blockquote, insertparagraphbefore,
179          insertparagraphafter, bar, lefttoright, righttoleft, language,
180          showlanguagemarks, bar, left, center, right, justifyfull, bar,
181          orderedlist, unorderedlist, definitionlist, definitionitem, outdent,
182          indent, bar, textcolor, bgcolor, textindicator, bar, editelement,
183          showmicrodata, emoticon, insertcharacter, insertsofthyphen, line,
184          link, unlink, image, table, user, abbreviation, bar, findreplace,
185          spellcheck, bar, chMode, inserttag, removeformat, bar, copy, cut,
186          paste, pastetoggle, pastebehaviour, bar, undo, redo, bar, about,
187          linebreak, toggleborders, bar, tableproperties, tablerestyle, bar,
188          rowproperties, rowinsertabove, rowinsertunder, rowdelete, rowsplit,
189          bar, columnproperties, columninsertbefore, columninsertafter,
190          columndelete, columnsplit, bar, cellproperties, cellinsertbefore,
191          cellinsertafter, celldelete, cellsplit, cellmerge
192
193
194
195 .. _keepbuttongrouptogether:
196
197 keepButtonGroupTogether
198 ~~~~~~~~~~~~~~~~~~~~~~~
199
200 .. container:: table-row
201
202    Property
203          keepButtonGroupTogether
204
205    Data type
206          boolean
207
208    Description
209          Specifies that all buttons of a button group are displayed on the same
210          line of the tool bar. A button group is delimited by a linebreak or by
211          a bar.
212
213          Default: 0
214
215          Note: If enabled, the setting is honored only by Mozilla/Firefox and
216          Safari. It is ignored when the browser is Internet Explorer, Opera or
217          Mozilla 1.3.
218
219
220
221 .. _defaultcontentlanguage:
222
223 defaultContentLanguage
224 ~~~~~~~~~~~~~~~~~~~~~~
225
226 .. container:: table-row
227
228    Property
229          defaultContentLanguage
230
231    Data type
232          string
233
234    Description
235          ISO code of default language of content elements. This language is
236          used by RTE features that insert content, usually in the form of
237          values of html tag attributes, when the language of the content
238          element is not specified. This property applies to TYPO3 BE only.
239
240          Default: en
241
242          Note: Any value other than 'en' requires Static Info Tables to be
243          installed.
244
245
246
247 .. _contextmenu-disabled:
248
249 contextMenu.disabled
250 ~~~~~~~~~~~~~~~~~~~~
251
252 .. container:: table-row
253
254    Property
255          contextMenu.disabled
256
257    Data type
258          boolean
259
260    Description
261          If set, the context menu of the RTE triggered by mouse right click is
262          disabled.
263
264          Default: 0
265
266          Note: Context menu is not available in Opera.
267
268
269
270 .. _contextmenu-showbuttons:
271
272 contextMenu.showButtons
273 ~~~~~~~~~~~~~~~~~~~~~~~
274
275 .. container:: table-row
276
277    Property
278          contextMenu.showButtons
279
280    Data type
281          list of id-strings
282
283    Description
284          List of buttons that should be shown in the context menu For the list
285          of available buttons see property showButtons above.
286
287          Default: If not specified, all buttons available in the editor toolbar
288          will appear in the context menu, unless they are removed by property
289          contextMenu.hideButtons.
290
291          Note: Drop-down lists or select boxes will not be shown in the context
292          menu.
293
294          Note: The buttons must be enabled in the editor toolbar.
295
296          Note: The buttons will appear in the same order as in the editor
297          toolbar (see property toolbarOrderabove).
298
299
300
301 .. _contextmenu-hidebuttons:
302
303 contextmenu.hideButtons
304 ~~~~~~~~~~~~~~~~~~~~~~~
305
306 .. container:: table-row
307
308    Property
309          contextmenu.hideButtons
310
311    Data type
312          list of id-strings
313
314    Description
315          List of buttons that should not be shown in the context menu.
316
317
318
319 .. _contextmenu-maxheight:
320
321 contextMenu.maxHeight
322 ~~~~~~~~~~~~~~~~~~~~~
323
324 .. container:: table-row
325
326    Property
327          contextMenu.maxHeight
328
329    Data type
330          int+
331
332    Description
333          Maximum height of the context menu in pixels.
334
335          Default: 300
336
337
338
339 .. _showstatusbar:
340
341 showStatusBar
342 ~~~~~~~~~~~~~
343
344 .. container:: table-row
345
346    Property
347          showStatusBar
348
349    Data type
350          boolean
351
352    Description
353          Specifies that the editor status bar should be displayed or not.
354
355          Default: 0
356
357          Note: showStatusBar is set to 1 in the Typical and Demo default
358          configurations (see chapter on default configurations).
359
360
361
362 .. _buttons-editelement-removefieldsets:
363
364 buttons.editelement.removeFieldsets
365 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
366
367 .. container:: table-row
368
369    Property
370          buttons.editelement.removeFieldsets
371
372    Data type
373          list of id-strings
374
375    Description
376          List of fieldsets to remove from the edit element dialogue.
377
378          Possible string values are: identification, style, language,
379          microdata, events.
380
381
382
383 .. _buttons-editelement-properties-removed:
384
385 buttons.editelement.properties.removed
386 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
387
388 .. container:: table-row
389
390    Property
391          buttons.editelement.properties.removed
392
393    Data type
394          list of id-strings
395
396    Description
397          List of fields to remove from the edit element dialogue.
398
399          Possible string values are: id, title, language, direction, onkeydown,
400          onkeypress, onkeyup, onclick, ondblclick, onmousedown, onmousemove,
401          onmouseout, onmouseover, onmouseup.
402
403
404
405 .. _buttons-formatblock-orderitems:
406
407 buttons.formatblock.orderItems
408 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
409
410 .. container:: table-row
411
412    Property
413          buttons.formatblock.orderItems
414
415    Data type
416          list of id-strings
417
418    Description
419          Specifies the order in which the block element types are presented in
420          the block formating drop-down list.
421
422          The standard block element types are: p, h1, h2, h3, h4, h5, h6, pre,
423          address, article, aside, blockquote, div, footer, header, nav, section
424
425          The list may also contain custom items as specified by the
426          buttons.formatblock.addItems property.
427
428          If not set, the default order will be alphabetical, in the language of
429          the current backend user.
430
431          Note: If set, any option not in the list will be removed from the
432          drop-down list.
433
434
435
436 .. _buttons-formatblock-removeitems:
437
438 buttons.formatblock.removeItems
439 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
440
441 .. container:: table-row
442
443    Property
444          buttons.formatblock.removeItems
445
446    Data type
447          list of id-strings
448
449    Description
450          List of default items to be removed from the block formating drop-down
451          list.
452
453          The default items are: p, h1, h2, h3, h4, h5, h6, pre, address,
454          article, aside, blockquote, div, footer, header, nav, section
455
456
457
458 .. _buttons-formatblock-additems:
459
460 buttons.formatblock.addItems
461 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
462
463 .. container:: table-row
464
465    Property
466          buttons.formatblock.addItems
467
468    Data type
469          list of id-strings
470
471    Description
472          List of custom items to be added to the block formating drop-down
473          list.
474
475          Each of the added items should be configured.
476
477
478
479 .. _buttons-formatblock-items-item-name-label:
480
481 buttons.formatblock.items.[ *item-name* ].label
482 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
483
484 .. container:: table-row
485
486    Property
487          buttons.formatblock.items.[ *item-name* ].label
488
489    Data type
490          string
491
492    Description
493          Alternative label for the option identified by the item name in the
494          block formating drop-down list.
495
496          Note: The string may be a reference to an entry in a localization file
497          of the form LLL:EXT:[ *fileref* ]:[ *labelkey* ]
498
499
500
501 .. _buttons-formatblock-items-item-name-addclass:
502
503 buttons.formatblock.items.[ *item-name* ].addClass
504 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
505
506 .. container:: table-row
507
508    Property
509          buttons.formatblock.items.[ *item-name* ].addClass
510
511    Data type
512          string
513
514    Description
515          A class name to be assigned to the blocks whenever the item is applied
516          to selected text.
517
518          Note: The specified class should be allowed on elements of the block
519          type (using property RTE.default.buttons.blockstyle.tags.[ *tagName*
520          ].allowedClasses).
521
522
523
524 .. _buttons-formatblock-items-item-name-tagname:
525
526 buttons.formatblock.items.[ *item-name* ].tagName
527 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
528
529 .. container:: table-row
530
531    Property
532          buttons.formatblock.items.[ *item-name* ].tagName
533
534    Data type
535          string
536
537    Description
538          A tag name to be assigned to the block elements whenever the (custom)
539          item is applied to selected text.
540
541          The value of this property must be equal to one of the standard block
542          element types.
543
544          Note: [ *item-name* ] must not be a standard block tag name.
545
546          Note: If [ *item-name* ] also has property addClass, then the
547          specified class should be allowed on elements of block type tagName
548          (using property RTE.default.buttons.blockstyle.tags.[ *tagName*
549          ].allowedClasses).
550
551
552
553 .. _buttons-formatblock-prefixlabelwithtag:
554
555 buttons.formatblock.prefixLabelWithTag
556 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
557
558 .. container:: table-row
559
560    Property
561          buttons.formatblock.prefixLabelWithTag
562
563    Data type
564          boolean
565
566    Description
567          If set, the option label in the block formating drop-down list is
568          prefixed with the tagname.
569
570          Default: 0
571
572
573
574 .. _buttons-formatblock-postfixlabelwithtag:
575
576 buttons.formatblock.postfixLabelWithTag
577 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
578
579 .. container:: table-row
580
581    Property
582          buttons.formatblock.postfixLabelWithTag
583
584    Data type
585          boolean
586
587    Description
588          If set, the option label in the block formating drop-down list is
589          postfixed with the tagname.
590
591          Default: 0
592
593
594
595 .. _buttons-formatblock-items-item-name-hotkey:
596
597 buttons.formatblock.items.[ *item-name* ].hotKey
598 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
599
600 .. container:: table-row
601
602    Property
603          buttons.formatblock.items.[ *item-name* ].hotKey
604
605    Data type
606          character
607
608    Description
609          A hotkey will be associated with the option of the block formating
610          drop-down list identified by the item name.
611
612
613
614 .. _buttons-indent-useclass:
615
616 buttons.indent.useClass
617 ~~~~~~~~~~~~~~~~~~~~~~~
618
619 .. container:: table-row
620
621    Property
622          buttons.indent.useClass
623
624    Data type
625          string
626
627    Description
628          Class name to be used when indenting by means of div sections with
629          class attribute.
630
631          Default: indent
632
633
634
635 .. _buttons-indent-useblockquote:
636
637 buttons.indent.useBlockquote
638 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
639
640 .. container:: table-row
641
642    Property
643          buttons.indent.useBlockquote
644
645    Data type
646          boolean
647
648    Description
649          If set, indentation will be produced by means of blockquote tags
650          instead of div sections with class attribute.
651
652          Default: 0
653
654
655
656 .. _buttons-left-useclass:
657
658 buttons.left.useClass
659 ~~~~~~~~~~~~~~~~~~~~~
660
661 .. container:: table-row
662
663    Property
664          buttons.left.useClass
665
666    Data type
667          string
668
669    Description
670          Class name to be used when aligning blocks of text to the left by
671          means of class attribute.
672
673          Default: align-left
674
675          Note: This property is also used for text aligment in table
676          operations.
677
678
679
680 .. _buttons-center-useclass:
681
682 buttons.center.useClass
683 ~~~~~~~~~~~~~~~~~~~~~~~
684
685 .. container:: table-row
686
687    Property
688          buttons.center.useClass
689
690    Data type
691          string
692
693    Description
694          Class name to be used when centering blocks of text by means of class
695          attribute.
696
697          Default: align-center
698
699          Note: This property is also used for text aligment in table
700          operations.
701
702
703
704 .. _buttons-right-useclass:
705
706 buttons.right.useClass
707 ~~~~~~~~~~~~~~~~~~~~~~
708
709 .. container:: table-row
710
711    Property
712          buttons.right.useClass
713
714    Data type
715          string
716
717    Description
718          Class name to be used when aligning blocks of text to the right by
719          means of class attribute.
720
721          Default: align-right
722
723          Note: This property is also used for text aligment in table
724          operations.
725
726
727
728 .. _buttons-justifyfull-useclass:
729
730 buttons.justifyfull.useClass
731 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
732
733 .. container:: table-row
734
735    Property
736          buttons.justifyfull.useClass
737
738    Data type
739          string
740
741    Description
742          Class name to be used when justifying blocks of text to both left and
743          right by means of class attribute.
744
745          Default: align-justify
746
747          Note: This property is also used for text aligment in table
748          operations.
749
750
751
752 .. _buttons-left-usealignattribute:
753
754 buttons.left.useAlignAttribute
755 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
756
757 .. container:: table-row
758
759    Property
760          buttons.left.useAlignAttribute
761
762          buttons.center.useAlignAttribute
763
764          buttons.right.useAlignAttribute
765
766          buttons.justifyfull.useAlignAttribute
767
768    Data type
769          boolean
770
771    Description
772          If anyone of these four properties is set, alignment will be produced
773          by means of align attributes instead of class attributes.
774
775          Default: 0
776
777
778
779 .. _buttons-blockstyle-tags-tag-name-allowedclasses:
780
781 buttons.blockstyle.tags.[ *tag-name* ].allowedClasses
782 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
783
784 .. container:: table-row
785
786    Property
787          buttons.blockstyle.tags.[ *tag-name* ].allowedClasses
788
789    Data type
790          list of id-strings
791
792    Description
793          Specifies the classes allowed for the block element identified by the
794          tag name. Any string in the list may contain wild card characters. The
795          wild card character is "\*" and stands for any sequence of characters.
796
797          The classes must also be defined, using the specific tag selector, in
798          the CSS file specified by the contentCSS property.
799
800          If the property is empty for any tag, classes associated with the
801          given tag in the contentCSS file are used.
802
803          The classes are presented in the drop-down list in alphabetical order
804          in the language used by the backend user.
805
806
807
808 .. _buttons-blockstyle-tags-all-allowedclasses:
809
810 buttons.blockstyle.tags.all.allowedClasses
811 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
812
813 .. container:: table-row
814
815    Property
816          buttons.blockstyle.tags.all.allowedClasses
817
818    Data type
819          list of id-strings
820
821    Description
822          Specifies the classes allowed for all block elements, in addition to
823          the classes allowed for each specific element (see above).
824
825          The classes must also be defined, without any tag selector, in the CSS
826          file specified contentCSS property.
827
828          The classes are presented in the drop-down list in alphabetical order
829          in the language used by the backend user.
830
831
832
833 .. _buttons-blockstyle-showtagfreeclasses:
834
835 buttons.blockstyle.showTagFreeClasses
836 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
837
838 .. container:: table-row
839
840    Property
841          buttons.blockstyle.showTagFreeClasses
842
843    Data type
844          boolean
845
846    Description
847          Specifies that classes not associated with any tag in the contentCSS
848          style sheet should be or should not be shown in the block style drop-
849          down list.
850
851          Default: 0
852
853
854
855 .. _buttons-blockstyle-prefixlabelwithclassname:
856
857 buttons.blockstyle.prefixLabelWithClassName
858 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
859
860 .. container:: table-row
861
862    Property
863          buttons.blockstyle.prefixLabelWithClassName
864
865    Data type
866          boolean
867
868    Description
869          If set, the option name in the block style drop-down list is prefixed
870          with the class name.
871
872          Default: 0
873
874
875
876 .. _buttons-blockstyle-postfixlabelwithclassname:
877
878 buttons.blockstyle.postfixLabelWithClassName
879 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
880
881 .. container:: table-row
882
883    Property
884          buttons.blockstyle.postfixLabelWithClassName
885
886    Data type
887          boolean
888
889    Description
890          If set, the option name e in the block style drop-down list is
891          postfixed with the class name.
892
893          Default: 0
894
895
896
897 .. _buttons-blocktstyle-disablestyleonoptionlabel:
898
899 buttons.blocktstyle.disableStyleOnOptionLabel
900 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
901
902 .. container:: table-row
903
904    Property
905          buttons.blocktstyle.disableStyleOnOptionLabel
906
907    Data type
908          boolean
909
910    Description
911          If set, the styling is removed on the options block styling drop-down
912          list.
913
914          Default: 0
915
916          See value property of RTE.classes array.
917
918
919
920 .. _buttons-formattext-orderitems:
921
922 buttons.formattext.orderItems
923 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
924
925 .. container:: table-row
926
927    Property
928          buttons.formattext.orderItems
929
930    Data type
931          list of id-strings
932
933    Description
934          Specifies the order in which the options, or inline element types, are
935          presented in the text formating drop-down list.
936
937          If not set, the default order will be alphabetical, in the language of
938          the current backend user.
939
940
941
942 .. _buttons-formattext-removeitems:
943
944 buttons.formattext.removeItems
945 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
946
947 .. container:: table-row
948
949    Property
950          buttons.formattext.removeItems
951
952    Data type
953          list of id-strings
954
955    Description
956          List of options to be removed from the text formating drop-down list
957          using same names as toolbar elements.
958
959
960
961 .. _buttons-formattext-prefixlabelwithtag:
962
963 buttons.formattext.prefixLabelWithTag
964 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
965
966 .. container:: table-row
967
968    Property
969          buttons.formattext.prefixLabelWithTag
970
971    Data type
972          boolean
973
974    Description
975          If set, the option name in the text formating drop-down list is
976          prefixed with the tagname.
977
978          Default: 0
979
980
981
982 .. _buttons-formattext-postfixlabelwithtag:
983
984 buttons.formattext.postfixLabelWithTag
985 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
986
987 .. container:: table-row
988
989    Property
990          buttons.formattext.postfixLabelWithTag
991
992    Data type
993          boolean
994
995    Description
996          If set, the option name e in the text formating drop-down list is
997          postfixed with the tagname.
998
999          Default: 0
1000
1001
1002
1003 .. _buttons-textstyle-tags-tag-name-allowedclasses:
1004
1005 buttons.textstyle.tags.[ *tag-name* ].allowedClasses
1006 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1007
1008 .. container:: table-row
1009
1010    Property
1011          buttons.textstyle.tags.[ *tag-name* ].allowedClasses
1012
1013    Data type
1014          list of id-strings
1015
1016    Description
1017          Specifies the classes allowed for each inline element (tag) in the
1018          text styling drop-down list. Any string in the list may contain wild
1019          card characters. The wild card character is "\*" and stands for any
1020          sequence of characters.
1021
1022          Supported tags are: abbr, acronym, b, bdo, big, cite, code, del, dfn,
1023          em, i, ins, kbd, q, samp, small, span, strike, strong, sub, sup, tt,
1024          u, var
1025
1026          The classes must also be defined in the CSS file specified by
1027          contentCSS property.
1028
1029          If the property is empty for any tag, classes associated with the
1030          given tag in the contentCSS file are used.
1031
1032          The classes are presented in the textstyle drop-down list in
1033          alphabetical order in the language used by the backend user.
1034
1035
1036
1037 .. _buttons-textstyle-tags-all-allowedclasses:
1038
1039 buttons.textstyle.tags.all.allowedClasses
1040 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1041
1042 .. container:: table-row
1043
1044    Property
1045          buttons.textstyle.tags.all.allowedClasses
1046
1047    Data type
1048          list of id-strings
1049
1050    Description
1051          Specifies the classes allowed for all inline elements, in addition to
1052          the classes allowed for each specific element (see above).
1053
1054          The classes must also be defined in the CSS file specified by
1055          contentCSS property.
1056
1057          The classes are presented in the drop-down list in alphabetical order
1058          in the language used by the backend user.
1059
1060
1061
1062 .. _buttons-textstyle-showtagfreeclasses:
1063
1064 buttons.textstyle.showTagFreeClasses
1065 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1066
1067 .. container:: table-row
1068
1069    Property
1070          buttons.textstyle.showTagFreeClasses
1071
1072    Data type
1073          boolean
1074
1075    Description
1076          Specifies that classes not associated with any tag in the contentCSS
1077          style sheet should be or should not be shown in the text styling drop-
1078          down list.
1079
1080          Default: 0
1081
1082
1083
1084 .. _buttons-textstyle-prefixlabelwithclassname:
1085
1086 buttons.textstyle.prefixLabelWithClassName
1087 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1088
1089 .. container:: table-row
1090
1091    Property
1092          buttons.textstyle.prefixLabelWithClassName
1093
1094    Data type
1095          boolean
1096
1097    Description
1098          If set, the option name in the text styling drop-down list is prefixed
1099          with the class name.
1100
1101          Default: 0
1102
1103
1104
1105 .. _buttons-textstyle-postfixlabelwithclassname:
1106
1107 buttons.textstyle.postfixLabelWithClassName
1108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1109
1110 .. container:: table-row
1111
1112    Property
1113          buttons.textstyle.postfixLabelWithClassName
1114
1115    Data type
1116          boolean
1117
1118    Description
1119          If set, the option name e in the text styling drop-down list is
1120          postfixed with the class name.
1121
1122          Default: 0
1123
1124
1125
1126 .. _buttons-textstyle-disablestyleonoptionlabel:
1127
1128 buttons.textstyle.disableStyleOnOptionLabel
1129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1130
1131 .. container:: table-row
1132
1133    Property
1134          buttons.textstyle.disableStyleOnOptionLabel
1135
1136    Data type
1137          boolean
1138
1139    Description
1140          If set, the styling is removed on the options text styling drop-down
1141          list.
1142
1143          Default: 0
1144
1145          See value property of RTE.classes array.
1146
1147
1148
1149 .. _buttons-language-restricttoitems:
1150
1151 buttons.language.restrictToItems
1152 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1153
1154 .. container:: table-row
1155
1156    Property
1157          buttons.language.restrictToItems
1158
1159    Data type
1160          list of strings
1161
1162    Description
1163          List of language ISO codes to which the language marking drop-down
1164          list is limited to.
1165
1166          Note: If not set, all languages found in the static\_languages table
1167          will appear in the drop-down list.
1168
1169
1170
1171 .. _buttons-language-uselangattribute:
1172
1173 buttons.language.useLangAttribute
1174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1175
1176 .. container:: table-row
1177
1178    Property
1179          buttons.language.useLangAttribute
1180
1181    Data type
1182          boolean
1183
1184    Description
1185          If set, the lang attribute is used fro language marks.
1186
1187          Default: 1
1188
1189          Note: If both useLangAttribute and useXmlLangAttribute are unset, the
1190          lang attribute will be used.
1191
1192
1193
1194 .. _buttons-language-usexmllangattribute:
1195
1196 buttons.language.useXmlLangAttribute
1197 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1198
1199 .. container:: table-row
1200
1201    Property
1202          buttons.language.useXmlLangAttribute
1203
1204    Data type
1205          boolean
1206
1207    Description
1208          If set, the xml:lang attribute is used fro language marks.
1209
1210          Default: 0
1211
1212
1213
1214 .. _buttons-language-prefixlabelwithcode:
1215
1216 buttons.language.prefixLabelWithCode
1217 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1218
1219 .. container:: table-row
1220
1221    Property
1222          buttons.language.prefixLabelWithCode
1223
1224    Data type
1225          boolean
1226
1227    Description
1228          If set, the option name e in the language marking drop-down list is
1229          prefixed with the language ISO code.
1230
1231          Default: 0
1232
1233
1234
1235 .. _buttons-language-postfixlabelwithcode:
1236
1237 buttons.language.postfixLabelWithCode
1238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1239
1240 .. container:: table-row
1241
1242    Property
1243          buttons.language.postfixLabelWithCode
1244
1245    Data type
1246          boolean
1247
1248    Description
1249          If set, the option name e in the language marking drop-down list is
1250          postfixed with the language ISO code.
1251
1252          Default: 0
1253
1254
1255
1256 .. _buttons-spellcheck-enablepersonaldictionaries:
1257
1258 buttons.spellcheck.enablePersonalDictionaries
1259 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1260
1261 .. container:: table-row
1262
1263    Property
1264          buttons.spellcheck.enablePersonalDictionaries
1265
1266    Data type
1267          boolean
1268
1269    Description
1270          If set, personal dictionaries are enabled.
1271
1272          Default: 0
1273
1274          Note: The feature must also be enabled in User TSconfig.
1275
1276          Note: Personal dictionaries are stored in subdirectories of
1277          uploads/tx\_rtehtmlarea
1278
1279
1280
1281 .. _buttons-spellcheck-dictionaries-restricttoitems:
1282
1283 buttons.spellcheck.dictionaries.restrictToItems
1284 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1285
1286 .. container:: table-row
1287
1288    Property
1289          buttons.spellcheck.dictionaries.restrictToItems
1290
1291    Data type
1292          list-of-id-strings
1293
1294    Description
1295          List of Aspell dictionary codes to which the drop-down list of
1296          dictionaries is limited in the spell checker dialogue.
1297
1298          Note: If not set, all dictionaries obtained from Aspell will appear in
1299          the drop-down list.
1300
1301
1302
1303 .. _buttons-spellcheck-dictionaries-language-iso-code-defaultvalue:
1304
1305 buttons.spellcheck.dictionaries.[ *language-iso-code* ].defaultValue
1306 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1307
1308 .. container:: table-row
1309
1310    Property
1311          buttons.spellcheck.dictionaries.[ *language-iso-code* ].defaultValue
1312
1313    Data type
1314          string
1315
1316    Description
1317          Aspell dictionary code of the dictionary to be used by default to
1318          spell check a content element in the language specified by the ISO
1319          code. The specified dictionary will be pre-selected in the drop-down
1320          list of dictionaries.
1321
1322          Default: the language ISO code.
1323
1324
1325
1326 .. _buttons-image-typo3browser-disabled:
1327
1328 buttons.image.TYPO3Browser.disabled
1329 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1330
1331 .. container:: table-row
1332
1333    Property
1334          buttons.image.TYPO3Browser.disabled
1335
1336    Data type
1337          boolean
1338
1339    Description
1340          If set, the TYPO3 image browser is disabled.
1341
1342          Default: 0
1343
1344          Note: The TYPO3 image browser is never available when the editor is
1345          used in the frontend.
1346
1347
1348
1349 .. _buttons-image-options-imageHandler:
1350
1351 buttons.image.options.imageHandler
1352 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1353
1354 .. container:: table-row
1355
1356    Property
1357          buttons.image.options.imageHandler
1358
1359    Data type
1360          array
1361
1362    Description
1363          Configuration of available image handlers.
1364
1365          Extension developers may add their own handler by adding their own
1366          entry to this array.
1367          The syntax is:
1368
1369          .. code:: ts
1370             <handler-id> {
1371                handler = Vendor\Ext\YourHandlerClass::class
1372                label = LLL:EXT:ext/Resources/Private/Language/locallang.xlf:the_label
1373                displayAfter = image
1374                scanAfter = image
1375             }
1376
1377          For a detailed description of the options, please refer to the link handler documentation.
1378
1379
1380
1381 .. _buttons-image-options-magic-maxwidth:
1382
1383 buttons.image.options.magic.maxWidth
1384 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1385
1386 .. container:: table-row
1387
1388    Property
1389          buttons.image.options.magic.maxWidth
1390
1391    Data type
1392          int+
1393
1394    Description
1395          Maximum width of a magic image in pixels at the time of its initial
1396          insertion.
1397
1398          Default: 300
1399
1400          Note: The width of the magic image may be made larger when updating
1401          the image properties. However, the image is not recreated, only its
1402          HTML width attribute is updated.
1403
1404
1405
1406 .. _buttons-image-options-magic-maxheight:
1407
1408 buttons.image.options.magic.maxHeight
1409 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1410
1411 .. container:: table-row
1412
1413    Property
1414          buttons.image.options.magic.maxHeight
1415
1416    Data type
1417          int+
1418
1419    Description
1420          Maximum height of a magic image in pixels at the time of its initial
1421          insertion.
1422
1423          Default: 1000
1424
1425          Note: By setting a large enough height, images should be resized based
1426          on their width.
1427
1428          Note: The height of the magic image may be made larger when updating
1429          the image properties. However, the image is not recreated, only its
1430          HTML height attribute is updated.
1431
1432
1433
1434 .. _buttons-image-options-plain-maxwidth:
1435
1436 buttons.image.options.plain.maxWidth
1437 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1438
1439 .. container:: table-row
1440
1441    Property
1442          buttons.image.options.plain.maxWidth
1443
1444    Data type
1445          int+
1446
1447    Description
1448          Maximum width of selectable plain images in pixels.
1449
1450          Default: 640
1451
1452
1453
1454 .. _buttons-image-options-plain-maxheight:
1455
1456 buttons.image.options.plain.maxHeight
1457 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1458
1459 .. container:: table-row
1460
1461    Property
1462          buttons.image.options.plain.maxHeight
1463
1464    Data type
1465          int+
1466
1467    Description
1468          Maximum height of selectable plain images in pixels.
1469
1470          Default: 680
1471
1472
1473
1474 .. _buttons-image-properties-removeitems:
1475
1476 buttons.image.properties.removeItems
1477 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1478
1479 .. container:: table-row
1480
1481    Property
1482          buttons.image.properties.removeItems
1483
1484    Data type
1485          list of strings
1486
1487    Description
1488          List of properties to remove from the image properties editing window.
1489          Key list is align, alt, border, class, clickenlarge, float, height,
1490          paddingTop, paddingRight, paddingBottom, paddingLeft, title, width
1491
1492          Note: When a plain image is edited, if proc.plainImageMode is set to
1493          lockDimentions, lockRatio or lockRatioWhenSmaller, the height property
1494          is removed from the properties window. If proc.plainImageMode is set
1495          to lockDimensions, both the width and height properties are removed.
1496
1497
1498
1499 .. _buttons-image-properties-class-allowedclasses:
1500
1501 buttons.image.properties.class.allowedClasses
1502 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1503
1504 .. container:: table-row
1505
1506    Property
1507          buttons.image.properties.class.allowedClasses
1508
1509    Data type
1510          list of id-strings
1511
1512    Description
1513          Classes available in the Insert/Modify image dialogue.
1514
1515          Each of the listed classes must be defined in the CSS file specified
1516          by the contentCSS property.
1517
1518
1519
1520 .. _buttons-image-properties-class-default:
1521
1522 buttons.image.properties.class.default
1523 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1524
1525 .. container:: table-row
1526
1527    Property
1528          buttons.image.properties.class.default
1529
1530    Data type
1531          string
1532
1533    Description
1534          Class to be assigned by default to an image when it is inserted in the
1535          RTE.
1536
1537
1538
1539 .. _buttons-link-typo3browser-disabled:
1540
1541 buttons.link.TYPO3Browser.disabled
1542 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1543
1544 .. container:: table-row
1545
1546    Property
1547          buttons.link.TYPO3Browser.disabled
1548
1549    Data type
1550          boolean
1551
1552    Description
1553          If set, the TYPO3 element browser is disabled.
1554
1555          Default: 0
1556
1557          Note: The TYPO3 element browser is never available when the editor is
1558          used in the frontend.
1559
1560
1561
1562 .. _buttons-link-options-removeitems:
1563
1564 buttons.link.options.removeItems
1565 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1566
1567 .. container:: table-row
1568
1569    Property
1570          buttons.link.options.removeItems
1571
1572    Data type
1573          list of strings
1574
1575    Description
1576          List of tab items to remove from the dialog of the link button.
1577          Possible tab items are: page,file,url,mail
1578
1579          Note: More tabs may be provided by extensions.
1580
1581
1582
1583 .. _buttons-link-targetselector-disabled:
1584
1585 buttons.link.targetSelector.disabled
1586 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1587
1588 .. container:: table-row
1589
1590    Property
1591          buttons.link.targetSelector.disabled
1592
1593    Data type
1594          boolean
1595
1596    Description
1597          If set, the selection of link target is removed from the link
1598          insertion/update dialog.
1599
1600          Default : 0
1601
1602
1603
1604 .. _buttons-link-pageidselector-enabled:
1605
1606 buttons.link.pageIdSelector.enabled
1607 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1608
1609 .. container:: table-row
1610
1611    Property
1612          buttons.link.pageIdSelector.enabled
1613
1614    Data type
1615          boolean
1616
1617    Description
1618          If set, the specification of a page id, without using the page tree,
1619          is enabled in the link insertion/update dialog.
1620
1621          Note: This feature is intended for authors who have to deal with a
1622          very large page tree. Note that the feature is disabled by default.
1623
1624          Default: 0
1625
1626
1627
1628 .. _buttons-link-queryparametersselector-enabled:
1629
1630 buttons.link.queryParametersSelector.enabled
1631 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1632
1633 .. container:: table-row
1634
1635    Property
1636          buttons.link.queryParametersSelector.enabled
1637
1638    Data type
1639          boolean
1640
1641    Description
1642          If set, an additional field is enabbled in the link insertion/update
1643          dialogue allowing authors to specify query parameters to be added on
1644          the link
1645
1646          Default: 0
1647
1648
1649
1650 .. _buttons-link-relattribute-enabled:
1651
1652 buttons.link.relAttribute.enabled
1653 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1654
1655 .. container:: table-row
1656
1657    Property
1658          buttons.link.relAttribute.enabled
1659
1660    Data type
1661          boolean
1662
1663    Description
1664          If set, an additional field is enabled in the link insertion/update
1665          dialogue allowing authors to specify a rel attribute to be added to
1666          the link.
1667
1668          Default: 0
1669
1670
1671
1672 .. _buttons-link-properties-class-allowedclasses:
1673
1674 buttons.link.properties.class.allowedClasses
1675 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1676
1677 .. container:: table-row
1678
1679    Property
1680          buttons.link.properties.class.allowedClasses
1681
1682    Data type
1683          list of id-strings
1684
1685    Description
1686          Classes available in the Insert/Modify link dialogue.
1687
1688          These classes may be defined by the RTE.classesAnchor property.
1689
1690
1691
1692 .. _buttons-link-properties-class-default:
1693
1694 buttons.link.properties.class.default
1695 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1696
1697 .. container:: table-row
1698
1699    Property
1700          buttons.link.properties.class.default
1701
1702    Data type
1703          string
1704
1705    Description
1706          Class to be assigned by default to a link when it is inserted in the
1707          RTE. See also buttons.link.[ *type* ].properties.class.default.
1708
1709
1710
1711 .. _buttons-link-type-properties-class-default:
1712
1713 buttons.link.[ *type* ].properties.class.default
1714 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1715
1716 .. container:: table-row
1717
1718    Property
1719          buttons.link.[ *type* ].properties.class.default
1720
1721    Data type
1722          string
1723
1724    Description
1725          The name of the default class selector for links of the given type.
1726          Possible types are: page, file, url, mail, spec. More types may be
1727          provided by extensions such as DAM.
1728
1729
1730
1731 .. _buttons-link-properties-class-required:
1732
1733 buttons.link.properties.class.required
1734 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1735
1736 .. container:: table-row
1737
1738    Property
1739          buttons.link.properties.class.required
1740
1741    Data type
1742          boolean
1743
1744    Description
1745          If set, a class must be selected for any link. Therefore, the empty
1746          option is removed from the class selector.
1747
1748
1749
1750 .. _buttons-link-type-properties-class-required:
1751
1752 buttons.link.[ *type* ].properties.class.required
1753 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1754
1755 .. container:: table-row
1756
1757    Property
1758          buttons.link.[ *type* ].properties.class.required
1759
1760    Data type
1761          boolean
1762
1763    Description
1764          If set, a class must be selected for any link of the given type.
1765          Therefore, the empty option is removed from the class selector.
1766          Possible types are: page, file, url, mail, spec. More types may be
1767          provided by extensions such as DAM.
1768
1769
1770
1771 .. _buttons-link-properties-title-readonly:
1772
1773 buttons.link.properties.title.readOnly
1774 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1775
1776 .. container:: table-row
1777
1778    Property
1779          buttons.link.properties.title.readOnly
1780
1781    Data type
1782          boolean
1783
1784    Description
1785          If set, the title is set based on the RTE.classesAnchor configuration
1786          and cannot be modified by the author.
1787
1788
1789
1790 .. _buttons-link-type-properties-title-readonly:
1791
1792 buttons.link.[ *type* ].properties.title.readOnly
1793 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1794
1795 .. container:: table-row
1796
1797    Property
1798          buttons.link.[ *type* ].properties.title.readOnly
1799
1800    Data type
1801          boolean
1802
1803    Description
1804          If set, the title for the given type of link is set based on the
1805          RTE.classesAnchor configuration and cannot be modified by the author.
1806          Possible types are: page, file, url, mail, spec. More types may be
1807          provided by extensions such as DAM.
1808
1809
1810
1811 .. _buttons-link-properties-target-default:
1812
1813 buttons.link.properties.target.default
1814 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1815
1816 .. container:: table-row
1817
1818    Property
1819          buttons.link.properties.target.default
1820
1821    Data type
1822          string
1823
1824    Description
1825          This sets the default target for new links in the RTE.
1826
1827          Note: See also the classesAnchor configuration.
1828
1829
1830
1831 .. _buttons-link-type-properties-target-default:
1832
1833 buttons.link.[ *type* ].properties.target.default
1834 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1835
1836 .. container:: table-row
1837
1838    Property
1839          buttons.link.[ *type* ].properties.target.default
1840
1841    Data type
1842          string
1843
1844    Description
1845          Specifies a default target for links of the given type.
1846          Possible types are: page, file, url, mail, spec. More types may be
1847          provided by extensions.
1848
1849          Note: See also the classesAnchor configuration.
1850
1851
1852
1853 .. _buttons-abbreviation-pages:
1854
1855 buttons.abbreviation.pages
1856 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1857
1858 .. container:: table-row
1859
1860    Property
1861          buttons.abbreviation.pages
1862
1863    Data type
1864          list of page id's
1865
1866    Description
1867          List of page id's from which to obtain the abbreviation records.
1868
1869          Note: If not set, the list of current webmounts is used.
1870
1871          Note: In IE, before IE7, the abreviation tab of the abbreviation dialogue
1872          is never shown.
1873
1874
1875
1876 .. _buttons-abbreviation-recursive:
1877
1878 buttons.abbreviation.recursive
1879 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1880
1881 .. container:: table-row
1882
1883    Property
1884          buttons.abbreviation.recursive
1885
1886    Data type
1887          int
1888
1889    Description
1890          The number of levels in the page tree, under each page listed in
1891          buttons.abbreviation.pages or under each webmount, from which abbreviations
1892          are retrieved.
1893
1894          Default: 0
1895
1896
1897
1898 .. _buttons-abbreviation-lockbeusertodbmounts:
1899
1900 buttons.abbreviation.lockBeUserToDBmounts
1901 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1902
1903 .. container:: table-row
1904
1905    Property
1906          buttons.abbreviation.lockBeUserToDBmounts
1907
1908    Data type
1909          boolean
1910
1911    Description
1912          If set, the pid's listed under buttons.abbreviation.pages (see above) are
1913          validated against the user's current webmounts.
1914
1915          If not set or if the user is admin, buttons.abbreviation.pages is ignored
1916          and abbreviations from all pages are retrieved.
1917
1918          Default: The default value of this property is the value of the
1919          property with same name in the backend section of theTYPO3
1920          configuration as set by the Install Tool.
1921
1922
1923
1924 .. _buttons-abbreviation-removefieldsets:
1925
1926 buttons.abbreviation.removeFieldsets
1927 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1928
1929 .. container:: table-row
1930
1931    Property
1932          buttons.abbreviation.removeFieldsets
1933
1934    Data type
1935          list of strings
1936
1937    Description
1938          List of fieldsets to remove from the abbreviation dialogue.
1939
1940          Possible string values are: acronym, definedAcronym, abbreviation,
1941          definedAbbreviation
1942
1943
1944
1945 .. _buttons-acronym-pages:
1946
1947 buttons.acronym.pages
1948 ~~~~~~~~~~~~~~~~~~~~~
1949
1950 .. container:: table-row
1951
1952    Property
1953          This property is deprecated. Use :ref:`buttons.abbreviation.pages <buttons-abbreviation-pages>`
1954
1955
1956
1957 .. _buttons-acronym-recursive:
1958
1959 buttons.acronym.recursive
1960 ~~~~~~~~~~~~~~~~~~~~~~~~~
1961
1962 .. container:: table-row
1963
1964    Property
1965          This property is deprecated. Use :ref:`buttons.abbreviation.recursive <buttons-abbreviation-recursive>`
1966
1967
1968
1969 .. _buttons-acronym-lockbeusertodbmounts:
1970
1971 buttons.acronym.lockBeUserToDBmounts
1972 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1973
1974 .. container:: table-row
1975
1976    Property
1977          This property is deprecated. Use :ref:`buttons.abbreviation.lockBeUserToDBmounts <buttons-abbreviation-lockBeUserToDBmounts>`
1978
1979
1980
1981 .. _colors:
1982
1983 colors
1984 ~~~~~~
1985
1986 .. container:: table-row
1987
1988    Property
1989          colors
1990
1991    Data type
1992          list of id-strings
1993
1994    Description
1995          Defines the specific colors generally available in the color
1996          selectors. The id-strings must be configured in the RTE.colors array
1997          (see description earlier).
1998
1999          **Example:** ::
2000
2001             RTE.default {
2002               colors = color1, color2,noColor
2003             }
2004
2005
2006
2007 .. _disablecolorpicker:
2008
2009 disableColorPicker
2010 ~~~~~~~~~~~~~~~~~~
2011
2012 .. container:: table-row
2013
2014    Property
2015          disableColorPicker
2016
2017    Data type
2018          boolean
2019
2020    Description
2021          Disables the color picker matrix in all color dialogs. The color
2022          picker lets you select web-colors.
2023
2024
2025
2026 .. _buttons-fontstyle-removeitems:
2027
2028 buttons.fontstyle.removeItems
2029 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2030
2031 .. container:: table-row
2032
2033    Property
2034          buttons.fontstyle.removeItems
2035
2036    Data type
2037          list of id-numbers,
2038
2039          \* removes all
2040
2041    Description
2042          Lets you remove any of the default font faces in the Font Style
2043          selector. Values are ranging from 1 to 9. These are the possible
2044          options, and their respective name => value pairs, that you can
2045          remove:
2046
2047          1: Arial => Arial,sans-serif
2048
2049          2: Arial Black => 'Arial Black',sans-serif
2050
2051          3: Verdana => Verdana,Arial,sans-serif
2052
2053          4: 'Times New Roman' => 'Times New Roman',Times,serif
2054
2055          5: Garamond => Garamond
2056
2057          6: Lucida Handwriting => Lucida Handwriting
2058
2059          7: Courier => Courier
2060
2061          8: Webdings => Webdings
2062
2063          9: Wingdings => Wingdings
2064
2065
2066
2067 .. _buttons-fontstyle-additems:
2068
2069 buttons.fontstyle.addItems
2070 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2071
2072 .. container:: table-row
2073
2074    Property
2075          buttons.fontstyle.addItems
2076
2077    Data type
2078          list of id-strings
2079
2080    Description
2081          Defines additional fonts available in the font selector. The id-
2082          strings must be configured in the RTE.fonts array (see description
2083          earlier).
2084
2085
2086
2087 .. _buttons-fontstyle-defaultitem:
2088
2089 buttons.fontstyle.defaultItem
2090 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2091
2092 .. container:: table-row
2093
2094    Property
2095          buttons.fontstyle.defaultItem
2096
2097    Data type
2098          string
2099
2100    Description
2101          Specifies the name of the default font style. The name is the name of
2102          one of the default font faces, or the name associated to one of fonts
2103          configured in the RTE.fonts array (see description earlier).
2104
2105          Note: The value associated to the default font style should be exactly
2106          the same as the value of the default font-family property specified in
2107          the site style sheet as referred to by property
2108          RTE.default.contentCSS.
2109
2110
2111
2112 .. _buttons-fontsize-removeitems:
2113
2114 buttons.fontsize.removeItems
2115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2116
2117 .. container:: table-row
2118
2119    Property
2120          buttons.fontsize.removeItems
2121
2122    Data type
2123          list of size-numbers,
2124
2125          \* removes all
2126
2127    Description
2128          Lets you disable any of the default font sizes available in the Font
2129          Size selector. Values are ranging from 1 to 7. These are the possible
2130          options, and their respective name => value pairs, that you can
2131          remove:
2132
2133          1: Extra small => 8px
2134
2135          2: Very small => 9px
2136
2137          3: Small => 10px
2138
2139          4: Medium => 12px
2140
2141          5: Large => 16px
2142
2143          6: Very large => 24px
2144
2145          7: Extra large => 32px
2146
2147
2148
2149 .. _buttons-fontsize-additems:
2150
2151 buttons.fontsize.addItems
2152 ~~~~~~~~~~~~~~~~~~~~~~~~~
2153
2154 .. container:: table-row
2155
2156    Property
2157          buttons.fontsize.addItems
2158
2159    Data type
2160          list of id-strings
2161
2162    Description
2163          Defines additional font sizes available in the font size selector. The
2164          id-strings must be configured in the RTE.fontSizes array (see
2165          description earlier).
2166
2167
2168
2169 .. _buttons-fontsize-defaultitem:
2170
2171 buttons.fontsize.defaultItem
2172 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2173
2174 .. container:: table-row
2175
2176    Property
2177          buttons.fontsize.defaultItem
2178
2179    Data type
2180          string
2181
2182    Description
2183          Specifies the name of the default font size. The name is the name of
2184          one of the default font sizes, or the name associated to one of font
2185          sizes configured in the RTE.fontSizes array (see description earlier).
2186
2187          Note: The value associated to the default font size should be exactly
2188          the same as the value of the default font-size property specified in
2189          the site style sheet as referred to by property
2190          RTE.default.contentCSS. For correct behaviour in non-IE browsers, the
2191          value of the default font size should be specified in px units.
2192
2193
2194
2195 .. _hidetableoperationsintoolbar:
2196
2197 hideTableOperationsInToolbar
2198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2199
2200 .. container:: table-row
2201
2202    Property
2203          hideTableOperationsInToolbar
2204
2205    Data type
2206          boolean
2207
2208    Description
2209          Specifies that table operations buttons should be hidden in the tool
2210          bar or not.
2211
2212          Default: 0
2213
2214          Note: If enabled, table operations will appear only in the context
2215          menu, provided that they may be enabled in the given context.
2216
2217
2218
2219 .. _buttons-toggleborders-keepintoolbar:
2220
2221 buttons.toggleborders.keepInToolbar
2222 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2223
2224 .. container:: table-row
2225
2226    Property
2227          buttons.toggleborders.keepInToolbar
2228
2229    Data type
2230          boolean
2231
2232    Description
2233          If set, the toggleborders button will be kept in the tool bar even if
2234          property hideTableOperationsInToolbar is set.
2235
2236          Default: 0
2237
2238
2239
2240 .. _buttons-toggleborders-setontablecreation:
2241
2242 buttons.toggleborders.setOnTableCreation
2243 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2244
2245 .. container:: table-row
2246
2247    Property
2248          buttons.toggleborders.setOnTableCreation
2249
2250    Data type
2251          boolean
2252
2253    Description
2254          If set, and if the toggleborders button is enabled, the table borders
2255          will be toggled on when a new table is created.
2256
2257          Default : 0
2258
2259
2260
2261 .. _buttons-toggleborders-setonrteopen:
2262
2263 buttons.toggleborders.setOnRTEOpen
2264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2265
2266 .. container:: table-row
2267
2268    Property
2269          buttons.toggleborders.setOnRTEOpen
2270
2271    Data type
2272          boolean
2273
2274    Description
2275          If set, and if the toggleborders button is enabled, the table borders
2276          will be toggled on when the RTE opens.
2277
2278          Default : 0
2279
2280
2281
2282 .. _buttons-button-name-hotkey:
2283
2284 buttons.[ *button-name* ].hotKey
2285 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2286
2287 .. container:: table-row
2288
2289    Property
2290          buttons.[ *button-name* ].hotKey
2291
2292    Data type
2293          character
2294
2295    Description
2296          A hotkey will be associated with the specified button-name.
2297
2298          Note: Care should be taken that the hotkey does not conflict with pre-
2299          defined hotkeys. If it does, the hotkey will override any previously
2300          registered hotkey.
2301
2302
2303
2304 .. _buttons-button-name-width:
2305
2306 buttons.[ *button-name* ].width
2307 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2308
2309 .. container:: table-row
2310
2311    Property
2312          buttons.[ *button-name* ].width
2313
2314    Data type
2315          int+
2316
2317    Description
2318          The width of the field in the toolbar when the button is a dropdown
2319          list.
2320
2321
2322
2323 .. _buttons-button-name-listwidth:
2324
2325 buttons.[ *button-name* ].listWidth
2326 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2327
2328 .. container:: table-row
2329
2330    Property
2331          buttons.[ *button-name* ].listWidth
2332
2333    Data type
2334          int+
2335
2336    Description
2337          The width of the dropdown list when the button is a dropdown list.
2338
2339          Defauls to the width of the field in the toolbar.
2340
2341
2342
2343 .. _buttons-button-name-maxheight:
2344
2345 buttons.[ *button-name* ].maxHeight
2346 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2347
2348 .. container:: table-row
2349
2350    Property
2351          buttons.[ *button-name* ].maxHeight
2352
2353    Data type
2354          int+
2355
2356    Description
2357          The maximum height of the dropdown list when the button is a dropdown
2358          list.
2359
2360
2361
2362 .. _buttons-button-name-dialoguewindow-width:
2363
2364 buttons.[ *button-name* ].dialogueWindow.width
2365 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2366
2367 .. container:: table-row
2368
2369    Property
2370          buttons.[ *button-name* ].dialogueWindow.width
2371
2372    Data type
2373          int+
2374
2375    Description
2376          The opening width of the dialogue window opened when the button is
2377          pressed.
2378
2379
2380
2381 .. _buttons-button-name-dialoguewindow-height:
2382
2383 buttons.[ *button-name* ].dialogueWindow.height
2384 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2385
2386 .. container:: table-row
2387
2388    Property
2389          buttons.[ *button-name* ].dialogueWindow.height
2390
2391    Data type
2392          int+
2393
2394    Description
2395          The opening height of the dialogue window opened when the button is
2396          pressed.
2397
2398
2399
2400 .. _buttons-button-name-dialoguewindow-positionfromtop:
2401
2402 buttons.[ *button-name* ].dialogueWindow.positionFromTop
2403 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2404
2405 .. container:: table-row
2406
2407    Property
2408          buttons.[ *button-name* ].dialogueWindow.positionFromTop
2409
2410    Data type
2411          int+
2412
2413    Description
2414          The opening position from the top of the screen of the dialogue window
2415          opened when the button is pressed.
2416
2417
2418
2419 .. _buttons-button-name-dialoguewindow-positionfromleft:
2420
2421 buttons.[ *button-name* ].dialogueWindow.positionFromLeft
2422 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2423
2424 .. container:: table-row
2425
2426    Property
2427          buttons.[ *button-name* ].dialogueWindow.positionFromLeft
2428
2429    Data type
2430          int+
2431
2432    Description
2433          The opening position from the left of the screen of the dialogue
2434          window opened when the button is pressed.
2435
2436
2437
2438 .. _buttons-button-name-dialoguewindow-donotresize:
2439
2440 buttons.[ *button-name* ].dialogueWindow.doNotResize
2441 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2442
2443 .. container:: table-row
2444
2445    Property
2446          buttons.[ *button-name* ].dialogueWindow.doNotResize
2447
2448    Data type
2449          boolean
2450
2451    Description
2452          If set, the window that is opened when the button is pressed will not
2453          be resized to its contents.
2454
2455          Default: 0
2456
2457
2458
2459 .. _buttons-button-name-dialoguewindow-donotcenter:
2460
2461 buttons.[ *button-name* ].dialogueWindow.doNotCenter
2462 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2463
2464 .. container:: table-row
2465
2466    Property
2467          buttons.[ *button-name* ].dialogueWindow.doNotCenter
2468
2469    Data type
2470          boolean
2471
2472    Description
2473          If set, the window that is opened when the button is pressed will not
2474          be centered in the parent window.
2475
2476          Default: 0
2477
2478
2479
2480 .. _skin:
2481
2482 skin
2483 ~~~~
2484
2485 .. container:: table-row
2486
2487    Property
2488          skin
2489
2490    Data type
2491          resource
2492
2493    Description
2494          The skin contains the CSS files and the images used to style the
2495          editor.
2496
2497          The skin is specified by specifying the location of the main CSS file
2498          to be used to style the editor. The folder containing the CSS file
2499          MUST also contain a structure of folders and files identical to the
2500          structure found in the folder of the default skin. All folder names
2501          and all file names must be identical.
2502
2503          Default: EXT:rtehtmlarea/htmlarea/skins/default/htmlarea.css
2504
2505          Note: these example skins do not work in Mozilla 1.3; if the property
2506          is set to one of them, the default skin will be used when the browser
2507          is Mozilla 1.3.
2508
2509
2510
2511 .. _contentcss:
2512
2513 contentCSS
2514 ~~~~~~~~~~
2515
2516 .. container:: table-row
2517
2518    Property
2519          contentCSS
2520          contentCSS.[id-string]
2521
2522    Data type
2523          resource(s)
2524
2525    Description
2526          The CSS file that contains the style definitions that should be
2527          applied to the edited contents.
2528
2529          The selectors defined in this file will also be used in the block
2530          style and text style selection lists.
2531
2532          Default: EXT:rtehtmlarea/res/contentcss/default.css
2533
2534          For example, this default could be overridden with:
2535          fileadmin/styles/my\_contentCSS.css
2536
2537          Multiple files may be specified by using contentCSS.[id-string].
2538          For example::
2539
2540             contentCSS {
2541                 file1 = fileadmin/myStylesheet1.css
2542                 file2 = fileadmin/myStylesheet2.css
2543             }
2544
2545
2546
2547 .. _proc:
2548
2549 proc
2550 ~~~~
2551
2552 .. container:: table-row
2553
2554    Property
2555          proc
2556
2557    Data type
2558          ->PROC
2559
2560    Description
2561          Customization of the server processing of the content - also called
2562          'transformations'.
2563
2564          See :ref:`t3api:transformations`
2565
2566
2567
2568 .. _enablewordclean:
2569
2570 enableWordClean
2571 ~~~~~~~~~~~~~~~
2572
2573 .. container:: table-row
2574
2575    Property
2576          enableWordClean
2577
2578    Data type
2579          boolean
2580
2581    Description
2582          Specifies that text pasted from external sources, presumably from
2583          Microsoft Word, should be "cleaned" or not.
2584
2585          Default: 0
2586
2587          Note:If no HTMLparser configuration is specified, a limited default
2588          cleaning operation will be performed. If a HTMLparser specification is
2589          specified, parsing will be performed on the server at the time of the
2590          paste operation.
2591
2592          Note: Additional cleanup may be performed by the user when the
2593          removeformat button is enabled.
2594
2595          Note: Cleaning on paste cannot be performed in Opera.
2596
2597          Note: The same cleaning operation is performed with hotkey CTRL+0,
2598          including in Opera.
2599
2600
2601
2602 .. _enablewordclean_HTMLparser:
2603
2604 enableWordClean.HTMLparser
2605 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2606
2607 .. container:: table-row
2608
2609    Property
2610          enableWordClean.HTMLparser
2611
2612    Data type
2613          boolean/
2614
2615          ->HTMLparser
2616
2617    Description
2618          HTMLparser specification use by the enableWordClean feature.
2619
2620          Default: 0
2621
2622          Note:If no HTMLparser configuration is specified, a limited default
2623          cleaning operation will be performed. If a HTMLparser specification is
2624          specified, parsing will be performed on the server at the time of the
2625          paste operation.
2626
2627          Note: If an HTMLparser configuration is specified, care should be
2628          taken that span tags with id attribute are not removed by the cleaning
2629          operation. If they are removed, the cursor position will not be
2630          restored in non-IE browsers after the paste operation, and the cursor
2631          will then be positionned at the start of the text.
2632
2633
2634
2635 .. _enablewordclean-hotkey:
2636
2637 enableWordClean.hotKey
2638 ~~~~~~~~~~~~~~~~~~~~~~
2639
2640 .. container:: table-row
2641
2642    Property
2643          enableWordClean.hotKey
2644
2645    Data type
2646          character
2647
2648    Description
2649          The default hotkey of the cleaning operation, CTRL+0, is replaced by
2650          CTRL+the specified character.
2651
2652
2653
2654 .. _removecomments:
2655
2656 removeComments
2657 ~~~~~~~~~~~~~~
2658
2659 .. container:: table-row
2660
2661    Property
2662          removeComments
2663
2664    Data type
2665          boolean
2666
2667    Description
2668          Specifies that html comments should be removed or not by the editor on
2669          save and on toggle to HTML source mode.
2670
2671          Default: 0
2672
2673
2674
2675 .. _removetags:
2676
2677 removeTags
2678 ~~~~~~~~~~
2679
2680 .. container:: table-row
2681
2682    Property
2683          removeTags
2684
2685    Data type
2686          list of tags
2687
2688    Description
2689          List of tags that should be removed by the editor on save and on
2690          toggle to HTML source mode.
2691
2692
2693
2694 .. _removetagsandcontents:
2695
2696 removeTagsAndContents
2697 ~~~~~~~~~~~~~~~~~~~~~
2698
2699 .. container:: table-row
2700
2701    Property
2702          removeTagsAndContents
2703
2704    Data type
2705          list of tags
2706
2707    Description
2708          List of tags that should be removed by the editor, contents included,
2709          on save and on toggle to HTML source mode. The tags and the contents
2710          inside the tags will be removed.
2711
2712
2713
2714 .. _customtags:
2715
2716 customTags
2717 ~~~~~~~~~~
2718
2719 .. container:: table-row
2720
2721    Property
2722          customTags
2723
2724    Data type
2725          list of tags
2726
2727    Description
2728          List of custom tags that may appear in content.
2729
2730          Note: When IE is used with standards mode older than IE9, custom tags
2731          are not correctly handle. This list of custom tags is then used to let
2732          them be known to IE so that they are correctly handled by this
2733          browser.
2734
2735
2736
2737 .. _usecss:
2738
2739 useCSS
2740 ~~~~~~
2741
2742 .. container:: table-row
2743
2744    Property
2745          useCSS
2746
2747    Data type
2748          boolean
2749
2750    Description
2751          Specifies that Mozilla/Firefox should use style attributes or not.
2752          When enabled, Mozilla/Firefox use span tags with style attributes
2753          rather than tags such as b, i, font, etc.
2754
2755          Default: 0
2756
2757
2758
2759 .. _disableenterparagraphs:
2760
2761 disableEnterParagraphs
2762 ~~~~~~~~~~~~~~~~~~~~~~
2763
2764 .. container:: table-row
2765
2766    Property
2767          disableEnterParagraphs
2768
2769    Data type
2770          boolean
2771
2772    Description
2773          Specifies that the insertion of paragraphs when hitting the Enter key
2774          in Mozilla/Firefox and Safari should be disabled.
2775
2776          Default: 0
2777
2778          Note: If NOT enabled, the behavior of Mozilla/Firefox and Safari is
2779          modified as follows: when the Enter key is pressed, instead of
2780          inserting a br tag, the behavior of Internet Explorer is simulated and
2781          a new paragraph is created.
2782
2783          Note: If enabled, the behavior of Mozilla/Firefox and Safari is not
2784          modified: a br tag is inserted when the Enter key is pressed.
2785
2786
2787
2788 .. _disableobjectresizing:
2789
2790 disableObjectResizing
2791 ~~~~~~~~~~~~~~~~~~~~~
2792
2793 .. container:: table-row
2794
2795    Property
2796          disableObjectResizing
2797
2798    Data type
2799          boolean
2800
2801    Description
2802          Specifies that Mozilla/Firefox should not provide handles for resizing
2803          objects such as images and tables.
2804
2805          Default: 0
2806
2807
2808
2809 .. _removetrailingbr:
2810
2811 removeTrailingBR
2812 ~~~~~~~~~~~~~~~~
2813
2814 .. container:: table-row
2815
2816    Property
2817          removeTrailingBR
2818
2819    Data type
2820          boolean
2821
2822    Description
2823          Specifies that trailing br tags should be removed from block elements.
2824
2825          Default: 0
2826
2827          Note: If set, any trailing br tag in a block element will be removed
2828          on save and/or change mode. However, multiple trailing br tags will be
2829          preserved.
2830
2831          Note: In Mozilla/Firefox/Netscape, whenever some text is entered in an
2832          empty block, a trailing br tag is added by the browser.
2833
2834
2835
2836 .. _buttons-inserttag-denytags:
2837
2838 buttons.inserttag.denyTags
2839 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2840
2841 .. container:: table-row
2842
2843    Property
2844          buttons.inserttag.denyTags
2845
2846    Data type
2847          list of tags
2848
2849    Description
2850          List of tag names that should NOT be shown by the dialog of the
2851          inserttag button.
2852
2853          Note: Listed tag names should be among the following: a, abbr,
2854          acronym, address, b, big, blockquote, cite, code, div, em, fieldset,
2855          font, h1, h2, h3, h4, h5, h6, i, legend, li, ol, p, pre, q, small,
2856          span, strong, sub, sup, table, tt, ul
2857
2858
2859
2860 .. _buttons-inserttag-allowedattribs:
2861
2862 buttons.inserttag.allowedAttribs
2863 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2864
2865 .. container:: table-row
2866
2867    Property
2868          buttons.inserttag.allowedAttribs
2869
2870    Data type
2871          list of attributes
2872
2873    Description
2874          List of attribute names that should be shown for all tags in the
2875          dialog of the inserttag button.
2876
2877          Note: Listed attribute names should be among the following: class,
2878          dir, id, lang, onFocus, onBlur, onClick, onDblClick, onMouseDown,
2879          onMouseUp, onMouseOver, onMouseMove, onMouseOut, onKeyPress,
2880          onKeyDown, onKeyUp, style, title, xml:lang
2881
2882
2883
2884 .. _buttons-inserttag-tags-tagname-allowedattribs:
2885
2886 buttons.inserttag.tags. *[tagname]* .allowedAttribs
2887 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2888
2889 .. container:: table-row
2890
2891    Property
2892          buttons.inserttag.tags. *[tagname]* .allowedAttribs
2893
2894    Data type
2895          list of attributes
2896
2897    Description
2898          List of attribute names that should be shown for the specified
2899          *tagname* in the dialog of the inserttag button, in addition to the
2900          attribute names specified by property
2901          buttons.inserttag.allowedAttribs.
2902
2903
2904
2905 .. _buttons-table-disableenterparagraphs:
2906
2907 buttons.table.disableEnterParagraphs
2908 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2909
2910 .. container:: table-row
2911
2912    Property
2913          buttons.table.disableEnterParagraphs
2914
2915    Data type
2916          boolean
2917
2918    Description
2919          If set, this property will prevent the insertion of paragraphs in
2920          table cells when the enter key is pressed.
2921
2922          Default: 0
2923
2924
2925
2926 .. _buttons-table-enablehandles:
2927
2928 buttons.table.enableHandles
2929 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2930
2931 .. container:: table-row
2932
2933    Property
2934          buttons.table.enableHandles
2935
2936    Data type
2937          boolean
2938
2939    Description
2940          If set, table handles will be enabled in Firefox. These Firefox-
2941          specific handles allow to delete/insert rows and columns using small
2942          handles displayed on table borders. However, insert operations also
2943          add a style attribute on inserted cells.
2944
2945          Default: 0
2946
2947
2948
2949 .. _disablealignmentfieldsetintableoperations:
2950
2951 disableAlignmentFieldsetInTableOperations
2952 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2953
2954 .. container:: table-row
2955
2956    Property
2957          disableAlignmentFieldsetInTableOperations
2958
2959          disableSpacingFieldsetInTableOperations
2960
2961          disableColorFieldsetInTableOperations
2962
2963          disableLayoutFieldsetInTableOperations
2964
2965          disableBordersFieldsetInTableOperations
2966
2967    Data type
2968          boolean
2969
2970    Description
2971          Disables the corresponding fieldset in all table operations dialogues.
2972
2973          Default: 0
2974
2975
2976
2977 .. _buttons-table-removefieldsets:
2978
2979 buttons.table.removeFieldsets
2980 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2981
2982 .. container:: table-row
2983
2984    Property
2985          buttons.table.removeFieldsets
2986
2987    Data type
2988          list of strings
2989
2990    Description
2991          List of fieldsets to remove from the table creation dialogue. Key list
2992          is alignment, borders, color, description, language, layout, spacing,
2993          style
2994
2995
2996
2997 .. _buttons-tableproperties-removefieldsets:
2998
2999 buttons.tableproperties.removeFieldsets
3000 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3001
3002 .. container:: table-row
3003
3004    Property
3005          buttons.tableproperties.removeFieldsets
3006
3007    Data type
3008          list of strings
3009
3010    Description
3011          List of fieldsets to remove from the table properties edition
3012          dialogue. Key list is alignment, borders, color, description,
3013          language, layout, spacing, style
3014
3015
3016
3017 .. _buttons-table-properties-required:
3018
3019 buttons.table.properties.required
3020 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3021
3022 .. container:: table-row
3023
3024    Property
3025          buttons.table.properties.required
3026
3027    Data type
3028          list of strings
3029
3030    Description
3031          List of fields for which a value is required in the table creation and
3032          table properties edition dialogues. Possible values are: caption,
3033          summary, captionOrSummary
3034
3035
3036
3037 .. _buttons-table-properties-removed:
3038
3039 buttons.table.properties.removed
3040 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3041
3042 .. container:: table-row
3043
3044    Property
3045          buttons.table.properties.removed
3046
3047    Data type
3048          list of strings
3049
3050    Description
3051          List of fields to remove from the table creation and table properties
3052          edition dialogues. Possible values are: width, height, float, headers,
3053          language, direction
3054
3055
3056
3057 .. _buttons-table-properties-numberofrows-defaultvalue:
3058
3059 buttons.table.properties.numberOfRows.defaultValue
3060 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3061
3062 .. container:: table-row
3063
3064    Property
3065          buttons.table.properties.numberOfRows.defaultValue
3066
3067    Data type
3068          int+
3069
3070    Description
3071          Default value for the number of rows to include in a table on
3072          creation.
3073
3074          Default: 2
3075
3076
3077
3078 .. _buttons-table-properties-numberofcolumns-defaultvalue:
3079
3080 buttons.table.properties.numberOfColumns.defaultValue
3081 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3082
3083 .. container:: table-row
3084
3085    Property
3086          buttons.table.properties.numberOfColumns.defaultValue
3087
3088    Data type
3089          int+
3090
3091    Description
3092          Default value for the number of columns to include in a table on
3093          creation.
3094
3095          Default: 4
3096
3097
3098
3099 .. _buttons-table-properties-headers-defaultvalue:
3100
3101 buttons.table.properties.headers.defaultValue
3102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3103
3104 .. container:: table-row
3105
3106    Property
3107          buttons.table.properties.headers.defaultValue
3108
3109    Data type
3110          string
3111
3112    Description
3113          Default selected option in the headers layout selector in the table
3114          creation dialogue. Possible values are: none, top, left, both
3115
3116          Default: top
3117
3118
3119
3120 .. _buttons-table-properties-headers-removeitems:
3121
3122 buttons.table.properties.headers.removeItems
3123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3124
3125 .. container:: table-row
3126
3127    Property
3128          buttons.table.properties.headers.removeItems
3129
3130    Data type
3131          list of strings
3132
3133    Description
3134          List of items to remove from the headers layout selector in the table
3135          creation dialogue. Key list is: none, top, left, both
3136
3137          Default: void
3138
3139
3140
3141 .. _buttons-table-properties-headers-both-useheaderclass:
3142
3143 buttons.table.properties.headers.both.useHeaderClass
3144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3145
3146 .. container:: table-row
3147
3148    Property
3149          buttons.table.properties.headers.both.useHeaderClass
3150
3151    Data type
3152          list of strings
3153
3154    Description
3155          A class to be assigned to the top row when the headers property
3156          specifies both.
3157
3158          Default: thead
3159
3160
3161
3162 .. _buttons-table-properties-tableclass-defaultvalue:
3163
3164 buttons.table.properties.tableClass.defaultValue
3165 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3166
3167 .. container:: table-row
3168
3169    Property
3170          buttons.table.properties.tableClass.defaultValue
3171
3172    Data type
3173          string
3174
3175    Description
3176          Default selected class in the table class selector in the table
3177          creation dialogue.
3178
3179          Default: void
3180
3181
3182
3183 .. _buttons-table-properties-width-defaultvalue:
3184
3185 buttons.table.properties.width.defaultValue
3186 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3187
3188 .. container:: table-row
3189
3190    Property
3191          buttons.table.properties.width.defaultValue
3192
3193    Data type
3194          +int
3195
3196    Description
3197          Default value of the table wdth in the table creation dialogue.
3198
3199          Default: void
3200
3201
3202
3203 .. _buttons-table-properties-widthunit-defaultvalue:
3204
3205 buttons.table.properties.widthUnit.defaultValue
3206 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3207
3208 .. container:: table-row
3209
3210    Property
3211          buttons.table.properties.widthUnit.defaultValue
3212
3213    Data type
3214          string
3215
3216    Description
3217          Default selected unit in the width unit selector in the table creation
3218          dialogue. Possible values are: %, px or em
3219
3220          Default: %
3221
3222
3223
3224 .. _buttons-table-properties-widthunit-removeitems:
3225
3226 buttons.table.properties.widthUnit.removeItems
3227 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3228
3229 .. container:: table-row
3230
3231    Property
3232          buttons.table.properties.widthUnit.removeItems
3233
3234    Data type
3235          list of strings
3236
3237    Description
3238          List of items to remove from the table width unit selector in the
3239          table creation dialogue. Key list is: %, px, em
3240
3241          Default: void
3242
3243
3244
3245 .. _buttons-table-properties-height-defaultvalue:
3246
3247 buttons.table.properties.height.defaultValue
3248 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3249
3250 .. container:: table-row
3251
3252    Property
3253          buttons.table.properties.height.defaultValue
3254
3255    Data type
3256          +int
3257
3258    Description
3259          Default value of the table height in the table creation dialogue.
3260
3261          Default: void
3262
3263
3264
3265 .. _buttons-table-properties-heightunit-defaultvalue:
3266
3267 buttons.table.properties.heightUnit.defaultValue
3268 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3269
3270 .. container:: table-row
3271
3272    Property
3273          buttons.table.properties.heightUnit.defaultValue
3274
3275    Data type
3276          string
3277
3278    Description
3279          Default selected unit in the height unit selector in the table
3280          creation dialogue. Possible values are: %, px or em
3281
3282          Default: %
3283
3284
3285
3286 .. _buttons-table-properties-heightunit-removeitems:
3287
3288 buttons.table.properties.heightUnit.removeItems
3289 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3290
3291 .. container:: table-row
3292
3293    Property
3294          buttons.table.properties.heightUnit.removeItems
3295
3296    Data type
3297          list of strings
3298
3299    Description
3300          List of items to remove from the table height unit selector in the
3301          table creation dialogue. Key list is: %, px, em
3302
3303          Default: void
3304
3305
3306
3307 .. _buttons-table-properties-float-defaultvalue:
3308
3309 buttons.table.properties.float.defaultValue
3310 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3311
3312 .. container:: table-row
3313
3314    Property
3315          buttons.table.properties.float.defaultValue
3316
3317    Data type
3318          string
3319
3320    Description
3321          Default selected option in the table float selector in the table
3322          creation and properties edition dialogues.. Possible values are: not
3323          set, left, right
3324
3325          Default: not set
3326
3327
3328
3329 .. _buttons-table-properties-float-left-useclass:
3330
3331 buttons.table.properties.float.left.useClass
3332 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3333
3334 .. container:: table-row
3335
3336    Property
3337          buttons.table.properties.float.left.useClass
3338
3339    Data type
3340          string
3341
3342    Description
3343          Class name to be assigned when left is selected in the table float
3344          selector in the table creation and properties edition dialogues.
3345
3346          Default: float-left
3347
3348
3349
3350 .. _buttons-table-properties-float-right-useclass:
3351
3352 buttons.table.properties.float.right.useClass
3353 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3354
3355 .. container:: table-row
3356
3357    Property
3358          buttons.table.properties.float.right.useClass
3359
3360    Data type
3361          string
3362
3363    Description
3364          Class name to be assigned when right is selected in the table float
3365          selector in the table creation and properties edition dialogues.
3366
3367          Default: float-right
3368
3369
3370
3371 .. _buttons-table-properties-float-removeitems:
3372
3373 buttons.table.properties.float.removeItems
3374 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3375
3376 .. container:: table-row
3377
3378    Property
3379          buttons.table.properties.float.removeItems
3380
3381    Data type
3382          list of strings
3383
3384    Description
3385          List of items to remove from the table float selector in the table
3386          creation and properties edition dialogues. Key list is: not set, left,
3387          right
3388
3389          Default: void
3390
3391
3392
3393 .. _buttons-table-properties-cellpadding-defaultvalue:
3394
3395 buttons.table.properties.cellpadding.defaultValue
3396 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3397
3398 .. container:: table-row
3399
3400    Property
3401          buttons.table.properties.cellpadding.defaultValue
3402
3403    Data type
3404          +int
3405
3406    Description
3407          Default value of the table cellpadding attribute in the table creation
3408          and properties edition dialogues
3409
3410          Default: void
3411
3412
3413
3414 .. _buttons-table-properties-cellspacing-defaultvalue:
3415
3416 buttons.table.properties.cellspacing.defaultValue
3417 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3418
3419 .. container:: table-row
3420
3421    Property
3422          buttons.table.properties.cellspacing.defaultValue
3423
3424    Data type
3425          +int
3426
3427    Description
3428          Default value of the table cellspacing attribute in the table creation
3429          and properties edition dialogues .
3430
3431          Default: void
3432
3433
3434
3435 .. _buttons-table-properties-borderwidth-defaultvalue:
3436
3437 buttons.table.properties.borderWidth.defaultValue
3438 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3439
3440 .. container:: table-row
3441
3442    Property
3443          buttons.table.properties.borderWidth.defaultValue
3444
3445    Data type
3446          +int
3447
3448    Description
3449          Default value of the table border width attribute in the table
3450          creation and properties edition dialogues
3451
3452          Default: void
3453
3454
3455
3456 .. _buttons-table-properties-borderstyle-defaultvalue:
3457
3458 buttons.table.properties.borderStyle.defaultValue
3459 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3460
3461 .. container:: table-row
3462
3463    Property
3464          buttons.table.properties.borderStyle.defaultValue
3465
3466    Data type
3467          string
3468
3469    Description
3470          Default selected style in the border style selector in the table
3471          creation dialogue. Possible values are: not set, none, dotted, dashed,
3472          solid, double, groove, ridge, inset, outset
3473
3474          Default: not set
3475
3476
3477
3478 .. _buttons-table-properties-borderstyle-removeitems:
3479
3480 buttons.table.properties.borderStyle.removeItems
3481 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3482
3483 .. container:: table-row
3484
3485    Property
3486          buttons.table.properties.borderStyle.removeItems
3487
3488    Data type
3489          list of strings
3490
3491    Description
3492          List of items to remove from the table border style selector in the
3493          table creation dialogue. Key list is: not set, none, dotted, dashed,
3494          solid, double, groove, ridge, inset, outset
3495
3496          Default: void
3497
3498
3499
3500 .. _buttons-rowproperties-removefieldsets:
3501
3502 buttons.rowproperties.removeFieldsets
3503 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3504
3505 .. container:: table-row
3506
3507    Property
3508          buttons.rowproperties.removeFieldsets
3509
3510    Data type
3511          list of strings
3512
3513    Description
3514          List of fieldsets to remove from the table row properties edition
3515          dialogue. Key list is alignment, borders, color, language, layout,
3516          rowgroup, style
3517
3518          Default: void
3519
3520
3521
3522 .. _buttons-rowproperties-properties-removed:
3523
3524 buttons.rowproperties.properties.removed
3525 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3526
3527 .. container:: table-row
3528
3529    Property
3530          buttons.rowproperties.properties.removed
3531
3532    Data type
3533          list of strings
3534
3535    Description
3536          List of fields to remove from the table row properties edition
3537          dialogue. Possible values are: width, height, language, direction
3538
3539          Default: void
3540
3541
3542
3543 .. _buttons-rowproperties-properties-width-defaultvalue:
3544
3545 buttons.rowproperties.properties.width.defaultValue
3546 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3547
3548 .. container:: table-row
3549
3550    Property
3551          buttons.rowproperties.properties.width.defaultValue
3552
3553    Data type
3554          +int
3555
3556    Description
3557          Default value of the row wdth in the table row properties edition
3558          dialogue.
3559
3560          Default: void
3561
3562
3563
3564 .. _buttons-rowproperties-properties-widthunit-defaultvalue:
3565
3566 buttons.rowproperties.properties.widthUnit.defaultValue
3567 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3568
3569 .. container:: table-row
3570
3571    Property
3572          buttons.rowproperties.properties.widthUnit.defaultValue
3573
3574    Data type
3575          string
3576
3577    Description
3578          Default selected unit in the row width unit selector in the table row
3579          properties edition dialogue. Possible values are: %, px or em
3580
3581          Default: %
3582
3583
3584
3585 .. _buttons-rowproperties-properties-widthunit-removeitems:
3586
3587 buttons.rowproperties.properties.widthUnit.removeItems
3588 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3589
3590 .. container:: table-row
3591
3592    Property
3593          buttons.rowproperties.properties.widthUnit.removeItems
3594
3595    Data type
3596          list of strings
3597
3598    Description
3599          List of items to remove from the row width unit selector in the table
3600          row properties edition dialogue. Key list is: %, px, em
3601
3602          Default: void
3603
3604
3605
3606 .. _buttons-rowproperties-properties-height-defaultvalue:
3607
3608 buttons.rowproperties.properties.height.defaultValue
3609 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3610
3611 .. container:: table-row
3612
3613    Property
3614          buttons.rowproperties.properties.height.defaultValue
3615
3616    Data type
3617          +int
3618