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