73d04359976289dddd946ec3293c01c0a2e9cf62
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Documentation / Administration / WizardSettings / DefaultsReference / FormTab / Index.rst
1 .. include:: ../../../../Includes.txt
2
3
4 .. _wizard-settings-defaults-form-tab:
5
6 ========
7 Form tab
8 ========
9
10 The form tab shows the configuration of the outer form, like the
11 attributes of the form or the prefix.
12
13 .. contents::
14     :local:
15     :depth: 1
16
17
18 .. _wizard-settings-defaults-form-showaccordions:
19
20 showAccordions
21 ==============
22
23 (:ts:`mod.wizards.form.defaults.tabs.form.showAccordions`)
24
25 :aspect:`Property:`
26     showAccordions
27
28 :aspect:`Data type:`
29     string
30
31 :aspect:`Description:`
32     Comma-separated list of the accordions that are allowed to be shown in
33     the wizard. This does not mean they are all shown by default, but
34     depends on the chosen element type.
35
36     Some accordions have further properties, which are described below.
37
38 :aspect:`Default:`
39     The following accordions are available in the form tab:
40
41     * behaviour
42     * prefix
43     * attributes :ref:`> to section <wizard-settings-defaults-form-attributes>`
44     * postProcessor :ref:`> to section <wizard-settings-defaults-form-postprocessor>`
45
46
47 .. _wizard-settings-defaults-form-attributes:
48
49 Attributes accordion
50 ====================
51
52
53 .. _wizard-settings-defaults-form-attributes-showproperties:
54
55 .. attention::
56
57     The whole configuration of the attributes accordion is not working
58     correctly and has to be fixed in a coming version of TYPO3. There is a
59     workaround which can be found :ref:`below <wizard-settings-defaults-form-workaround>`.
60
61 showProperties
62 --------------
63
64 (:ts:`mod.wizards.form.defaults.tabs.form.accordions.attributes.showProperties`)
65
66 :aspect:`Property:`
67     showProperties
68
69 :aspect:`Data type:`
70     string
71
72 :aspect:`Description:`
73     Comma-separated list of the form attributes that are allowed to be shown
74     in the accordion.
75
76 :aspect:`Default:`
77     accept, accept-charset, action, class, dir, enctype, id, lang, method,
78     name, style, title
79
80
81 .. _wizard-settings-defaults-form-postprocessor:
82
83 Post-processors accordion
84 =========================
85
86
87 .. _wizard-settings-defaults-form-postprocessor-showpostprocessors:
88
89 showPostProcessors
90 ------------------
91
92 (:ts:`mod.wizards.form.defaults.tabs.form.accordions.postProcessor.showPostProcessors`)
93
94 :aspect:`Property:`
95     showPostProcessors
96
97 :aspect:`Data type:`
98     string
99
100 :aspect:`Description:`
101    Comma-separated list of the post-processors that are allowed to be shown
102    in the wizard.
103
104    For each post-processors a list of properties to be shown can be defined.
105
106 :aspect:`Default:`
107     mail, redirect
108
109
110 .. _wizard-settings-defaults-options-postprocessor-postprocessors:
111
112 postProcessors.[post-processor].showProperties
113 ----------------------------------------------
114
115 (:ts:`mod.wizards.form.defaults.tabs.form.accordions.postProcessor.postProcessors.[post-processor].showProperties`)
116
117 :aspect:`Property:`
118     postProcessors.[post-processor].showProperties
119
120 :aspect:`Data type:`
121     string
122
123 :aspect:`Description:`
124     Configuration for the post-processors individually.
125
126     The syntax is :ts:`postProcessors.[name of the post-processor].showProperties`.
127
128 :aspect:`Default:`
129     The following element properties are available:
130
131     .. t3-field-list-table::
132         :header-rows: 1
133
134         - :Field:
135                 Element:
136           :Description:
137                 Properties:
138         - :Field:
139                 mail
140           :Description:
141                 recipientEmail, senderEmail, subject
142         - :Field:
143                 redirect
144           :Description:
145                 destination
146
147
148 .. _wizard-settings-defaults-form-tab-configuration:
149
150 Default configuration
151 =====================
152
153 The default configuration of the form tab looks as follows:
154
155 .. code-block:: typoscript
156
157   ...
158   form {
159     showAccordions = behaviour, prefix, attributes, postProcessor
160     accordions {
161       attributes {
162         showProperties = accept, accept-charset, action, class, dir, enctype, id, lang, method, name, style, title
163       }
164       postProcessor {
165         showPostProcessors = mail
166         postProcessors {
167           mail {
168             showProperties = recipientEmail, senderEmail, subject
169           }
170         }
171       }
172     }
173   }
174   ...
175
176
177 .. _wizard-settings-defaults-form-workaround:
178
179 Workaround for configuration of the attributes accordion
180 ========================================================
181
182 Since the above mentioned configuration of the attributes accordion is not
183 working as expected the following workaround is possible. Addressing (:ts:`mod.wizards.form.elements.form.accordions.attributes`)
184 allows to modify the attributes accordion. The example below illustrates
185 the procedure.
186
187 .. code-block:: typoscript
188
189   mod.wizards {
190     form {
191       elements {
192         form {
193           accordions {
194             attributes {
195               showProperties = accept, accept-charset, action, class, dir, enctype, id, lang, method, name, style, title
196             }
197           }
198         }
199       }
200     }
201   }
202