|
1 | 1 | .. include:: /Includes.rst.txt |
2 | 2 |
|
3 | | -.. _introduction: |
| 3 | +.. _introduction: |
4 | 4 |
|
5 | 5 | ============ |
6 | 6 | Introduction |
7 | 7 | ============ |
8 | 8 |
|
9 | | -.. note:: |
| 9 | +.. note:: |
10 | 10 |
|
11 | | - This documentation will be extended on a constant basis. If you have |
12 | | - problems understanding a certain aspect, or if you notice something |
13 | | - missing, contribute to improve it. This will help you and everyone else! |
| 11 | + This documentation will be extended on a constant basis. If you have |
| 12 | + problems understanding a certain aspect or if you notice something |
| 13 | + missing, please contribute to improve it. This will help you as well as everyone else! |
14 | 14 |
|
15 | | - Get in touch with us: |
| 15 | + Get in touch with us: |
16 | 16 |
|
17 | | - - Find us on `Slack <https://typo3.slack.com>`_ and join the channel |
18 | | - ``#ext:form``. |
19 | | - - Use the "Edit on Github" function. |
| 17 | + * Find us on `Slack <https://typo3.community/meet/slack>`_ and join the |
| 18 | + channel `#ext:form`. |
| 19 | + * Use the "Edit on Github" function. |
20 | 20 |
|
21 | 21 |
|
22 | | -.. _what-does-it-do: |
| 22 | +.. _what-does-it-do: |
23 | 23 |
|
24 | 24 | What does it do? |
25 | | ----------------- |
| 25 | +================ |
26 | 26 |
|
27 | | -The ``form`` extension acts as a flexible, extendible, yet easy to use form |
28 | | -framework. It equally allows editors, integrators, and developers to build |
29 | | -all types of forms. For this task, different interfaces and techniques are |
30 | | -available. |
| 27 | +The :composer:`typo3/cms-form` extension is a system extension that provides a |
| 28 | +flexible, extendable, and easy-to-use form framework. It incorporates interfaces |
| 29 | +and functionality that allow editors, integrators and developers to build forms. |
31 | 30 |
|
32 | | -As a non-technical editor, you can use the "Forms" backend module. It |
33 | | -allows you to create and manage your individual forms with the help of a |
34 | | -nifty drag and drop interface. Your work can be previewed instantly. |
| 31 | +Non-technical editors can use the :guilabel:`Content > Forms` backend module. |
| 32 | +They can create and manage forms using a simple drag and drop interface. |
| 33 | +Forms can be previewed instantly. |
35 | 34 |
|
36 | | -As an experienced integrator, you are able to build ambitious forms which |
37 | | -are stored directly in your site package. Those forms can utilize hefty |
38 | | -finishers and ship localization files. |
| 35 | +Experienced integrators can build ambitious forms which are |
| 36 | +stored in a site package. These forms can use powerful finishers and ship |
| 37 | +localization files. |
39 | 38 |
|
40 | | -As a developer, you can use the PHP API to forge interfaces with conditional |
| 39 | +Developers can use the PHP API to create interfaces with conditional |
41 | 40 | form elements, register new validators and finishers, as well as create |
42 | | -custom form elements. Plenty of hooks allow you to manipulate the generation |
43 | | -and processing of the both form and data. |
44 | | - |
45 | | -.. figure:: Images/introduction_form_editor.png |
46 | | - :alt: The form creation wizard |
47 | | - |
48 | | - Form editor displaying a new form in the abstract view |
49 | | - |
50 | | - |
51 | | -Features List |
52 | | -------------- |
53 | | - |
54 | | -The following list names some features of the form framework: |
55 | | - |
56 | | -* form editor |
57 | | - * fully customizable editor for building complex forms |
58 | | - * replaceable and extendible form editor components |
59 | | - * JS API to extend form editor |
60 | | -* PHP API |
61 | | - * entire forms via API |
62 | | - * own renderers for form and/ or form elements |
63 | | - * conditional steps, form elements and validators based on other form |
64 | | - elements |
65 | | -* configuration |
66 | | - * YAML as configuration and definition language including inheritances |
67 | | - and overrides |
68 | | - * file based |
69 | | - * behaviour and design of the frontend, plugin, and form editor can be |
70 | | - adapted on a per form basis |
71 | | - * 'prototypes' can be used as boilerplate |
72 | | -* form elements |
73 | | - * own form elements possible |
74 | | - * uploads handled as FAL objects |
75 | | -* finishers |
76 | | - * ships a bunch of built-in finishers, like email, redirect, and save to |
77 | | - database |
78 | | - * own finishers possible |
79 | | - * finisher configuration can be overridden within the form plugin |
80 | | -* validators |
81 | | - * own validators possible |
82 | | -* miscellaneous |
83 | | - * multiple language support |
84 | | - * multiple step support |
85 | | - * multiple forms on one page |
86 | | - * built-in spam protection (honeypot) |
| 41 | +custom form elements. Plenty of hooks allow form creation |
| 42 | +and processing to be manipulated. |
| 43 | + |
| 44 | +.. figure:: Images/introduction_form_editor.png |
| 45 | + :alt: The form creation wizard |
| 46 | + |
| 47 | + Form editor displaying a new form in the abstract view |
| 48 | + |
| 49 | +.. _features_list: |
| 50 | + |
| 51 | +Features list |
| 52 | +============= |
| 53 | + |
| 54 | +Here are some of the features of the form framework: |
| 55 | + |
| 56 | +* form editor |
| 57 | + |
| 58 | + * fully customizable editor for building complex forms |
| 59 | + * replaceable and extendable form editor components |
| 60 | + * JS API to extend form editor |
| 61 | + |
| 62 | +* PHP API |
| 63 | + |
| 64 | + * entire forms via API |
| 65 | + * own renderers for form and/ or form elements |
| 66 | + * conditional steps, form elements and validators based on other form |
| 67 | + elements |
| 68 | + |
| 69 | +* configuration |
| 70 | + |
| 71 | + * YAML as configuration and definition language including inheritance |
| 72 | + and overrides |
| 73 | + * file based |
| 74 | + * behaviour and design of the frontend, plugin, and form editor can be |
| 75 | + adapted for individual forms |
| 76 | + * 'prototypes' can be used as boilerplate |
| 77 | + |
| 78 | +* form elements |
| 79 | + |
| 80 | + * own form elements possible |
| 81 | + * uploads handled as FAL objects |
| 82 | + |
| 83 | +* finishers |
| 84 | + |
| 85 | + * ships built-in finishers, like email, redirect, and save-to-database |
| 86 | + * own finishers possible |
| 87 | + * finisher configuration can be overridden in the form plugin |
| 88 | + |
| 89 | +* validators |
| 90 | + |
| 91 | + * own validators possible |
| 92 | + |
| 93 | +* miscellaneous |
| 94 | + |
| 95 | + * multiple languages support |
| 96 | + * multiple steps support |
| 97 | + * multiple forms on one page |
| 98 | + * built-in spam protection (honeypot) |
0 commit comments