[TASK] Reformat rtehtmlarea documentation
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / Documentation / DefaultConfigurations / Typical / Index.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6 .. include:: ../../Includes.txt
7
8
9
10 .. _typical-configuration:
11
12 Typical default configuration
13 -----------------------------
14
15 This default configuration establishes default settings in Page TSconfig and User TSconfig with most commonly used features representing a good start for typical sites.
16
17
18 .. _typical-page-tsconfig:
19
20 The following is inserted in Page TSconfig:
21 """""""""""""""""""""""""""""""""""""""""""
22
23 Define labels and styles to be applied to class selectors in the interface of the RTE
24
25 The examples included here make partial re-use of color scheme and frame scheme from CSS Styled Content extension
26
27 ::
28
29    RTE.classes {
30       align-left {
31          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_tooltips.xlf:justifyleft
32          value = text-align: left;
33       }
34       align-center {
35          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_tooltips.xlf:justifycenter
36          value = text-align: center;
37       }
38       align-right {
39          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_tooltips.xlf:justifyright
40          value = text-align: right;
41       }
42       csc-frame-frame1 {
43          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_contentcss.xlf:frame-frame1
44          value = background-color: #EDEBF1; border: 1px solid #333333;
45       }
46       csc-frame-frame2 {
47          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_contentcss.xlf:frame-frame2
48          value = background-color: #F5FFAA; border: 1px solid #333333;
49       }
50       important {
51          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_contentcss.xlf:important
52          value = color: #8A0020;
53       }
54       name-of-person {
55          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_contentcss.xlf:name-of-person
56          value = color: #10007B;
57       }
58       detail {
59          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_contentcss.xlf:detail
60          value = color: #186900;
61       }
62       component-items {
63          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_contentcss.xlf:component-items
64          value = color: #186900;
65       }
66       action-items {
67          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_contentcss.xlf:action-items
68          value = color: #8A0020;
69       }
70       component-items-ordered {
71          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_contentcss.xlf:component-items
72          value = color: #186900;
73       }
74       action-items-ordered {
75          name = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_contentcss.xlf:action-items
76          value = color: #8A0020;
77       }
78    }
79
80 Anchor classes configuration for use by the anchor accesibility feature
81
82 ::
83
84    RTE.classesAnchor {
85       externalLink {
86          class = external-link
87          type = url
88          titleText = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_accessibilityicons.xlf:external_link_titleText
89       }
90       externalLinkInNewWindow {
91          class = external-link-new-window
92          type = url
93          titleText = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_accessibilityicons.xlf:external_link_new_window_titleText
94       }
95       internalLink {
96          class = internal-link
97          type = page
98          titleText = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_accessibilityicons.xlf:internal_link_titleText
99       }
100       internalLinkInNewWindow {
101          class = internal-link-new-window
102          type = page
103          titleText = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_accessibilityicons.xlf:internal_link_new_window_titleText
104       }
105       download {
106          class = download
107          type = file
108          titleText = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_accessibilityicons.xlf:download_titleText
109       }
110       mail {
111          class = mail
112          type = mail
113          titleText = LLL:EXT:rtehtmlarea/Resources/Private/Language/locallang_accessibilityicons.xlf:mail_titleText
114       }
115    }
116
117 Default RTE configuration
118 ^^^^^^^^^^^^^^^^^^^^^^^^^
119
120 ::
121
122    RTE.default {
123
124 Markup options
125 ^^^^^^^^^^^^^^
126
127 ::
128
129       enableWordClean = 1
130       removeTrailingBR = 1
131       removeComments = 1
132       removeTags = center, font, o:p, sdfield, strike, u
133       removeTagsAndContents = link, meta, script, style, title
134
135 Toolbar options
136 ^^^^^^^^^^^^^^^
137
138 The TCA configuration may add buttons to the toolbar
139
140 ::
141
142       showButtons = blockstylelabel, blockstyle, textstylelabel, textstyle
143       showButtons := addToList(formatblock, bold, italic, subscript, superscript)
144       showButtons := addToList(orderedlist, unorderedlist, outdent, indent, textindicator)
145       showButtons := addToList(insertcharacter, link, table, findreplace, chMode, removeformat, undo, redo, about)
146       showButtons := addToList(toggleborders, tableproperties)
147       showButtons := addToList(rowproperties, rowinsertabove, rowinsertunder, rowdelete, rowsplit)
148       showButtons := addToList(columninsertbefore, columninsertafter, columndelete, columnsplit)
149       showButtons := addToList(cellproperties, cellinsertbefore, cellinsertafter, celldelete, cellsplit, cellmerge)
150
151 More toolbar options
152
153 ::
154
155       keepButtonGroupTogether = 1
156
157 Enable status bar
158
159 ::
160
161       showStatusBar =  1
162
163 Hide infrequently used block types in the block formatting selector
164
165 ::
166
167       buttons.formatblock.removeItems = pre,address
168
169 List all class selectors that are allowed on the way to the database
170
171 ::
172
173       proc.allowedClasses = external-link, external-link-new-window, internal-link, internal-link-new-window, download, mail
174       proc.allowedClasses := addToList(align-left, align-center, align-right, align-justify)
175       proc.allowedClasses := addToList(csc-frame-frame1, csc-frame-frame2)
176       proc.allowedClasses := addToList(component-items, action-items)
177       proc.allowedClasses := addToList(component-items-ordered, action-items-ordered)
178       proc.allowedClasses := addToList(important, name-of-person, detail)
179       proc.allowedClasses := addToList(indent)
180
181 Restrict the list of class selectors presented by the RTE to the following for the specified tags:
182
183 ::
184
185       buttons.blockstyle.tags.div.allowedClasses = align-left, align-center, align-right
186       buttons.blockstyle.tags.div.allowedClasses := addToList(csc-frame-frame1, csc-frame-frame2)
187       buttons.blockstyle.tags.table.allowedClasses = csc-frame-frame1, csc-frame-frame2
188       buttons.blockstyle.tags.td.allowedClasses = align-left, align-center, align-right
189       buttons.textstyle.tags.span.allowedClasses = important, name-of-person, detail
190
191 Configuration of classes for links
192
193 These classes should also be in the list proc.allowedClasses
194
195 ::
196
197       buttons.link.properties.class.allowedClasses = external-link, external-link-new-window, internal-link, internal-link-new-window, download, mail
198       buttons.link.page.properties.class.default = internal-link
199       buttons.link.url.properties.class.default = external-link-new-window
200       buttons.link.file.properties.class.default = download
201       buttons.link.mail.properties.class.default = mail
202
203 Configuration specific to the TableOperations feature
204
205 Remove the following fieldsets from the properties popups
206
207 ::
208
209       disableAlignmentFieldsetInTableOperations = 1
210       disableSpacingFieldsetInTableOperations = 1
211       disableColorFieldsetInTableOperations = 1
212       disableLayoutFieldsetInTableOperations = 1
213
214 Show borders on table creation
215
216 ::
217
218       buttons.toggleborders.setOnTableCreation = 1
219
220 Configuration specific to the bold and italic buttons
221
222 Add hotkeys associated with bold and italic buttons
223
224 ::
225
226       buttons.bold.hotKey = b
227       buttons.italic.hotKey = i
228
229 Configuration of microdata schema
230
231 ::
232
233       schema {
234          sources {
235             schemaOrg = EXT:rtehtmlarea/extensions/MicrodataSchema/res/schemaOrgAll.rdf
236          }
237       }
238    }
239
240 Frontend RTE configuration for the general public
241
242 ::
243
244    RTE.default.FE < RTE.default
245    RTE.default.FE.showStatusBar = 0
246    RTE.default.FE.hideButtons = chMode, blockstyle, textstyle, underline, strikethrough, subscript, superscript, lefttoright, righttoleft, left, center, right, justifyfull, table, inserttag, findreplace, removeformat, copy, cut, paste
247    RTE.default.FE.userElements >
248
249 tt\_content TCEFORM configuration
250
251 Let use all the space available for more comfort.
252
253 ::
254
255    TCEFORM.tt_content.bodytext.RTEfullScreenWidth = 100%
256
257
258 .. _typical-user-tsconfig:
259
260 The following is inserted in User TSconfig:
261 """""""""""""""""""""""""""""""""""""""""""
262
263 Enable the RTE by default for all users
264
265 ::
266
267    setup.default.edit_RTE = 1