[TASK] EXT:form - Update documentation
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Documentation / Configuration / Layout / Index.rst
1 .. include:: ../../Includes.txt
2
3
4 .. _reference-layout:
5
6 ======
7 Layout
8 ======
9
10 .. attention::
11
12     The form wizard (available in the TYPO3 backend) does not support the
13     complex layout mechanism described in this chapter. As soon as the
14     integrator has applied custom layout settings, the form wizard should
15     not be used anymore. When opening the customized form inside the form
16     wizard and hitting the "Save" button, all custom layout settings will be
17     lost.
18
19 Using layout allows the integrator to change the default visual appearance
20 of the FORM objects.
21
22 The FORM consists of FORM objects, which have their own layout each. The
23 layout of these objects can be changed for the whole form, for a specific
24 view or just for a particular object.
25
26 By default, the overall markup is based on ordered lists with list elements
27 in it, to have a proper layout framework which is also accessible for people
28 with disabilities.
29
30 Some objects are considered being container objects, as they have child
31 objects. These objects are FORM, FIELDSET, CHECKBOXGROUP and RADIOGROUP. To
32 have a proper markup for these objects, nested ordered lists are used.
33
34 **Example**
35
36 .. code-block:: html
37
38   <form>
39     <ol>
40       <li>
41         <fieldset>
42           <ol>
43             <li>
44               <input />
45             </li>
46           </ol>
47         </fieldset>
48       </li>
49       <li>
50         <input />
51       </li>
52     </ol>
53   </form>
54
55 It could be stated that SELECT and OPTGROUP elements are container objects
56 as well, and actually this is correct. They also contain child objects. But
57 these objects are not allowed to use the above mentioned markup.
58
59 There are 3 ways to modify the layout:
60
61 .. toctree::
62     :maxdepth: 5
63     :titlesonly:
64     :glob:
65
66     LayoutWholeForm/Index
67     LayoutViewSpecific/Index
68     LayoutObjectSpecific/Index
69