[TASK] Remove old language labels in EXT:setup
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Documentation / Administration / WizardSettings / DefaultsReference / OptionsTab / Index.rst
1 .. include:: ../../../../Includes.txt
2
3
4 .. _wizard-settings-defaults-options-tab:
5
6 =============
7 Tab "Options"
8 =============
9
10 The options tab will show the configuration of a particular element in
11 the form. When no element has been selected, it will show a message that
12 the editor has to select an element in the form.
13
14 The content of this tab depends on the type of element the editor has chosen
15 in the form.
16
17 .. figure:: ../../../../Images/FormCreationWizardOptionsTab.png
18     :alt: The form wizard with the tab "Options".
19
20 .. contents::
21     :local:
22     :depth: 1
23
24
25 .. _wizard-settings-defaults-options-showaccordions:
26
27 showAccordions
28 ==============
29
30 :aspect:`Property:`
31     showAccordions
32
33 :aspect:`TypoScript Path:`
34     :ts:`mod.wizards.form.defaults.tabs.options.showAccordions`
35
36 :aspect:`Data type:`
37     string
38
39 :aspect:`Description:`
40     Comma-separated list of the accordions that are allowed to be shown
41     in the wizard. This does not mean they are all shown by default,
42     but depends on the chosen element type.
43
44     Some tabs have further configuration which is described below.
45
46 :aspect:`Default:`
47     The following accordions are available:
48
49     - *legend*: Legend Properties
50     - *label*: :ref:`Label Properties <wizard-settings-defaults-options-label>`
51     - *attributes*: :ref:`Attributes Properties <wizard-settings-defaults-options-attributes>`
52     - *options*: Field Options
53     - *validation*: :ref:`Validation <wizard-settings-defaults-validation-label>`
54     - *filters*: :ref:`Filters <wizard-settings-defaults-filters-label>`
55     - *various*: Various Properties
56
57 :aspect:`Example:`
58     .. code-block:: typoscript
59
60       mod.wizards {
61         form {
62           defaults {
63             tabs {
64               options {
65                 showAccordions = legend, label, attributes, options, validation, filters, various
66               }
67             }
68           }
69
70         }
71       }
72
73
74 .. _wizard-settings-defaults-options-label:
75
76 Label accordion
77 ===============
78
79
80 .. _wizard-settings-defaults-options-label-showproperties:
81
82 showProperties
83 --------------
84
85 :aspect:`Property:`
86     showProperties
87
88 :aspect:`TypoScript Path:`
89     :ts:`mod.wizards.form.defaults.tabs.options.accordions.label.showProperties`
90
91 :aspect:`Data type:`
92     string
93
94 :aspect:`Description:`
95     Comma-separated list of the label options that are allowed to be shown
96     in the accordion. The appearance of an option depends on the chosen
97     element type. If an element type does not support an option, it will not
98     be shown.
99
100 :aspect:`Default:`
101     label
102
103
104 .. _wizard-settings-defaults-options-attributes:
105
106 Attributes accordion
107 ====================
108
109
110 .. _wizard-settings-defaults-options-attributes-showproperties:
111
112 showProperties
113 --------------
114
115 :aspect:`Property:`
116     showProperties
117
118 :aspect:`TypoScript Path:`
119     :ts:`mod.wizards.form.defaults.tabs.options.accordions.attributes.showProperties`
120
121 :aspect:`Data type:`
122     string
123
124 :aspect:`Description:`
125     Comma-separated list of attributes that are allowed to be shown in the
126     accordion. The appearance of an attribute depends on the chosen element
127     type. If an element type does not support an attribute, it will not be
128     shown.
129
130
131 :aspect:`Default:`
132     accept, accept-charset, accesskey, action, alt, autocomplete, autofocus,
133     checked, class, cols, contenteditable, contextmenu, dir, draggable,
134     dropzone, disabled, enctype, hidden, height, id, inputmode, label, lang,
135     list, max, maxlength, method, min, minlength, multiple, name,
136     novalidate, pattern, placeholder, readonly, required, rows, selected,
137     selectionDirection, selectionEnd, selectionStart, size, spellcheck, src,
138     step, style, tabindex, text, title, translate, type, value, width, wrap
139
140
141 .. _wizard-settings-defaults-validation-label:
142
143 Validation accordion
144 ====================
145
146
147 .. _wizard-settings-defaults-options-validation-showrules:
148
149 showRules
150 ---------
151
152 :aspect:`Property:`
153     showRules
154
155 :aspect:`TypoScript Path:`
156     :ts:`mod.wizards.form.defaults.tabs.options.accordions.validation.showRules`
157
158 :aspect:`Data type:`
159     string
160
161 :aspect:`Description:`
162     Comma-separated list of rules that are allowed to be shown in the
163     wizard.
164
165 :aspect:`Default:`
166     alphabetic, alphanumeric, between, date, digit, email, equals,
167     fileallowedtypes, filemaximumsize, fileminimumsize, float, greaterthan,
168     inarray, integer, ip, length, lessthan, regexp, required, uri
169
170
171 .. _wizard-settings-defaults-options-validation-rules:
172
173 rules.[rule].showProperties
174 ---------------------------
175
176 :aspect:`Property:`
177     rules.[rule].showProperties
178
179 :aspect:`TypoScript Path:`
180     :ts:`mod.wizards.form.defaults.tabs.options.accordions.validation.rules.[rule].showProperties`
181
182 :aspect:`Data type:`
183     [array of objects]
184
185 :aspect:`Description:`
186     For each rule one can define which properties should appear.
187     The syntax is :ts:`rules.[name of the rule].showProperties`.
188
189 :aspect:`Default:`
190     The following element properties are available:
191
192     =================== ========================================================
193     Element             Properties
194     =================== ========================================================
195     alphabetic          message, error, showMessage, allowWhiteSpace
196     alphanumeric        message, error, showMessage, allowWhiteSpace
197     between             message, error, showMessage, minimum, maximum, inclusive
198     date                message, error, showMessage, format
199     digit               message, error, showMessage
200     email               message, error, showMessage
201     equals              message, error, showMessage, field
202     fileallowedtypes    message, error, showMessage, types
203     filemaximumsize     message, error, showMessage, maximum
204     fileminimumsize     message, error, showMessage, minimum
205     float               message, error, showMessage
206     greaterthan         message, error, showMessage, minimum
207     inarray             message, error, showMessage, array, strict
208     integer             message, error, showMessage
209     ip                  message, error, showMessage
210     length              message, error, showMessage, minimum, maximum
211     lessthan            message, error, showMessage, maximum
212     regexp              message, error, showMessage, expression
213     required            message, error, showMessage
214     uri                 message, error, showMessage
215     =================== ========================================================
216
217
218 .. _wizard-settings-defaults-filters-label:
219
220 Filters accordion
221 =================
222
223
224 .. _wizard-settings-defaults-options-filtering-showfilters:
225
226 showFilters
227 -----------
228
229 :aspect:`Property:`
230     showFilters
231
232 :aspect:`TypoScript Path:`
233     :ts:`mod.wizards.form.defaults.tabs.options.accordions.filtering.showFilters`
234
235 :aspect:`Data type:`
236     string
237
238 :aspect:`Description:`
239     Comma-separated list of the filters that are allowed to be shown in
240     the wizard.
241
242     For each filter a list of properties to be shown can be defined.
243
244 :aspect:`Default:`
245     alphabetic, alphanumeric, currency, digit, integer, lowercase, regexp,
246     stripnewlines, titlecase, trim, uppercase
247
248
249 .. _wizard-settings-defaults-options-filtering-filters:
250
251 filters.[filter].showProperties
252 -------------------------------
253
254 :aspect:`Property:`
255     filters.[filter].showProperties
256
257 :aspect:`TypoScript Path:`
258     :ts:`mod.wizards.form.defaults.tabs.options.accordions.filtering.filters.[filter].showProperties`
259
260 :aspect:`Data type:`
261     string
262
263 :aspect:`Description:`
264     Configuration for the filters individually. Not all filters have a
265     configuration. Only the filters which are mentioned below can be
266     configured.
267
268     The syntax is :ts:`filters.[name of the filter].showProperties`.
269
270 :aspect:`Default:`
271     The following element properties are available:
272
273     =================== ===============================
274     Element             Properties
275     =================== ===============================
276     alphabetic          allowWhiteSpace
277     alphanumeric        allowWhiteSpace
278     currency            decimalPoint, thousandSeparator
279     regexp              expression
280     trim                characterList
281     =================== ===============================
282
283
284 .. _wizard-settings-defaults-options-tab-configuration:
285
286 Default configuration
287 =====================
288
289 The default configuration of the options tab looks like this:
290
291 .. code-block:: typoscript
292
293   options {
294      showAccordions = legend, label, attributes, options, validation, filters, various
295      accordions {
296          label {
297             showProperties = label
298          }
299          attributes {
300             showProperties = accept, accept-charset, accesskey, action, alt, autocomplete, autofocus, checked, class, cols, contenteditable, contextmenu, dir, draggable, dropzone, disabled, enctype, hidden, height, id, inputmode, label, lang, list, max, maxlength, method, min, minlength, multiple, name, novalidate, pattern, placeholder, readonly, required, rows, selected, selectionDirection, selectionEnd, selectionStart, size, spellcheck, src, step, style, tabindex, text, title, translate, type, value, width, wrap
301          }
302          validation {
303             showRules = alphabetic, alphanumeric, between, date, digit, email, equals, fileallowedtypes, filemaximumsize, fileminimumsize, float, greaterthan, inarray, integer, ip, length, lessthan, regexp, required, uri
304             rules {
305                alphabetic {
306                   showProperties = message, error, showMessage, allowWhiteSpace
307                }
308                alphanumeric {
309                   showProperties = message, error, showMessage, allowWhiteSpace
310                }
311                between {
312                   showProperties = message, error, showMessage, minimum, maximum, inclusive
313                }
314                date {
315                   showProperties = message, error, showMessage, format
316                }
317                digit {
318                   showProperties = message, error, showMessage
319                }
320                email {
321                   showProperties = message, error, showMessage
322                }
323                equals {
324                   showProperties = message, error, showMessage, field
325                }
326                fileallowedtypes {
327                   showProperties = message, error, showMessage, types
328                }
329                filemaximumsize {
330                   showProperties = message, error, showMessage, maximum
331                }
332                fileminimumsize {
333                   showProperties = message, error, showMessage, minimum
334                }
335                float {
336                   showProperties = message, error, showMessage
337                }
338                greaterthan {
339                   showProperties = message, error, showMessage, minimum
340                }
341                inarray {
342                   showProperties = message, error, showMessage, array, strict
343                }
344                integer {
345                   showProperties = message, error, showMessage
346                }
347                ip {
348                   showProperties = message, error, showMessage
349                }
350                length {
351                   showProperties = message, error, showMessage, minimum, maximum
352                }
353                lessthan {
354                   showProperties = message, error, showMessage, maximum
355                }
356                regexp {
357                   showProperties = message, error, showMessage, expression
358                }
359                required {
360                   showProperties = message, error, showMessage
361                }
362                uri {
363                   showProperties = message, error, showMessage
364                }
365             }
366          }
367          filtering {
368             showFilters = alphabetic, alphanumeric, currency, digit, integer, lowercase, regexp, stripnewlines, titlecase, trim, uppercase
369             filters {
370                alphabetic {
371                   showProperties = allowWhiteSpace
372                }
373                alphanumeric {
374                   showProperties = allowWhiteSpace
375                }
376                currency {
377                   showProperties = decimalPoint, thousandSeparator
378                }
379                digit {
380                   showProperties =
381                }
382                integer {
383                   showProperties =
384                }
385                lowercase {
386                   showProperties =
387                }
388                regexp {
389                   showProperties = expression
390                }
391                titlecase {
392                   showProperties =
393                }
394                trim {
395                   showProperties = characterList
396                }
397                uppercase {
398                   showProperties =
399                }
400             }
401          }
402       }
403   }
404