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