[TASK] EXT:form - Update and optimize documentation 36/47036/2
authorBjörn Jacob <bjoern.jacob@tritum.de>
Sat, 23 Jan 2016 16:16:07 +0000 (17:16 +0100)
committerJan Helke <typo3@helke.de>
Fri, 4 Mar 2016 10:31:52 +0000 (11:31 +0100)
The documentation of EXT:form is outdated. The whole documentation has
been proof read and revised. Furthermore, the document has experienced
a huge structural change. The long pages have been split into smaller
parts.

A lot of content was duplicated. Following the DRY principle, the
descriptions of functions/ attributes etc. are now documented at a
central place and references are used.

Resolves: #69346
Releases: master,7.6,6.2
Change-Id: I45ddcf2f93c94f2982ac5fdecd5a942fad2eef21
Reviewed-on: https://review.typo3.org/47036
Reviewed-by: Jan Helke <typo3@helke.de>
Tested-by: Jan Helke <typo3@helke.de>
88 files changed:
typo3/sysext/form/Documentation/Administration/DefaultNewRecord/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Administration/Index.rst
typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/ElementsTab/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/FormTab/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/OptionsTab/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/ShowTabs/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Administration/WizardSettings/ElementsReference/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Administration/WizardSettings/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/CheatSheet/Images.txt [deleted file]
typo3/sysext/form/Documentation/Configuration/CheatSheet/Index.rst [deleted file]
typo3/sysext/form/Documentation/Configuration/Filters/Alphabetic/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Alphanumeric/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Currency/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Digit/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Integer/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Lowercase/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Regexp/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Removexss/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Stripnewlines/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Titlecase/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Trim/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Filters/Uppercase/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Index.rst
typo3/sysext/form/Documentation/Configuration/Layout/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Layout/LayoutObjectSpecific/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Layout/LayoutViewSpecific/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Layout/LayoutWholeForm/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Button/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Checkbox/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Fieldset/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Fileupload/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Form/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Header/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Hidden/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Imagebutton/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/ObjectAttributes/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Optgroup/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Option/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Password/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Radio/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Reset/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Select/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Submit/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Textarea/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Textblock/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Objects/Textline/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Postprocessors/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Postprocessors/Mail/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Postprocessors/Redirect/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Reference/Attributes/Index.rst [deleted file]
typo3/sysext/form/Documentation/Configuration/Reference/Functions/Index.rst [deleted file]
typo3/sysext/form/Documentation/Configuration/Reference/Index.rst [deleted file]
typo3/sysext/form/Documentation/Configuration/Reference/Objects/Index.rst [deleted file]
typo3/sysext/form/Documentation/Configuration/Rules/Alphabetic/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Alphanumeric/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Between/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Date/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Digit/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Email/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Equals/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Float/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Greaterthan/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Inarray/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Integer/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Ip/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Length/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Lessthan/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Regexp/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Required/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/Uri/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Configuration/Rules/ValidationAttributes/Index.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/Images/CheatSheetAttributes.png [deleted file]
typo3/sysext/form/Documentation/Images/CheatSheetFilters.png [deleted file]
typo3/sysext/form/Documentation/Images/CheatSheetLayouts.png [deleted file]
typo3/sysext/form/Documentation/Images/CheatSheetRules.png [deleted file]
typo3/sysext/form/Documentation/Images/FormCreationWizad.png [deleted file]
typo3/sysext/form/Documentation/Images/FormCreationWizard.png [new file with mode: 0644]
typo3/sysext/form/Documentation/Includes.txt
typo3/sysext/form/Documentation/Index.rst
typo3/sysext/form/Documentation/Introduction/Index.rst
typo3/sysext/form/Documentation/Resources/Cheatsheet.ods [deleted file]
typo3/sysext/form/Documentation/Settings.cfg
typo3/sysext/form/Documentation/Settings.yml
typo3/sysext/form/Documentation/Targets.rst

diff --git a/typo3/sysext/form/Documentation/Administration/DefaultNewRecord/Index.rst b/typo3/sysext/form/Documentation/Administration/DefaultNewRecord/Index.rst
new file mode 100644 (file)
index 0000000..ac3e1a8
--- /dev/null
@@ -0,0 +1,38 @@
+.. include:: ../../Includes.txt
+
+
+.. _default-new-record:
+
+==================
+Default new record
+==================
+
+When a user creates a new FORM record, the bodytext will be filled by
+default with some simple form settings which are displayed below. You can
+change this setting to your specific needs, but remember this string
+**cannot be big due to some core limitations**. It is impossible to add the
+configuration for a complete form, although it might be a simple one. This
+restriction is caused by the fact that the whole string is put in a URI as
+parameter.
+
+Furthermore this only works when the editor is using the web module, i.e.
+the functionality is not supported by the list module.
+
+.. code-block:: typoscript
+
+  mod.wizards {
+    newContentElement.wizardItems {
+      forms.elements {
+        mailform {
+          tt_content_defValues {
+            bodytext (
+  enctype = application/x-www-form-urlencoded
+  method = post
+  prefix = tx_form
+            )
+          }
+        }
+      }
+    }
+  }
+
index 14cd735..e04e183 100644 (file)
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
+.. include:: ../Includes.txt
 
 
 .. _administration:
 
+==============
 Administration
---------------
-
-Upon installation, the extension will set default properties in the
-page TSconfig in the variable :code:`mod.wizards`.
-
-These properties may be modified for any particular page, BE user or
-BE user group and are detailed below.
-
-
-.. _default-new-record:
-
-Default new record
-^^^^^^^^^^^^^^^^^^
-
-When a user makes a new FORM record, the bodytext will be filled by
-default with some simple form settings which are displayed below. You
-can change this setting to your specific needs, but remember this
-string can't be big due to some core limitations for the bodytext of
-new records. It's impossible to add the configuration for a complete
-form, although it might be a simple one. This restriction is caused by
-the fact the whole string is put in a URI as parameter.
-
-.. code-block:: typoscript
-
-   mod.wizards {
-         newContentElement.wizardItems {
-                forms.elements {
-                       mailform {
-                             tt_content_defValues {
-                                         bodytext (
-   enctype = application/x-www-form-urlencoded
-   method = post
-   prefix = tx_form
-                                         )
-                              }
-                      }
-              }
-      }
-   }
-
-
-.. _wizard-settings:
-
-Wizard settings
-^^^^^^^^^^^^^^^
-
-The wizard basically consists of two parts on the screen, the left
-'settings' part and the right 'form' part. With TSconfig settings it
-is possible to configure the contents of the left 'settings' part. You
-can remove tabs, accordions or a specific setting for a single type of
-form element, or for all element types at once.
-
-The basic configuration has two settings: defaults and elements, which are described below.
-
-.. _wizard-settings-defaults:
-
-Defaults reference
-""""""""""""""""""
-
-Describe the settings for the visible tabs, the accordions available in
-these tabs and the default configuration for all element types.
-
-
-.. _wizard-settings-defaults-showtabs:
-
-showTabs
-~~~~~~~~
-
-(:code:`mod.wizards.form.defaults.showTabs`)
-
-.. container:: table-row
-
-   Property
-         showTabs
-
-   Data type
-         string
-
-   Description
-         Comma-separated list of the tabs that will be shown in the wizard
-
-   Default
-         elements, options, form
-
-
-
-.. _wizard-settings-defaults-tabs:
-
-tabs
-~~~~
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs`)
-
-.. container:: table-row
-
-   Property
-         tabs
-
-   Data type
-         [array of objects]
-
-         ->tabs.[tabName]
-
-   Description
-         Configuration for the each tab.
-
-         Example:
-
-         ::
-
-            mod.wizards {
-                               form {
-                                       defaults {
-                                               showTabs = elements, options, form
-                                                       tabs {
-                                                               elements {
-                                                                       ...
-                                                               }
-                                                               options {
-                                                                       ...
-                                                               }
-                                                               form {
-                                                                       ...
-                                                               }
-                                                       }
-                                               }
-                                       }
-                               }
-            }
-
-
-.. _wizard-settings-defaults-elements-tab:
-
-Elements tab
-~~~~~~~~~~~~
-
-The elements tab contains an accordion with buttons, grouped by their
-type. These buttons identify a form element, like a text field,
-password field or submit button. When dragging a button to the form
-and dropping it at a certain point in the form, the element will be
-added to the form at that point. A user can also double click a
-button. When doing so, the element will be added at the bottom of the
-form.
-
-
-.. _wizard-settings-defaults-elements-showaccordions:
-
-showAccordions
-''''''''''''''
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.elements.showAccordions`)
-
-.. container:: table-row
-
-   Property
-         showAccordions
-
-   Data type
-         string
-
-   Description
-         Comma-separated list of the accordions that will be shown in the
-         wizard. Each of the three accordions contain a single showButton
-         property which defines which form elements will be shown in a
-         given accordion.
-
-   Default
-         basic, predefined, content
-
-
-.. _wizard-settings-defaults-elements-accordions-showbuttons:
-
-showButtons
-'''''''''''
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.elements.accordions.showButtons`)
-
-.. container:: table-row
-
-   Property
-         showButtons
-
-   Data type
-         string
-
-   Description
-         Comma-separated list of the buttons that will be shown in the
-         accordion
-
-   Default
-         for "basic":
-         button, captcha, checkbox, fieldset, hidden, password, radio, reset,
-         select, submit, textarea, textline
-
-         |
-
-         for "predefined":
-         email, radiogroup, checkboxgroup, name
-
-         |
-
-         for "content":
-         header
-
-
-.. _wizard-settings-defaults-elements-tab-configuration:
-
-Default configuration
-'''''''''''''''''''''
-
-The default configuration of the elements tab looks like:
-
-.. code-block:: typoscript
-
-   ...
-       elements {
-               showAccordions = basic, predefined, content
-               accordions {
-                       basic {
-                               showButtons = button, captcha, checkbox, fieldset, hidden, password, radio, reset, select, submit, textarea, textline
-                       }
-                       predefined {
-                               showButtons = email, radiogroup, checkboxgroup, name
-                       }
-                       content {
-                               showButtons = header
-                       }
-               }
-       }
-   ...
-
-
-.. _wizard-settings-defaults-options-tab:
-
-Options tab
-~~~~~~~~~~~
-
-The options tab will show the configuration of a particular element in
-the form. When no element has been selected, it will show a message
-that you have to select an element in the form.
-
-The content of this tab depends on the type of element you've chosen
-in the form.
-
-
-.. _wizard-settings-defaults-options-showaccordions:
-
-showAccordions
-''''''''''''''
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.options.showAccordions`)
-
-.. container:: table-row
-
-   Property
-         showAccordions
-
-   Data type
-         string
-
-   Description
-         Comma-separated list of the accordions that are allowed to be shown in
-         the wizard. This does not mean they are all shown by default, but
-         depends on the chosen element type.
-
-         Some tabs have further configuration which is described below.
-
-   Default
-         legend, label, attributes, options, validation, filters, various
-
-
-.. _wizard-settings-defaults-options-attributes:
-
-Attributes accordion
-''''''''''''''''''''
-
-
-.. _wizard-settings-defaults-options-attributes-showproperties:
-
-showProperties
-**************
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.options.attributes.showProperties`)
-
-.. container:: table-row
-
-   Property
-         showProperties
-
-   Data type
-         string
-
-   Description
-         Comma-separated list of the attributes that are allowed to be shown in
-         the accordion. The appearance of an attribute depends on the chosen
-         element type. If an element type does not support an attribute, it
-         will not be shown.
-
-   Default
-         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
-
-
-.. _wizard-settings-defaults-options-label:
-
-Label accordion
-'''''''''''''''
-
-
-.. _wizard-settings-defaults-options-label-showproperties:
-
-showProperties
-**************
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.options.label.showProperties`)
-
-.. container:: table-row
-
-   Property
-         showProperties
-
-   Data type
-         string
-
-   Description
-         Comma-separated list of the label options that are allowed to be shown
-         in the accordion. The appearance of an option depends on the chosen
-         element type. If an element type does not support an option, it will
-         not be shown.
-
-   Default
-         label, layout
-
-
-.. _wizard-settings-defaults-validation-label:
-
-Validation accordion
-''''''''''''''''''''
-
-
-.. _wizard-settings-defaults-options-validation-showrules:
-
-showRules
-*********
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.options.validation.showRules`)
-
-.. container:: table-row
-
-   Property
-         showRules
-
-   Data type
-         string
-
-   Description
-         Comma-separated list of rules that are allowed to be shown in the
-         wizard.
-
-   Default
-         alphabetic, alphanumeric, between, captcha, date, digit, email,
-         equals, float, greaterthan, inarray, integer, ip, length, lessthan,
-         regexp, required, uri
-
-
-.. _wizard-settings-defaults-options-validation-rules:
-
-rules.[rule].showProperties
-***************************
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.options.validation.rules.[rule].showProperties`)
-
-.. container:: table-row
-
-   Property
-         rules.[rule].showProperties
-
-   Data type
-         [array of objects]
-
-   Description
-         For each rule we can define which properties should appear.
-         The syntax is :code:`rules.[name of the rule].showProperties`.
-
-   Default
-         For "alphabetic":
-         message, error, breakOnError, showMessage, allowWhiteSpace
-
-         |
-
-         For "alphanumeric":
-         message, error, breakOnError, showMessage, allowWhiteSpace
-
-         |
-
-         For "between":
-         message, error, breakOnError, showMessage, minimum, maximum, inclusive
-
-         |
-
-         For "date":
-         message, error, breakOnError, showMessage, format
-
-         |
-
-         For "digit":
-         message, error, breakOnError, showMessage
-
-         |
-
-         For "email":
-         message, error, breakOnError, showMessage
-
-         |
-
-         For "equals":
-         message, error, breakOnError, showMessage, field
-
-         |
-
-         For "fileallowedtypes":
-         message, error, breakOnError, showMessage, types
-
-         |
-
-         For "filemaximumsize":
-         message, error, breakOnError, showMessage, maximum
-
-         |
-
-         For "fileminimumsize":
-         message, error, breakOnError, showMessage, minimum
-
-         |
-
-         For "float":
-         message, error, breakOnError, showMessage
-
-         |
-
-         For "greaterthan":
-         message, error, breakOnError, showMessage, minimum
-
-         |
-
-         For "inarray":
-         message, error, breakOnError, showMessage, array, strict
-
-         |
-
-         For "integer":
-         message, error, breakOnError, showMessage
-
-         |
-
-         For "ip":
-         message, error, breakOnError, showMessage
-
-         |
-
-         For "length":
-         message, error, breakOnError, showMessage, minimum, maximum
-
-         |
-
-         For "lessthan":
-         message, error, breakOnError, showMessage, maximum
-
-         |
-
-         For "regexp":
-         message, error, breakOnError, showMessage, expression
-
-         |
-
-         For "required":
-         message, error, breakOnError, showMessage
-
-         |
-
-         For "uri":
-         message, error, breakOnError, showMessage
-
-         |
-
-
-.. _wizard-settings-defaults-filters-label:
-
-Filters accordion
-'''''''''''''''''
-
-
-.. _wizard-settings-defaults-options-filtering-showfilters:
-
-showFilters
-***********
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.options.filters.showFilters`)
-
-.. container:: table-row
-
-   Property
-         showFilters
-
-   Data type
-         string
-
-   Description
-         Comma-separated list of the filters that are allowed to be shown in
-         the wizard.
-
-         For each filter a list of properties to be shown can be defined.
-
-   Default
-         alphabetic, alphanumeric, currency, digit, integer, lowercase, regexp,
-         removexss, stripnewlines, titlecase, trim, uppercase
-
-
-
-.. _wizard-settings-defaults-options-filtering-filters:
-
-filters.[filter].showProperties
-*******************************
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.options.filtering.filters.[filter].showProperties`)
-
-.. container:: table-row
-
-   Property
-         filters.[filter].showProperties
-
-   Data type
-         string
-
-   Description
-         Configuration for the filters individually. Not all filters have a
-         configuration. Only the filters who have are mentioned in the list of
-         default values below.
-
-         The syntax is :code:`filters.[name of the filter].showProperties`.
-
-   Default
-         For "alphabetic":
-         allowWhiteSpace
-
-         |
-
-         For "alphanumeric":
-         allowWhiteSpace
-
-         |
-
-         For "currency":
-         decimalPoint, thousandSeparator
-
-         |
-
-         For "regexp":
-         expression
-
-         |
-
-         For "trim":
-         characterList
-
-
-.. _wizard-settings-defaults-options-tab-configuration:
-
-Default configuration
-'''''''''''''''''''''
-
-The default configuration of the options tab looks like this:
-
-.. code-block:: typoscript
-
-   ...
-               options {
-                       showAccordions = legend, label, attributes, options, validation, filters, various
-                       accordions {
-                               attributes {
-                                       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
-                               }
-                               label {
-                                       showProperties = label
-                               }
-                               validation {
-                                       showRules = alphabetic, alphanumeric, between, date, digit, email, equals, fileallowedtypes, filemaximumsize, fileminimumsize, float, greaterthan, inarray, integer, ip, length, lessthan, regexp, required, uri
-                                       rules {
-                                               alphabetic {
-                                                       showProperties = message, error, breakOnError, showMessage, allowWhiteSpace
-                                               }
-                                               alphanumeric {
-                                                       showProperties = message, error, breakOnError, showMessage, allowWhiteSpace
-                                               }
-                                               between {
-                                                       showProperties = message, error, breakOnError, showMessage, minimum, maximum, inclusive
-                                               }
-                                               date {
-                                                       showProperties = message, error, breakOnError, showMessage, format
-                                               }
-                                               digit {
-                                                       showProperties = message, error, breakOnError, showMessage
-                                               }
-                                               email {
-                                                       showProperties = message, error, breakOnError, showMessage
-                                               }
-                                               equals {
-                                                       showProperties = message, error, breakOnError, showMessage, field
-                                               }
-                                               fileallowedtypes {
-                                                       showProperties = message, error, breakOnError, showMessage, types
-                                               }
-                                               filemaximumsize {
-                                                       showProperties = message, error, breakOnError, showMessage, maximum
-                                               }
-                                               fileminimumsize {
-                                                       showProperties = message, error, breakOnError, showMessage, minimum
-                                               }
-                                               float {
-                                                       showProperties = message, error, breakOnError, showMessage
-                                               }
-                                               greaterthan {
-                                                       showProperties = message, error, breakOnError, showMessage, minimum
-                                               }
-                                               inarray {
-                                                       showProperties = message, error, breakOnError, showMessage, array, strict
-                                               }
-                                               integer {
-                                                       showProperties = message, error, breakOnError, showMessage
-                                               }
-                                               ip {
-                                                       showProperties = message, error, breakOnError, showMessage
-                                               }
-                                               length {
-                                                       showProperties = message, error, breakOnError, showMessage, minimum, maximum
-                                               }
-                                               lessthan {
-                                                       showProperties = message, error, breakOnError, showMessage, maximum
-                                               }
-                                               regexp {
-                                                       showProperties = message, error, breakOnError, showMessage, expression
-                                               }
-                                               required {
-                                                       showProperties = message, error, breakOnError, showMessage
-                                               }
-                                               uri {
-                                                       showProperties = message, error, breakOnError, showMessage
-                                               }
-                                       }
-                               }
-                               filtering {
-                                       showFilters = alphabetic, alphanumeric, currency, digit, integer, lowercase, regexp, removexss, stripnewlines, titlecase, trim, uppercase
-                                       filters {
-                                               alphabetic {
-                                                       showProperties = allowWhiteSpace
-                                               }
-                                               alphanumeric {
-                                                       showProperties = allowWhiteSpace
-                                               }
-                                               currency {
-                                                       showProperties = decimalPoint, thousandSeparator
-                                               }
-                                               digit {
-                                                       showProperties =
-                                               }
-                                               integer {
-                                                       showProperties =
-                                               }
-                                               lowercase {
-                                                       showProperties =
-                                               }
-                                               regexp {
-                                                       showProperties = expression
-                                               }
-                                               removexss {
-                                                       showProperties =
-                                               }
-                                               stripnewlines {
-                                                       showProperties =
-                                               }
-                                               titlecase {
-                                                       showProperties =
-                                               }
-                                               trim {
-                                                       showProperties = characterList
-                                               }
-                                               uppercase {
-                                                       showProperties =
-                                               }
-                                       }
-                               }
-                       }
-               }
-   ...
-
-
-.. _wizard-settings-defaults-form-tab:
-
-Form tab
-~~~~~~~~
-
-The form tab shows the configuration of the outer form, like the
-attributes of the form or the prefix.
-
-
-.. _wizard-settings-defaults-form-showaccordions:
-
-showAccordions
-''''''''''''''
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.form.showAccordions`)
-
-.. container:: table-row
-
-   Property
-         showAccordions
-
-   Data type
-         string
-
-   Description
-         Comma-separated list of the accordions that are allowed to be shown in
-         the wizard. This does not mean they are all shown by default, but
-         depends on the chosen element type.
-
-         Some accordions have further properties, which are described below.
-
-   Default
-         behaviour, prefix, attributes, postProcessor
-
-
-.. _wizard-settings-defaults-form-attributes:
-
-Attributes accordion
-''''''''''''''''''''
-
-
-.. _wizard-settings-defaults-form-attributes-showproperties:
-
-showProperties
-**************
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.form.accordions.attributes.showProperties`)
-
-.. container:: table-row
-
-   Property
-         showProperties
-
-   Data type
-         string
-
-   Description
-         Comma-separated list of the form attributes that are allowed to be
-         shown in the accordion.
-
-   Default
-         accept, acceptcharset, action, class, dir, enctype, id, lang, method,
-         name, style, title
-
-
-.. _wizard-settings-defaults-form-postprocessor:
-
-Post-processors accordion
-'''''''''''''''''''''''''
-
-
-.. _wizard-settings-defaults-form-postprocessor-showpostprocessors:
-
-showPostProcessors
-******************
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.form.accordions.postProcessor.showPostProcessors`)
-
-.. container:: table-row
-
-   Property
-         showPostProcessors
-
-   Data type
-         string
-
-   Description
-         Comma-separated list of the post-processors that are allowed to be shown in
-         the wizard.
-
-         For each post-processors a list of properties to be shown can be defined.
-
-   Default
-         mail
-
-
-
-.. _wizard-settings-defaults-options-postprocessor-postprocessors:
-
-postProcessors.[post-processor].showProperties
-**********************************************
-
-(:code:`mod.wizards.form.defaults.showTabs.tabs.form.accordions.postProcessor.postProcessors.[post-processor].showProperties`)
-
-.. container:: table-row
-
-   Property
-         postProcessors.[post-processor].showProperties
-
-   Data type
-         string
-
-   Description
-         Configuration for the post-processors individually.
-
-         The syntax is :code:`postProcessors.[name of the post-processor].showProperties`.
-
-   Default
-         For "mail":
-         recipientEmail, senderEmail, subject
-
-
-.. _wizard-settings-defaults-form-tab-configuration:
-
-Default configuration
-'''''''''''''''''''''
-
-The default configuration of the form tab looks like this:
-
-.. code-block:: typoscript
-
-   ...
-               form {
-                       showAccordions = behaviour, prefix, attributes, postProcessor
-                       accordions {
-                               attributes {
-                                       showProperties = accept, acceptcharset, action, class, dir, enctype, id, lang, method, name, style, title
-                               }
-                               postProcessor {
-                                       showPostProcessors = mail
-                                       postProcessors {
-                                               mail {
-                                                       showProperties = recipientEmail, senderEmail, subject
-                                               }
-                                       }
-                               }
-                       }
-               }
-   ...
-
-
-
-.. _wizard-settings-elements:
-
-Elements reference
-""""""""""""""""""
-
-Overrule the default settings of the :ref:`Option <wizard-settings-defaults-options-tab>`
-tab for specific element types.
-
-In the left "settings" part there is a tab called "options". The
-contents of this tab will adapt itself to the selected element type in
-the form. If no elements configuration is used, the default settings
-will be used.
-
-
-.. _overriding-element-settings:
-
-Overriding element settings
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-It's possible to override the default option tab settings for each
-element individually. This is done by using the same configuration as
-in :code:`mod.wizards.form.defaults.tabs.options`, but using this
-configuration in :code:`mod.wizards.form.elements.[elementName]`.
+==============
 
-The example below will hide all the accordions within the option tab
-for a fieldset element, except the legend:
+Upon installation, the extension will set default properties in the page
+TSconfig in the variable :ts:`mod.wizards`.
 
-.. code-block:: typoscript
+These properties may be modified for any particular page, BE user or BE
+user group and are described below.
 
-   mod.wizards.form.element {
-    fieldset {
-               showAccordions = legend
-       }
-   }
+.. toctree::
+    :maxdepth: 5
+    :titlesonly:
+    :glob:
 
-By using this setting you can show or hide accordions, attributes,
-validation rules or filters, for each and every individual element.
+    DefaultNewRecord/Index
+    WizardSettings/Index
 
diff --git a/typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/ElementsTab/Index.rst b/typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/ElementsTab/Index.rst
new file mode 100644 (file)
index 0000000..a71b3ba
--- /dev/null
@@ -0,0 +1,128 @@
+.. include:: ../../../../Includes.txt
+
+
+.. _wizard-settings-defaults-elements-tab:
+
+============
+Elements tab
+============
+
+The elements tab contains an accordion with buttons, grouped by their
+type. These buttons identify a form element, like a text field, password
+field or submit button. When dragging a button to the form on the right
+and dropping it at a certain point in the form, the element will be added
+to the form at that point. A user can also double click a button. When
+doing so, the element will be added at the bottom of the form.
+
+.. contents::
+    :local:
+    :depth: 1
+
+
+.. _wizard-settings-defaults-elements-showaccordions:
+
+showAccordions
+==============
+
+(:ts:`mod.wizards.form.defaults.tabs.elements.showAccordions`)
+
+:aspect:`Property:`
+    showAccordions
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Comma-separated list of the accordions that will be shown in the
+    wizard. Each of the three accordions contain a single showButton
+    property which defines which form elements will be shown in a
+    given accordion.
+
+:aspect:`Default:`
+    basic, predefined, content
+
+
+.. _wizard-settings-defaults-elements-accordions-showbuttons:
+
+showButtons
+===========
+
+(:ts:`mod.wizards.form.defaults.tabs.elements.accordions.[NameOfAccordion].showButtons`)
+
+:aspect:`Property:`
+    showButtons
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Comma-separated list of the buttons that will be shown in the
+    accordion. Please note, in the shown path has [NameOfAccordion]
+    to be replaced with the name of the specific accordion.
+
+:aspect:`Default:`
+    **"basic" elements**
+
+    - checkbox (Checkbox)
+    - fieldset (Fieldset)
+    - fileupload (Upload Field)
+    - hidden (Hidden Field)
+    - password (Password Field)
+    - radio (Radio Button)
+    - reset (Reset Button)
+    - select (Drop Down)
+    - submit (Submit Button)
+    - textarea (Textarea)
+    - textline (Text Field)
+
+    Additionally, there is the element "button" available which is not visible by default.
+
+    |
+
+    **"predefined" elements**
+
+    - email (Email)
+    - radiogroup (Radio Button Group)
+    - checkboxgroup (Checkbox Group)
+    - name (Full Name)
+
+    |
+
+    **"content" elements**
+
+    - header (Header)
+    - textblock (Text Block)
+
+
+.. _wizard-settings-defaults-elements-tab-configuration:
+
+Default configuration
+=====================
+
+The default configuration of the elements tab is as follows.
+
+.. code-block:: typoscript
+
+  mod.wizards {
+    form {
+      defaults {
+        tabs {
+          elements {
+            showAccordions = basic, predefined, content
+            accordions {
+              basic {
+                showButtons = checkbox, fieldset, fileupload, hidden, password, radio, reset, select, submit, textarea, textline
+              }
+              predefined {
+                showButtons = email, radiogroup, checkboxgroup, name
+              }
+              content {
+                showButtons = header, textblock
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+
diff --git a/typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/FormTab/Index.rst b/typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/FormTab/Index.rst
new file mode 100644 (file)
index 0000000..73d0435
--- /dev/null
@@ -0,0 +1,202 @@
+.. include:: ../../../../Includes.txt
+
+
+.. _wizard-settings-defaults-form-tab:
+
+========
+Form tab
+========
+
+The form tab shows the configuration of the outer form, like the
+attributes of the form or the prefix.
+
+.. contents::
+    :local:
+    :depth: 1
+
+
+.. _wizard-settings-defaults-form-showaccordions:
+
+showAccordions
+==============
+
+(:ts:`mod.wizards.form.defaults.tabs.form.showAccordions`)
+
+:aspect:`Property:`
+    showAccordions
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Comma-separated list of the accordions that are allowed to be shown in
+    the wizard. This does not mean they are all shown by default, but
+    depends on the chosen element type.
+
+    Some accordions have further properties, which are described below.
+
+:aspect:`Default:`
+    The following accordions are available in the form tab:
+
+    * behaviour
+    * prefix
+    * attributes :ref:`> to section <wizard-settings-defaults-form-attributes>`
+    * postProcessor :ref:`> to section <wizard-settings-defaults-form-postprocessor>`
+
+
+.. _wizard-settings-defaults-form-attributes:
+
+Attributes accordion
+====================
+
+
+.. _wizard-settings-defaults-form-attributes-showproperties:
+
+.. attention::
+
+    The whole configuration of the attributes accordion is not working
+    correctly and has to be fixed in a coming version of TYPO3. There is a
+    workaround which can be found :ref:`below <wizard-settings-defaults-form-workaround>`.
+
+showProperties
+--------------
+
+(:ts:`mod.wizards.form.defaults.tabs.form.accordions.attributes.showProperties`)
+
+:aspect:`Property:`
+    showProperties
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Comma-separated list of the form attributes that are allowed to be shown
+    in the accordion.
+
+:aspect:`Default:`
+    accept, accept-charset, action, class, dir, enctype, id, lang, method,
+    name, style, title
+
+
+.. _wizard-settings-defaults-form-postprocessor:
+
+Post-processors accordion
+=========================
+
+
+.. _wizard-settings-defaults-form-postprocessor-showpostprocessors:
+
+showPostProcessors
+------------------
+
+(:ts:`mod.wizards.form.defaults.tabs.form.accordions.postProcessor.showPostProcessors`)
+
+:aspect:`Property:`
+    showPostProcessors
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+   Comma-separated list of the post-processors that are allowed to be shown
+   in the wizard.
+
+   For each post-processors a list of properties to be shown can be defined.
+
+:aspect:`Default:`
+    mail, redirect
+
+
+.. _wizard-settings-defaults-options-postprocessor-postprocessors:
+
+postProcessors.[post-processor].showProperties
+----------------------------------------------
+
+(:ts:`mod.wizards.form.defaults.tabs.form.accordions.postProcessor.postProcessors.[post-processor].showProperties`)
+
+:aspect:`Property:`
+    postProcessors.[post-processor].showProperties
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Configuration for the post-processors individually.
+
+    The syntax is :ts:`postProcessors.[name of the post-processor].showProperties`.
+
+:aspect:`Default:`
+    The following element properties are available:
+
+    .. t3-field-list-table::
+        :header-rows: 1
+
+        - :Field:
+                Element:
+          :Description:
+                Properties:
+        - :Field:
+                mail
+          :Description:
+                recipientEmail, senderEmail, subject
+        - :Field:
+                redirect
+          :Description:
+                destination
+
+
+.. _wizard-settings-defaults-form-tab-configuration:
+
+Default configuration
+=====================
+
+The default configuration of the form tab looks as follows:
+
+.. code-block:: typoscript
+
+  ...
+  form {
+    showAccordions = behaviour, prefix, attributes, postProcessor
+    accordions {
+      attributes {
+        showProperties = accept, accept-charset, action, class, dir, enctype, id, lang, method, name, style, title
+      }
+      postProcessor {
+        showPostProcessors = mail
+        postProcessors {
+          mail {
+            showProperties = recipientEmail, senderEmail, subject
+          }
+        }
+      }
+    }
+  }
+  ...
+
+
+.. _wizard-settings-defaults-form-workaround:
+
+Workaround for configuration of the attributes accordion
+========================================================
+
+Since the above mentioned configuration of the attributes accordion is not
+working as expected the following workaround is possible. Addressing (:ts:`mod.wizards.form.elements.form.accordions.attributes`)
+allows to modify the attributes accordion. The example below illustrates
+the procedure.
+
+.. code-block:: typoscript
+
+  mod.wizards {
+    form {
+      elements {
+        form {
+          accordions {
+            attributes {
+              showProperties = accept, accept-charset, action, class, dir, enctype, id, lang, method, name, style, title
+            }
+          }
+        }
+      }
+    }
+  }
+
diff --git a/typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/Index.rst b/typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/Index.rst
new file mode 100644 (file)
index 0000000..44a5e56
--- /dev/null
@@ -0,0 +1,24 @@
+.. include:: ../../../Includes.txt
+
+
+.. _wizard-settings-defaults:
+
+==================
+Defaults reference
+==================
+
+This chapter describes the settings for the visible tabs, the accordions
+available inside these tabs and the default configuration for all element
+types.
+
+
+.. toctree::
+    :maxdepth: 5
+    :titlesonly:
+    :glob:
+
+    ShowTabs/Index
+    ElementsTab/Index
+    OptionsTab/Index
+    FormTab/Index
+
diff --git a/typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/OptionsTab/Index.rst b/typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/OptionsTab/Index.rst
new file mode 100644 (file)
index 0000000..5978187
--- /dev/null
@@ -0,0 +1,400 @@
+.. include:: ../../../../Includes.txt
+
+
+.. _wizard-settings-defaults-options-tab:
+
+===========
+Options tab
+===========
+
+The options tab will show the configuration of a particular element in
+the form. When no element has been selected, it will show a message that
+you have to select an element in the form.
+
+The content of this tab depends on the type of element you've chosen in
+the form.
+
+.. contents::
+    :local:
+    :depth: 1
+
+
+.. _wizard-settings-defaults-options-showaccordions:
+
+showAccordions
+==============
+
+:aspect:`Property:`
+    showAccordions
+
+:aspect:`TypoScript Path:`
+    :ts:`mod.wizards.form.defaults.tabs.options.showAccordions`
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Comma-separated list of the accordions that are allowed to be shown
+    in the wizard. This does not mean they are all shown by default,
+    but depends on the chosen element type.
+
+    Some tabs have further configuration which is described below.
+
+:aspect:`Default:`
+    The following accordions are available:
+
+    - *legend*: Legend Properties
+    - *label*: Label Properties :ref:`to section <wizard-settings-defaults-options-label>`
+    - *attributes*: Attributes Properties :ref:`> to section <wizard-settings-defaults-options-attributes>`
+    - *options*: Field Options
+    - *validation*: Validation :ref:`> to section <wizard-settings-defaults-validation-label>`
+    - *filters*: Filters :ref:`> to section <wizard-settings-defaults-filters-label>`
+    - *various*: Various Properties
+
+:aspect:`Example:`
+    .. code-block:: typoscript
+
+      mod.wizards {
+        form {
+          defaults {
+            tabs {
+              options {
+                showAccordions = legend, label, attributes, options, validation, filters, various
+              }
+            }
+          }
+        }
+      }
+
+
+.. _wizard-settings-defaults-options-label:
+
+Label accordion
+===============
+
+
+.. _wizard-settings-defaults-options-label-showproperties:
+
+showProperties
+--------------
+
+:aspect:`Property:`
+    showProperties
+
+:aspect:`TypoScript Path:`
+    :ts:`mod.wizards.form.defaults.tabs.options.accordions.label.showProperties`
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Comma-separated list of the label options that are allowed to be
+    shown in the accordion. The appearance of an option depends on
+    the chosen element type. If an element type does not support an
+    option, it will not be shown.
+
+:aspect:`Default:`
+    label, layout
+
+
+.. _wizard-settings-defaults-options-attributes:
+
+Attributes accordion
+====================
+
+
+.. _wizard-settings-defaults-options-attributes-showproperties:
+
+showProperties
+--------------
+
+:aspect:`Property:`
+    showProperties
+
+:aspect:`TypoScript Path:`
+    :ts:`mod.wizards.form.defaults.tabs.options.accordions.attributes.showProperties`
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Comma-separated list of attributes that are allowed to be shown in
+    the accordion. The appearance of an attribute depends on the chosen
+    element type. If an element type does not support an attribute, it
+    will not be shown.
+
+
+:aspect:`Default:`
+    accept, accept-charset, 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
+
+
+.. _wizard-settings-defaults-validation-label:
+
+Validation accordion
+====================
+
+
+.. _wizard-settings-defaults-options-validation-showrules:
+
+showRules
+---------
+
+:aspect:`Property:`
+    showRules
+
+:aspect:`TypoScript Path:`
+    :ts:`mod.wizards.form.defaults.tabs.options.accordions.validation.showRules`
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Comma-separated list of rules that are allowed to be shown in the
+    wizard.
+
+:aspect:`Default:`
+    alphabetic, alphanumeric, between, date, digit, email, equals,
+    float, greaterthan, inarray, integer, ip, length, lessthan,
+    regexp, required, uri
+
+
+.. _wizard-settings-defaults-options-validation-rules:
+
+rules.[rule].showProperties
+---------------------------
+
+:aspect:`Property:`
+    rules.[rule].showProperties
+
+:aspect:`TypoScript Path:`
+    :ts:`mod.wizards.form.defaults.tabs.options.accordions.validation.rules.[rule].showProperties`
+
+:aspect:`Data type:`
+    [array of objects]
+
+:aspect:`Description:`
+    For each rule one can define which properties should appear.
+    The syntax is :ts:`rules.[name of the rule].showProperties`.
+
+:aspect:`Default:`
+    The following element properties are available:
+
+    =================== ======================================================================
+    Element             Properties
+    =================== ======================================================================
+    alphabetic          message, error, breakOnError, showMessage, allowWhiteSpace
+    alphanumeric        message, error, breakOnError, showMessage, allowWhiteSpace
+    between             message, error, breakOnError, showMessage, minimum, maximum, inclusive
+    date                message, error, breakOnError, showMessage, format
+    digit               message, error, breakOnError, showMessage
+    email               message, error, breakOnError, showMessage
+    equals              message, error, breakOnError, showMessage, field
+    fileallowedtypes    message, error, breakOnError, showMessage, types
+    filemaximumsize     message, error, breakOnError, showMessage, maximum
+    fileminimumsize     message, error, breakOnError, showMessage, minimum
+    float               message, error, breakOnError, showMessage
+    greaterthan         message, error, breakOnError, showMessage, minimum
+    inarray             message, error, breakOnError, showMessage, array, strict
+    integer             message, error, breakOnError, showMessage
+    ip                  message, error, breakOnError, showMessage
+    length              message, error, breakOnError, showMessage, minimum, maximum
+    lessthan            message, error, breakOnError, showMessage, maximum
+    regexp              message, error, breakOnError, showMessage, expression
+    required            message, error, breakOnError, showMessage
+    uri                 message, error, breakOnError, showMessage
+    =================== ======================================================================
+
+
+.. _wizard-settings-defaults-filters-label:
+
+Filters accordion
+=================
+
+
+.. _wizard-settings-defaults-options-filtering-showfilters:
+
+showFilters
+-----------
+
+:aspect:`Property:`
+    showFilters
+
+:aspect:`TypoScript Path:`
+    :ts:`mod.wizards.form.defaults.tabs.options.accordions.filtering.showFilters`
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Comma-separated list of the filters that are allowed to be shown in
+    the wizard.
+
+    For each filter a list of properties to be shown can be defined.
+
+:aspect:`Default:`
+    alphabetic, alphanumeric, currency, digit, integer, lowercase,
+    regexp, removexss, titlecase, trim, uppercase
+
+
+.. _wizard-settings-defaults-options-filtering-filters:
+
+filters.[filter].showProperties
+-------------------------------
+
+:aspect:`Property:`
+    filters.[filter].showProperties
+
+:aspect:`TypoScript Path:`
+    :ts:`mod.wizards.form.defaults.tabs.options.accordions.filtering.filters.[filter].showProperties`
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Configuration for the filters individually. Not all filters have a
+    configuration. Only the filters which are mentioned below can be
+    configured.
+
+    The syntax is :ts:`filters.[name of the filter].showProperties`.
+
+:aspect:`Default:`
+    The following element properties are available:
+
+    =================== ===============================
+    Element             Properties
+    =================== ===============================
+    alphabetic          allowWhiteSpace
+    alphanumeric        allowWhiteSpace
+    currency            decimalPoint, thousandSeparator
+    regexp              expression
+    trim                characterList
+    =================== ===============================
+
+
+.. _wizard-settings-defaults-options-tab-configuration:
+
+Default configuration
+=====================
+
+The default configuration of the options tab looks like this:
+
+.. code-block:: typoscript
+
+  options {
+     showAccordions = legend, label, attributes, options, validation, filters, various
+     accordions {
+         attributes {
+            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
+         }
+         label {
+            showProperties = label
+         }
+         validation {
+            showRules = alphabetic, alphanumeric, between, date, digit, email, equals, fileallowedtypes, filemaximumsize, fileminimumsize, float, greaterthan, inarray, integer, ip, length, lessthan, regexp, required, uri
+            rules {
+               alphabetic {
+                  showProperties = message, error, breakOnError, showMessage, allowWhiteSpace
+               }
+               alphanumeric {
+                  showProperties = message, error, breakOnError, showMessage, allowWhiteSpace
+               }
+               between {
+                  showProperties = message, error, breakOnError, showMessage, minimum, maximum, inclusive
+               }
+               date {
+                  showProperties = message, error, breakOnError, showMessage, format
+               }
+               digit {
+                  showProperties = message, error, breakOnError, showMessage
+               }
+               email {
+                  showProperties = message, error, breakOnError, showMessage
+               }
+               equals {
+                  showProperties = message, error, breakOnError, showMessage, field
+               }
+               fileallowedtypes {
+                  showProperties = message, error, breakOnError, showMessage, types
+               }
+               filemaximumsize {
+                  showProperties = message, error, breakOnError, showMessage, maximum
+               }
+               fileminimumsize {
+                  showProperties = message, error, breakOnError, showMessage, minimum
+               }
+               float {
+                  showProperties = message, error, breakOnError, showMessage
+               }
+               greaterthan {
+                  showProperties = message, error, breakOnError, showMessage, minimum
+               }
+               inarray {
+                  showProperties = message, error, breakOnError, showMessage, array, strict
+               }
+               integer {
+                  showProperties = message, error, breakOnError, showMessage
+               }
+               ip {
+                  showProperties = message, error, breakOnError, showMessage
+               }
+               length {
+                  showProperties = message, error, breakOnError, showMessage, minimum, maximum
+               }
+               lessthan {
+                  showProperties = message, error, breakOnError, showMessage, maximum
+               }
+               regexp {
+                  showProperties = message, error, breakOnError, showMessage, expression
+               }
+               required {
+                  showProperties = message, error, breakOnError, showMessage
+               }
+               uri {
+                  showProperties = message, error, breakOnError, showMessage
+               }
+            }
+         }
+         filtering {
+            showFilters = alphabetic, alphanumeric, currency, digit, integer, lowercase, regexp, removexss, titlecase, trim, uppercase
+            filters {
+               alphabetic {
+                  showProperties = allowWhiteSpace
+               }
+               alphanumeric {
+                  showProperties = allowWhiteSpace
+               }
+               currency {
+                  showProperties = decimalPoint, thousandSeparator
+               }
+               digit {
+                  showProperties =
+               }
+               integer {
+                  showProperties =
+               }
+               lowercase {
+                  showProperties =
+               }
+               regexp {
+                  showProperties = expression
+               }
+               removexss {
+                  showProperties =
+               }
+               titlecase {
+                  showProperties =
+               }
+               trim {
+                  showProperties = characterList
+               }
+               uppercase {
+                  showProperties =
+               }
+            }
+         }
+      }
+  }
+
diff --git a/typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/ShowTabs/Index.rst b/typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/ShowTabs/Index.rst
new file mode 100644 (file)
index 0000000..6b69cb4
--- /dev/null
@@ -0,0 +1,67 @@
+.. include:: ../../../../Includes.txt
+
+
+.. _wizard-settings-defaults-showtabs:
+
+========
+showTabs
+========
+
+(:ts:`mod.wizards.form.defaults.showTabs`)
+
+:aspect:`Property:`
+   showTabs
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Comma-separated list of the tabs that will be shown in the wizard.
+
+:aspect:`Default:`
+    elements, options, form
+
+
+.. _wizard-settings-defaults-tabs:
+
+tabs
+====
+
+(:ts:`mod.wizards.form.defaults.tabs`)
+
+:aspect:`Property:`
+    tabs
+
+:aspect:`Data type:`
+    [array of objects]
+
+    ->tabs.[tabName]
+
+:aspect:`Description:`
+    Configuration for each tab.
+
+
+Example
+=======
+
+.. code-block:: typoscript
+
+  mod.wizards {
+    form {
+      defaults {
+        showTabs = elements, options, form
+        tabs {
+          elements {
+            ...
+          }
+          options {
+            ...
+          }
+          form {
+            ...
+          }
+        }
+      }
+    }
+  }
+
diff --git a/typo3/sysext/form/Documentation/Administration/WizardSettings/ElementsReference/Index.rst b/typo3/sysext/form/Documentation/Administration/WizardSettings/ElementsReference/Index.rst
new file mode 100644 (file)
index 0000000..06f2767
--- /dev/null
@@ -0,0 +1,41 @@
+.. include:: ../../../Includes.txt
+
+
+.. _wizard-settings-elements:
+
+==================
+Elements reference
+==================
+
+Overrule the default settings of the :ref:`Option <wizard-settings-defaults-options-tab>`
+tab for specific element types.
+
+In the left "settings" part there is a tab called "options". The contents
+of this tab will adapt itself to the selected element type in the form.
+If no elements configuration is used, the default settings will be used.
+
+
+.. _overriding-element-settings:
+
+Overriding element settings
+===========================
+
+It is possible to override the default option tab settings for each
+element individually. This is done by using the same configuration as
+in :ts:`mod.wizards.form.defaults.tabs.options`, but using this
+configuration in :ts:`mod.wizards.form.elements.[elementName]`.
+
+The example below will hide all the accordions within the option tab for
+a text field (TEXTLINE element), except the filters:
+
+.. code-block:: typoscript
+
+   mod.wizards.form.elements {
+     textline {
+       showAccordions = filters
+     }
+   }
+
+By using this setting you can show or hide accordions, attributes,
+validation rules or filters, for each and every individual element.
+
diff --git a/typo3/sysext/form/Documentation/Administration/WizardSettings/Index.rst b/typo3/sysext/form/Documentation/Administration/WizardSettings/Index.rst
new file mode 100644 (file)
index 0000000..721f955
--- /dev/null
@@ -0,0 +1,25 @@
+.. include:: ../../Includes.txt
+
+
+.. _wizard-settings:
+
+===============
+Wizard settings
+===============
+
+The wizard basically consists of two parts on the screen, the left
+'settings' part and the right 'form' part. With TSconfig settings it
+is possible to configure the contents of the left 'settings' part. You
+can remove tabs, accordions or a specific setting for a single type of
+form element, or for all element types at once.
+
+The basic configuration has two settings: **defaults** and **elements**.
+
+.. toctree::
+    :maxdepth: 5
+    :titlesonly:
+    :glob:
+
+    DefaultsReference/Index
+    ElementsReference/Index
+
diff --git a/typo3/sysext/form/Documentation/Configuration/CheatSheet/Images.txt b/typo3/sysext/form/Documentation/Configuration/CheatSheet/Images.txt
deleted file mode 100644 (file)
index 4043419..0000000
+++ /dev/null
@@ -1,98 +0,0 @@
-.. |img-3|      image:: ../../Images/manual_html_m3837bcbc.gif
-
-.. |img-4|      image:: ../../Images/manual_html_m22cca77a.gif
-
-.. |img-5|      image:: ../../Images/manual_html_ff9d234.gif
-
-.. |img-6|      image:: ../../Images/manual_html_337f7996.gif
-
-.. |img-7|      image:: ../../Images/manual_html_5a895c1b.gif
-
-.. |img-8|      image:: ../../Images/manual_html_70ec28a8.gif
-
-.. |img-9|      image:: ../../Images/manual_html_m40ab0ab6.gif
-
-.. |img-10|     image:: ../../Images/manual_html_25e6309e.gif
-
-.. |img-11|     image:: ../../Images/manual_html_321f26af.gif
-
-.. |img-12|     image:: ../../Images/manual_html_m70052c90.gif
-
-.. |img-13|     image:: ../../Images/manual_html_3586365b.gif
-
-.. |img-14|     image:: ../../Images/manual_html_m75fa143c.gif
-
-.. |img-15|     image:: ../../Images/manual_html_m3c66c6dd.gif
-
-.. |img-16|     image:: ../../Images/manual_html_28e36562.gif
-
-.. |img-17|     image:: ../../Images/manual_html_3c6f1f23.gif
-
-.. |img-18|     image:: ../../Images/manual_html_5f65099f.gif
-
-.. |img-19|     image:: ../../Images/manual_html_4b0ea130.gif
-
-.. |img-20|     image:: ../../Images/manual_html_438a2594.gif
-
-.. |img-21|     image:: ../../Images/manual_html_186032f3.gif
-
-.. |img-22|     image:: ../../Images/manual_html_7e824c07.gif
-
-.. |img-23|     image:: ../../Images/manual_html_4d1eb931.gif
-
-.. |img-24|     image:: ../../Images/manual_html_502d7270.gif
-
-.. |img-25|     image:: ../../Images/manual_html_m2dd8530f.gif
-
-.. |img-26|     image:: ../../Images/manual_html_m1c465b5.gif
-
-.. |img-27|     image:: ../../Images/manual_html_m53713322.gif
-
-.. |img-28|     image:: ../../Images/manual_html_73ab25bc.gif
-
-.. |img-29|     image:: ../../Images/manual_html_25aa50b.gif
-
-.. |img-30|     image:: ../../Images/manual_html_47d0c0f5.gif
-
-.. |img-31|     image:: ../../Images/manual_html_32b66a39.gif
-
-.. |img-32|     image:: ../../Images/manual_html_620cb0bb.gif
-
-.. |img-33|     image:: ../../Images/manual_html_9c1933f.gif
-
-.. |img-34|     image:: ../../Images/manual_html_m12b7b0cf.gif
-
-.. |img-35|     image:: ../../Images/manual_html_39658741.gif
-
-.. |img-36|     image:: ../../Images/manual_html_30fb4c32.gif
-
-.. |img-37|     image:: ../../Images/manual_html_182a46d8.gif
-
-.. |img-38|     image:: ../../Images/manual_html_1e4ad6a6.gif
-
-.. |img-39|     image:: ../../Images/manual_html_7db905c0.gif
-
-.. |img-40|     image:: ../../Images/manual_html_60b2a25d.gif
-
-.. |img-41|     image:: ../../Images/manual_html_m24562829.gif
-
-.. |img-42|     image:: ../../Images/manual_html_m4add2f9e.gif
-
-.. |img-43|     image:: ../../Images/manual_html_36840da.gif
-
-.. |img-44|     image:: ../../Images/manual_html_m5b70d7a1.gif
-
-.. |img-45|     image:: ../../Images/manual_html_53be38ce.gif
-
-.. |img-46|     image:: ../../Images/manual_html_m28faa6da.gif
-
-.. |img-47|     image:: ../../Images/manual_html_1f67d897.gif
-
-.. |img-48|     image:: ../../Images/manual_html_493014a5.gif
-.. :align: texttop
-
-.. |img-49|     image:: ../../Images/manual_html_m98c0d65.gif
-
-.. |img-50|     image:: ../../Images/manual_html_61c51f35.gif
-
-.. |img-51|     image:: ../../Images/manual_html_72e526ed.gif
diff --git a/typo3/sysext/form/Documentation/Configuration/CheatSheet/Index.rst b/typo3/sysext/form/Documentation/Configuration/CheatSheet/Index.rst
deleted file mode 100644 (file)
index 0407249..0000000
+++ /dev/null
@@ -1,58 +0,0 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
-
-
-.. _cheatsheets:
-
-Cheat sheets
-^^^^^^^^^^^^
-
-This section contains cheat sheets for all attributes and layouts
-of each FORM object, as well as for validation rules and filters.
-
-.. _cheatsheets-attributes:
-
-FORM objects attributes
-"""""""""""""""""""""""
-
-.. figure:: ../../Images/CheatSheetAttributes.png
-   :alt: Attributes cheat sheet
-
-   All possible attributes of FORM objects, per object type
-
-
-.. _cheatsheets-layouts:
-
-FORM objects layouts
-""""""""""""""""""""
-
-.. figure:: ../../Images/CheatSheetLayouts.png
-   :alt: Layout cheat sheet
-
-   Default layouts of each FORM object
-
-
-.. _cheatsheets-rules:
-
-Validation rules
-""""""""""""""""
-
-.. figure:: ../../Images/CheatSheetRules.png
-   :alt: Rules cheat sheet
-
-   Rules applied for each validation type
-
-
-.. _cheatsheets-filters:
-
-Filters
-"""""""
-
-.. figure:: ../../Images/CheatSheetFilters.png
-   :alt: Filters cheat sheet
-
-   Rules applied for each filter
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Alphabetic/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Alphabetic/Index.rst
new file mode 100644 (file)
index 0000000..fe954f8
--- /dev/null
@@ -0,0 +1,33 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-alphabetic:
+
+==========
+alphabetic
+==========
+
+Removes all characters which are not in the range a-z or A-Z. With the
+setting allowWhiteSpace, spaces are allowed as well.
+
+
+.. _reference-filters-alphabetic-allowwhitespace:
+
+allowWhiteSpace
+===============
+
+:aspect:`Property:`
+    allowWhiteSpace
+
+:aspect:`Data type:`
+    boolean
+
+:aspect:`Description:`
+    If allowWhiteSpace = 1, whitespace is allowed in front of, after or
+    between the characters.
+
+:aspect:`Default:`
+    0
+
+[tsref:(cObject).FORM->filters.alphabetic]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Alphanumeric/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Alphanumeric/Index.rst
new file mode 100644 (file)
index 0000000..437e71a
--- /dev/null
@@ -0,0 +1,33 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-alphanumeric:
+
+============
+alphanumeric
+============
+
+Removes all characters which are not in the range a-z, A-Z or 0-9. With the
+setting allowWhiteSpace, spaces are allowed as well.
+
+
+.. _reference-filters-alphanumeric-allowwhitespace:
+
+allowWhiteSpace
+===============
+
+:aspect:`Property:`
+    allowWhiteSpace
+
+:aspect:`Data type:`
+    boolean
+
+:aspect:`Description:`
+    If allowWhiteSpace = 1, whitespace is allowed in front of, after or
+    between the characters.
+
+:aspect:`Default:`
+    0
+
+[tsref:(cObject).FORM->filters.alphanumeric]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Currency/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Currency/Index.rst
new file mode 100644 (file)
index 0000000..6e85c76
--- /dev/null
@@ -0,0 +1,71 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-currency:
+
+========
+currency
+========
+
+Changes a number to a formatted version with two decimals. The decimals
+point and thousands separator are configurable.
+
+**Example**
+
+- Submitted data: 100000.99
+
+- Filtered: 100 000,99
+
+.. code-block:: typoscript
+
+  filters {
+    1 = currency
+    1 {
+      decimalPoint = ,
+      thousandSeparator = space
+    }
+  }
+
+
+.. _reference-filters-currency-decimalpoint:
+
+decimalPoint
+============
+
+:aspect:`Property:`
+    decimalPoint
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Value for the decimal point, mostly a dot '.' or a comma ','
+
+:aspect:`Default:`
+    .
+
+
+.. _reference-filters-currency-thousandseparator:
+
+thousandSeparator
+=================
+
+:aspect:`Property:`
+    thousandSeparator
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Value for the thousand separator.
+
+    Special values:
+
+    - **space** : Adds a space as thousand separator
+    - **none** : No thousand separator
+
+:aspect:`Default:`
+    ,
+
+[tsref:(cObject).FORM->filters.currency]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Digit/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Digit/Index.rst
new file mode 100644 (file)
index 0000000..8c3602e
--- /dev/null
@@ -0,0 +1,11 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-digit:
+
+=====
+digit
+=====
+
+Removes all characters which are not in the range 0-9.
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Index.rst
new file mode 100644 (file)
index 0000000..79d7f01
--- /dev/null
@@ -0,0 +1,59 @@
+.. include:: ../../Includes.txt
+
+
+.. _reference-filters:
+
+Filters
+=======
+
+Add filters to the FORM objects.
+
+It is possible to have multiple filters for one FORM object, but the filters
+have to be added one by one.
+
+The submitted data for this particular object will be filtered by the
+assigned filters in the given order. The filtered data will be shown to the
+visitor when there are errors in the form or on a confirmation page.
+Otherwise the filtered data will be send by mail to the receiver.
+
+.. attention::
+
+   By default, all submitted data will be filtered by a Cross Site Scripting
+   (XSS) filter to prevent security issues.
+
+.. toctree::
+    :maxdepth: 5
+    :titlesonly:
+    :glob:
+
+    Alphabetic/Index.rst
+    Alphanumeric/Index.rst
+    Currency/Index.rst
+    Digit/Index.rst
+    Integer/Index.rst
+    Lowercase/Index.rst
+    Regexp/Index.rst
+    Removexss/Index.rst
+    Stripnewlines/Index.rst
+    Titlecase/Index.rst
+    Trim/Index.rst
+    Uppercase/Index.rst
+
+**Example**
+
+The example shown below applies two filters to a FORM object.
+
+- Submitted data: john doe3
+
+- Filtered: John Doe
+
+.. code-block:: typoscript
+
+  filters {
+    1 = alphabetic
+    1 {
+      allowWhiteSpace = 1
+    }
+    2 = titlecase
+  }
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Integer/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Integer/Index.rst
new file mode 100644 (file)
index 0000000..a05461b
--- /dev/null
@@ -0,0 +1,12 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-integer:
+
+=======
+integer
+=======
+
+Integers can be specified in decimal (10-based), optionally preceded by a
+sign (- or +).
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Lowercase/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Lowercase/Index.rst
new file mode 100644 (file)
index 0000000..ab78c23
--- /dev/null
@@ -0,0 +1,12 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-lowercase:
+
+=========
+lowercase
+=========
+
+Returns the incoming value with all alphabetic characters converted to
+lowercase. Alphabetic is determined by the Unicode character properties.
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Regexp/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Regexp/Index.rst
new file mode 100644 (file)
index 0000000..2e2bf11
--- /dev/null
@@ -0,0 +1,28 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-regexp:
+
+======
+regexp
+======
+
+Removes matches in the submitted data found by the defined pattern.
+
+
+.. _reference-filters-regexp-expression:
+
+expression
+==========
+
+:aspect:`Property:`
+    expression
+
+:aspect:`Data type:`
+    boolean
+
+:aspect:`Description:`
+    The pattern holding the characters which need to be deleted.
+
+[tsref:(cObject).FORM->filters.regexp]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Removexss/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Removexss/Index.rst
new file mode 100644 (file)
index 0000000..f55525f
--- /dev/null
@@ -0,0 +1,16 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-removexss:
+
+=========
+removexss
+=========
+
+This filter will process all incoming data by default. There is no need to
+add this filter manually.
+
+It filters the incoming data on possible Cross Site Scripting attacks and
+renders the incoming data safely by removing potential XSS code and adding a
+replacement string which destroys the tags.
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Stripnewlines/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Stripnewlines/Index.rst
new file mode 100644 (file)
index 0000000..943570d
--- /dev/null
@@ -0,0 +1,11 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-stripnewlines:
+
+=============
+stripnewlines
+=============
+
+Convenient for textareas. It removes new lines from the submitted value.
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Titlecase/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Titlecase/Index.rst
new file mode 100644 (file)
index 0000000..9f30a8b
--- /dev/null
@@ -0,0 +1,24 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-titlecase:
+
+=========
+titlecase
+=========
+
+Returns the incoming value with all alphabetic characters converted to title
+case. Alphabetic is determined by the Unicode character properties.
+
+**Example**
+
+- Submitted data: kasper skårhøj
+
+- Filtered: Kasper Skårhøj
+
+.. code-block:: typoscript
+
+  filters {
+    1 = titlecase
+  }
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Trim/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Trim/Index.rst
new file mode 100644 (file)
index 0000000..6b457f4
--- /dev/null
@@ -0,0 +1,33 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-trim:
+
+====
+trim
+====
+
+Strips characters from the beginning and the end of the submitted value
+according to the list of characters. If no character list is set, it will
+only trim an ordinary space, a tab, a new line, a carriage return, the
+NUL-byte and a vertical tab.
+
+
+.. _reference-filters-trim-characterlist:
+
+characterList
+=============
+
+:aspect:`Property:`
+    characterList
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    List of characters to be trimmed.
+
+    See the PHP-manual (trim) for the options of the charlist.
+
+[tsref:(cObject).FORM->filters.regexp]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Filters/Uppercase/Index.rst b/typo3/sysext/form/Documentation/Configuration/Filters/Uppercase/Index.rst
new file mode 100644 (file)
index 0000000..b4e7276
--- /dev/null
@@ -0,0 +1,12 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-filters-uppercase:
+
+=========
+uppercase
+=========
+
+Returns the incoming value with all alphabetic characters converted to
+uppercase. Alphabetic is determined by the Unicode character properties.
+
index 9ee8e05..eca2c41 100644 (file)
@@ -1,23 +1,28 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
-
+.. include:: ../Includes.txt
 
 
 .. _configuration:
 
+=============
 Configuration
--------------
+=============
 
+.. only:: html
 
-.. toctree::
-   :maxdepth: 5
-   :titlesonly:
-   :glob:
+    .. tip::
 
-   Reference/Index
-   CheatSheet/Index
+      Whenever you see a reference to anything named an "object" in this
+      section it is a reference to a "FORM object" and not the "cObjects"
+      unless it is clearly stated.
+
+.. toctree::
+    :maxdepth: 5
+    :titlesonly:
+    :glob:
+
+    Objects/Index
+    Layout/Index
+    Rules/Index
+    Filters/Index
+    Postprocessors/Index
 
diff --git a/typo3/sysext/form/Documentation/Configuration/Layout/Index.rst b/typo3/sysext/form/Documentation/Configuration/Layout/Index.rst
new file mode 100644 (file)
index 0000000..31e07be
--- /dev/null
@@ -0,0 +1,71 @@
+.. include:: ../../Includes.txt
+
+
+.. _reference-layout:
+
+======
+Layout
+======
+
+.. attention::
+
+    The form wizard (available in the TYPO3 backend) does not support the
+    complex layout mechanism described in this chapter. As soon as the
+    integrator has applied custom layout settings, the form wizard should
+    not be used anymore. When opening the customized form inside the form
+    wizard and hitting the "Save" button, all custom layout settings will be
+    lost.
+
+Using layout allows the integrator to change the default visual appearance
+of the FORM objects.
+
+The FORM consists of FORM objects, which have their own layout each. The
+layout of these objects can be changed for the whole form, for a specific
+view or just for a particular object.
+
+By default, the overall markup is based on ordered lists with list elements
+in it, to have a proper layout framework which is also accessible for people
+with disabilities.
+
+Some objects are considered being container objects, as they have child
+objects. These objects are FORM, FIELDSET, CHECKBOXGROUP and RADIOGROUP. To
+have a proper markup for these objects, nested ordered lists are used.
+
+**Example**
+
+.. code-block:: html
+
+  <form>
+    <ol>
+      <li>
+        <fieldset>
+          <ol>
+            <li>
+              <input />
+            </li>
+          </ol>
+        </fieldset>
+      </li>
+      <li>
+        <input />
+      </li>
+    </ol>
+  </form>
+
+It could be stated that SELECT and OPTGROUP elements are container objects
+as well, and actually this is correct. They also contain child objects. But
+these objects are not allowed to use the above mentioned markup.
+
+There are 3 ways to modify the layout:
+
+.. toctree::
+    :maxdepth: 5
+    :titlesonly:
+    :glob:
+
+    LayoutWholeForm/Index
+    LayoutViewSpecific/Index
+    LayoutObjectSpecific/Index
+
+
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Layout/LayoutObjectSpecific/Index.rst b/typo3/sysext/form/Documentation/Configuration/Layout/LayoutObjectSpecific/Index.rst
new file mode 100644 (file)
index 0000000..84e5110
--- /dev/null
@@ -0,0 +1,29 @@
+.. include:: ../../../Includes.txt
+
+
+.. _change-layout-individual-form:
+
+===============================================
+Change the layout for an individual FORM object
+===============================================
+
+It is also possible to override the layout setting of a particular object
+within the form, like a checkbox. The layout function within an object only
+accepts the markup, like the following one.
+
+.. code-block:: typoscript
+
+  tt_content.mailform.20 {
+    10 = CHECKBOX
+    10 {
+      label = I want to receive the monthly newsletter by email.
+      layout (
+        <input />
+        <label />
+      )
+    }
+  }
+
+The example shows how to switch the input field and the label, just for this
+particular checkbox.
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Layout/LayoutViewSpecific/Index.rst b/typo3/sysext/form/Documentation/Configuration/Layout/LayoutViewSpecific/Index.rst
new file mode 100644 (file)
index 0000000..46ab09e
--- /dev/null
@@ -0,0 +1,1623 @@
+.. include:: ../../../Includes.txt
+
+
+.. _change-layout-specific-view:
+
+=====================================
+Change the layout for a specific view
+=====================================
+
+.. contents::
+    :local:
+    :depth: 1
+
+
+.. _change-layout-specific-view-available-views:
+
+Available views
+===============
+
+There are 3 views available:
+
+form:
+  This view displays the form with its form fields which can be filled by
+  the user and submitted.
+
+confirmation:
+  If activated, this view shows a confirmation page which has to be
+  confirmed by the user.
+
+postProcessor:
+  The mail postProcessor has its own view for rendering the mail which is
+  sent to the receiver.
+
+It is not recommended to change the layout of a FORM object for all views.
+For example when customizing the TEXTLINE object the integrator will get
+strange results based on the following example:
+
+.. code-block:: typoscript
+
+  tt_content.mailform.20 {
+    layout {
+      textline (
+        <div class="form-group">
+          <div class="col-sm-3 control-label">
+            <label />
+          </div>
+          <div class="col-sm-5">
+            <input class="form-control" />
+          </div>
+        </div>
+      )
+    }
+  }
+
+The setup shown above changes the appearance of all TEXTLINE objects for all
+views. That is, the user will get a confirmation page and a mail with
+broken/ senseless input fields instead of the user data.
+
+In order to only change the TEXTLINE object specific to all of the 3 views,
+the following code could be applied.
+
+.. code-block:: typoscript
+
+  tt_content.mailform.20 {
+    # customize form view
+    form {
+      layout {
+        textline (
+          <div class="form-group">
+            <div class="col-sm-3 control-label">
+              <label />
+            </div>
+            <div class="col-sm-5">
+              <input class="form-control" />
+            </div>
+          </div>
+        )
+      }
+    }
+
+    # customize confirmation view
+    confirmation {
+      layout {
+        textline (
+          <div class="form-group">
+            <div class="col-sm-3">
+              <strong><label /></strong>
+            </div>
+            <div class="col-sm-5">
+              <inputvalue />
+            </div>
+          </div>
+        )
+      }
+    }
+
+    # customize postProcessor/ mail
+    postProcessor {
+      layout {
+        textline (
+          <td colspan="2">
+            <div class="textline"><inputvalue /></div>
+          </td>
+        )
+      }
+    }
+  }
+
+
+.. _change-layout-specific-view-properties:
+
+Properties and defaults
+=======================
+
+If the integrator does not define any :ts:`.layout` setting the default
+layout defined in the PHP classes will be used.
+
+The following list shows all available elements within all the different
+views including their corresponding default layouts.
+
+.. contents::
+    :local:
+    :depth: 1
+
+
+.. _reference-layout-form:
+
+form
+^^^^
+
+:aspect:`Property:`
+    form
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+
+:aspect:`Description:`
+    Layout of the FORM object/ outer wrap.
+
+    The <containerwrap /> tag will be substituted by the outer container
+    wrap and includes all child elements.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <form>
+        <containerWrap />
+      </form>
+
+
+.. _reference-layout-confirmation:
+
+confirmation
+^^^^^^^^^^^^
+
+:aspect:`Property:`
+    confirmation
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - confirmation
+
+:aspect:`Description:`
+    Layout of the outer wrap.
+
+    The <containerwrap /> tag will be substituted by the outer container
+    wrap and includes all child elements.
+
+:aspect:`Default:`
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <containerWrap />
+
+
+.. _reference-layout-html:
+
+html
+^^^^
+
+:aspect:`Property:`
+    html
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - postProcessor
+
+:aspect:`Description:`
+    Layout of the outer wrap.
+
+    The <containerwrap /> tag will be substituted by the outer container
+    wrap and includes all child elements.
+
+:aspect:`Default:`
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <html>
+        <head>
+          <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+        </head>
+        <body>
+          <table cellspacing="0">
+            <containerWrap />
+          </table>
+        </body>
+      </html>
+
+
+.. _reference-layout-containerwrap:
+
+containerWrap
+^^^^^^^^^^^^^
+
+:aspect:`Property:`
+    containerWrap
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Inner wrap for container objects.
+
+    The <elements /> tag will be substituted with all the child elements,
+    including their element wraps.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <ol>
+        <elements />
+      </ol>
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <ol>
+        <elements />
+      </ol>
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <tbody>
+        <elements />
+      </tbody>
+
+
+.. _reference-layout-elementwrap:
+
+elementWrap
+^^^^^^^^^^^
+
+:aspect:`Property:`
+    elementWrap
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Outer wrap for regular objects.
+
+    The <element /> tag will be substituted with the child element.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <li>
+        <element />
+      </li>
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <li>
+        <element />
+      </li>
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <tr>
+        <element />
+      </tr>
+
+
+.. _reference-layout-label:
+
+label
+^^^^^
+
+:aspect:`Property:`
+    label
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the labels.
+
+    The <labelvalue /> tag will be substituted with the label text.
+
+    If available, the <mandatory /> tag will be substituted with the
+    validation rule message, styled by its own layout.
+
+    If available, the <error /> tag will be substituted with the error
+    message from the validation rule when the submitted value is not valid.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label>
+        <labelvalue />
+        <mandatory />
+        <error />
+      </label>
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <label>
+        <labelvalue />
+      </label>
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <em>
+        <labelvalue />
+      </em>
+
+
+.. _reference-layout-mandatory:
+
+mandatory
+^^^^^^^^^
+
+:aspect:`Property:`
+    mandatory
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+
+:aspect:`Description:`
+    Layout for the validation rule message to describe the rule.
+
+    The <mandatoryvalue /> tag will be substituted with the validation rule
+    message.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <em>
+        <mandatoryvalue />
+      </em>
+
+
+.. _reference-layout-error:
+
+error
+^^^^^
+
+:aspect:`Property:`
+    error
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+
+:aspect:`Description:`
+    Layout for the validation rule error message when the submitted data
+    does not validate.
+
+    The <errorvalue /> tag will be substituted with the validation rule
+    error message.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <strong>
+        <errorvalue />
+      </strong>
+
+
+.. _reference-layout-legend:
+
+legend
+^^^^^^
+
+:aspect:`Property:`
+    legend
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the legend.
+
+    The <legendvalue /> tag will be substituted with the legend text.
+
+    If available, the <mandatory /> tag will be substituted with the
+    validation rule message, styled by its own layout.
+
+    If available, the <error /> tag will be substituted with the error
+    message from the validation rule when the submitted value is not valid.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <legend>
+        <legendvalue />
+        <mandatory />
+        <error />
+      </legend>
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <legend>
+        <legendvalue />
+      </legend>
+
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <thead>
+        <tr>
+          <th colspan="2" align="left">
+            <legendvalue />
+          </th>
+        </tr>
+      </thead>
+
+
+.. _reference-layout-button:
+
+button
+^^^^^^
+
+:aspect:`Property:`
+    button
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+
+:aspect:`Description:`
+    Layout for the BUTTON object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label />
+      <input />
+
+
+.. _reference-layout-checkbox:
+
+checkbox
+^^^^^^^^
+
+:aspect:`Property:`
+    checkbox
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the CHECKBOX object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label />
+      <input />
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <label />
+      <inputvalue />
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <td style="width: 200px;">
+        <label />
+      </td>
+      <td>
+        <inputvalue />
+      </td>
+
+
+.. _reference-layout-checkboxgroup:
+
+checkboxgroup
+^^^^^^^^^^^^^
+
+:aspect:`Property:`
+    checkboxgroup
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the CHECKBOXGROUP object.
+
+    The <containerwrap /> tag will be substituted by the outer container
+    wrap and includes all child elements.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <fieldset>
+        <legend />
+        <containerWrap />
+      </fieldset>
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <fieldset>
+        <legend />
+        <containerWrap />
+      </fieldset>
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <td colspan="2">
+        <table cellspacing="0" style="padding-left: 20px; margin-bottom: 20px;">
+          <legend />
+          <containerWrap />
+        </table>
+      </td>
+
+
+.. _reference-layout-fieldset:
+
+fieldset
+^^^^^^^^
+
+:aspect:`Property:`
+    fieldset
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the FIELDSET object.
+
+    The <containerwrap /> tag will be substituted by the outer container
+    wrap and includes all child elements.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <fieldset>
+        <legend />
+        <containerWrap />
+      </fieldset>
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <fieldset>
+        <legend />
+        <containerWrap />
+      </fieldset>
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <td colspan="2">
+        <table cellspacing="0" style="padding-left: 20px; margin-bottom: 20px;">
+          <legend />
+          <containerWrap />
+        </table>
+      </td>
+
+
+.. _reference-layout-fileupload:
+
+fileupload
+^^^^^^^^^^
+
+:aspect:`Property:`
+    fileupload
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the FILEUPLOAD object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label />
+      <input />
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <label />
+      <inputvalue />
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <td style="width: 200px;">
+        <label />
+      </td>
+      <td>
+        <inputvalue />
+      </td>
+
+
+.. _reference-layout-hidden:
+
+hidden
+^^^^^^
+
+:aspect:`Property:`
+    hidden
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the HIDDEN object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <input />
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <td style="width: 200px;">
+        <em>
+          <label />
+        </em>
+      </td>
+      <td>
+        <inputvalue />
+      </td>
+
+
+.. _reference-layout-imagebutton:
+
+imagebutton
+^^^^^^^^^^^
+
+:aspect:`Property:`
+    imagebutton
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+
+:aspect:`Description:`
+    Layout for the IMAGEBUTTON object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label />
+      <input />
+
+
+.. _reference-layout-optgroup:
+
+optgroup
+^^^^^^^^
+
+:aspect:`Property:`
+    optgroup
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the OPTGROUP object.
+
+    The <elements /> tag will be substituted with all the child elements,
+    which actually can only be OPTION objects.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <optgroup>
+        <elements />
+      </optgroup>
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <elements />
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <elements />
+
+
+.. _reference-layout-option:
+
+option
+^^^^^^
+
+:aspect:`Property:`
+    option
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the OPTION object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <option />
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <inputvalue />
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <div>
+        <inputvalue />
+      </div>
+
+
+.. _reference-layout-password:
+
+password
+^^^^^^^^
+
+:aspect:`Property:`
+    password
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+
+:aspect:`Description:`
+    Layout for the PASSWORD object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label />
+      <input />
+
+
+.. _reference-layout-radio:
+
+radio
+^^^^^
+
+:aspect:`Property:`
+    radio
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the RADIO object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label />
+      <input />
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <label />
+      <inputvalue />
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <td style="width: 200px;">
+        <label />
+      </td>
+      <td>
+        <inputvalue />
+      </td>
+
+
+.. _reference-layout-radiogroup:
+
+radiogroup
+^^^^^^^^^^
+
+:aspect:`Property:`
+    radiogroup
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the RADIOGROUP object.
+
+    The <containerwrap /> tag will be substituted by the outer container
+    wrap and includes all child elements.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <fieldset>
+        <legend />
+        <containerWrap />
+      </fieldset>
+
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <fieldset>
+        <legend />
+        <containerWrap />
+      </fieldset>
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <td colspan="2">
+        <table cellspacing="0" style="padding-left: 20px; margin-bottom: 20px;">
+          <legend />
+          <containerWrap />
+        </table>
+      </td>
+
+
+.. _reference-layout-reset:
+
+reset
+^^^^^
+
+:aspect:`Property:`
+    reset
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+
+:aspect:`Description:`
+    Layout for the RESET object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label />
+      <input />
+
+
+.. _reference-layout-select:
+
+select
+^^^^^^
+
+:aspect:`Property:`
+    select
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the SELECT object.
+
+    The <elements /> tag will be substituted with all the child elements,
+    which only can be OPTGROUP or OPTION objects.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label />
+      <select>
+         <elements />
+      </select>
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <label />
+      <ol>
+         <elements />
+      </ol>
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <td style="width: 200px;">
+        <label />
+      </td>
+      <td>
+        <elements />
+      </td>
+
+
+.. _reference-layout-submit:
+
+submit
+^^^^^^
+
+:aspect:`Property:`
+    submit
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+
+:aspect:`Description:`
+    Layout for the SUBMIT object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label />
+      <input />
+
+
+.. _reference-layout-textarea:
+
+textarea
+^^^^^^^^
+
+:aspect:`Property:`
+    textarea
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the TEXTAREA object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label />
+      <textarea />
+
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <label />
+      <inputvalue />
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <td style="width: 200px;" valign="top">
+          <label />
+      </td>
+      <td>
+          <inputvalue />
+      </td>
+
+
+.. _reference-layout-textblock:
+
+textblock
+^^^^^^^^^
+
+:aspect:`Property:`
+    textblock
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+
+:aspect:`Description:`
+    Layout for the TEXTBLOCK object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <textblock />
+
+
+.. _reference-layout-textline:
+
+textline
+^^^^^^^^
+
+:aspect:`Property:`
+    textline
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Available in views:`
+    - form
+    - confirmation
+    - postProcessor
+
+:aspect:`Description:`
+    Layout for the TEXTLINE object.
+
+:aspect:`Default:`
+    Default layout **form view**:
+
+    .. code-block:: html
+
+      <label />
+      <input />
+
+    Default layout **confirmation view**:
+
+    .. code-block:: html
+
+      <label />
+      <inputvalue />
+
+    Default layout **postProcessor view**:
+
+    .. code-block:: html
+
+      <td style="width: 200px;">
+        <label />
+      </td>
+      <td>
+        <inputvalue />
+      </td>
+
+
+.. _change-layout-specific-view-example:
+
+Example showing all .layout properties and defaults
+===================================================
+
+The code snippets below shows all available settings across all views
+including their default layout.
+
+.. code-block:: typoscript
+
+  tt_content.mailform.20 {
+    # ###
+    # form view
+    # ####
+
+    form {
+      layout {
+        form (
+          <form>
+            <containerWrap />
+          </form>
+        )
+
+        containerWrap (
+          <ol>
+            <elements />
+          </ol>
+        )
+
+        elementWrap (
+          <li>
+            <element />
+          </li>
+        )
+
+        label (
+          <label>
+            <labelvalue />
+            <mandatory />
+            <error />
+          </label>
+        )
+
+        mandatory (
+          <em>
+            <mandatoryvalue />
+          </em>
+        )
+
+        error (
+          <strong>
+            <errorvalue />
+          </strong>
+        )
+
+        legend (
+          <legend>
+            <legendvalue />
+            <mandatory />
+            <error />
+          </legend>
+        )
+
+        button (
+          <label />
+          <input />
+        )
+
+        checkbox (
+          <label />
+          <input />
+        )
+
+        checkboxgroup (
+          <fieldset>
+            <legend />
+            <containerWrap />
+          </fieldset>
+        )
+        fieldset (
+            <fieldset>
+                <legend />
+                <containerWrap />
+            </fieldset>
+        )
+
+        fileupload (
+          <label />
+          <input />
+        )
+
+        hidden (
+          <input />
+        )
+
+        imagebutton (
+          <label />
+          <input />
+        )
+
+        optgroup (
+          <optgroup>
+            <elements />
+          </optgroup>
+        )
+
+        option (
+          <option />
+        )
+
+        password (
+          <label />
+          <input />
+        )
+
+        radio (
+          <label />
+          <input />
+        )
+
+        radiogroup (
+          <fieldset>
+            <legend />
+            <containerWrap />
+          </fieldset>
+        )
+
+        reset (
+          <label />
+          <input />
+        )
+
+        select (
+          <label />
+          <select>
+            <elements />
+          </select>
+        )
+
+        submit (
+          <label />
+          <input />
+        )
+
+        textarea (
+          <label />
+          <textarea />
+        )
+
+        textblock (
+          <textblock />
+        )
+
+        textline (
+          <label />
+          <input />
+        )
+      }
+    }
+
+    # ###
+    # confirmation view
+    # ###
+
+    confirmation {
+      layout {
+        confirmation (
+          <containerWrap />
+        )
+
+        containerWrap (
+          <ol>
+            <elements />
+          </ol>
+        )
+
+        elementWrap (
+          <li>
+            <element />
+          </li>
+        )
+
+        label (
+          <label>
+            <labelvalue />
+          </label>
+        )
+
+        legend (
+          <legend>
+            <legendvalue />
+          </legend>
+        )
+
+        checkbox (
+          <label />
+          <inputvalue />
+        )
+
+        checkboxgroup (
+          <fieldset>
+            <legend />
+            <containerWrap />
+          </fieldset>
+        )
+
+        fieldset (
+          <fieldset>
+            <legend />
+            <containerWrap />
+          </fieldset>
+        )
+
+        fileupload (
+          <label />
+          <inputvalue />
+        )
+
+        optgroup (
+          <elements />
+        )
+
+        option (
+          <inputvalue />
+        )
+
+        radio (
+          <label />
+          <inputvalue />
+        )
+
+        radiogroup (
+          <fieldset>
+            <legend />
+            <containerWrap />
+          </fieldset>
+        )
+
+        select (
+          <label />
+          <ol>
+            <elements />
+          </ol>
+        )
+
+        textarea (
+          <label />
+          <inputvalue />
+        )
+
+        textline (
+          <label />
+          <inputvalue />
+        )
+      }
+    }
+
+    # ###
+    # postProcesso view
+    # ###
+
+    postProcessor {
+      layout {
+        html (
+          <html>
+            <head>
+              <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+            </head>
+            <body>
+              <table cellspacing="0">
+                <containerWrap />
+              </table>
+            </body>
+          </html>
+        )
+
+        containerWrap (
+          <tbody>
+            <elements />
+          </tbody>
+        )
+
+        elementWrap (
+          <tr>
+            <element />
+          </tr>
+        )
+
+        label (
+          <em>
+            <labelvalue />
+          </em>
+        )
+
+        legend (
+          <thead>
+            <tr>
+              <th colspan="2" align="left">
+                <legendvalue />
+              </th>
+            </tr>
+          </thead>
+        )
+
+        checkbox (
+          <td style="width: 200px;">
+            <label />
+          </td>
+          <td>
+            <inputvalue />
+          </td>
+        )
+
+        checkboxgroup (
+          <td colspan="2">
+            <table cellspacing="0" style="padding-left: 20px; margin-bottom: 20px;">
+              <legend />
+              <containerWrap />
+            </table>
+          </td>
+        )
+
+        fieldset (
+          <td colspan="2">
+            <table cellspacing="0" style="padding-left: 20px; margin-bottom: 20px;">
+              <legend />
+              <containerWrap />
+            </table>
+          </td>
+        )
+
+        fileupload (
+          <td style="width: 200px;">
+            <label />
+          </td>
+          <td>
+            <inputvalue />
+          </td>
+        )
+
+        hidden (
+          <td style="width: 200px;">
+            <em>
+              <label />
+            </em>
+          </td>
+          <td>
+            <inputvalue />
+          </td>
+        )
+
+        optgroup (
+          <elements />
+        )
+
+        option (
+          <div>
+            <inputvalue />
+          </div>
+        )
+
+        radio (
+          <td style="width: 200px;">
+            <label />
+          </td>
+          <td>
+            <inputvalue />
+          </td>
+        )
+
+        radiogroup (
+          <td colspan="2">
+            <table cellspacing="0" style="padding-left: 20px; margin-bottom: 20px;">
+              <legend />
+              <containerWrap />
+            </table>
+          </td>
+        )
+
+        select (
+          <td style="width: 200px;">
+            <label />
+          </td>
+          <td>
+            <elements />
+          </td>
+        )
+
+        textarea (
+          <td style="width: 200px;" valign="top">
+            <label />
+          </td>
+          <td>
+            <inputvalue />
+          </td>
+        )
+
+        textline (
+          <td style="width: 200px;">
+            <label />
+          </td>
+          <td>
+            <inputvalue />
+          </td>
+        )
+      }
+    }
+  }
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Layout/LayoutWholeForm/Index.rst b/typo3/sysext/form/Documentation/Configuration/Layout/LayoutWholeForm/Index.rst
new file mode 100644 (file)
index 0000000..5ee3526
--- /dev/null
@@ -0,0 +1,46 @@
+.. include:: ../../../Includes.txt
+
+
+.. _change-layout-of-whole-form:
+
+===================================
+Change the layout of the whole form
+===================================
+
+.. attention::
+
+    It is not recommended to change the layout globally for the whole form.
+    Unfortunately, using view specific layout settings did not work for a
+    long time and is now widely used by integrators.
+
+    There are several reasons for not to use global layout settings:
+
+    - Some objects cannot be changed globally.
+    - Changing some objects will cause problems which lead to failures in
+      the processing. The code will die with PHP errors.
+    - Quite often it does not make sense to do these changes globally.
+
+    Instead change the layout for a :ref:`specific view <change-layout-specific-view>`!
+
+Apart from the above mentioned problems one could change the layout globally
+using the following TypoScript setup. Using :ts:`tt_content.mailform.20`
+registers the chances for all forms of the below the page tree. If one wants
+to change the layout only for a specific form, a TypoScript library could be
+build as shown :ref:`here <reference-form-example>`.
+
+.. code-block:: typoscript
+
+  tt_content.mailform.20 {
+    layout {
+      # changing the layout of the form object globally
+      form (
+        <form class="form-class">
+          <containerWrap />
+        </form>
+      )
+    }
+  }
+
+As one can see, an (X)HTML kind of markup is used. Actually it is XML, with
+some extra tags like the :ts:`containerWrap`.
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Button/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Button/Index.rst
new file mode 100644 (file)
index 0000000..06eec34
--- /dev/null
@@ -0,0 +1,158 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-button:
+
+======
+BUTTON
+======
+
+Creates a push button. User agents should use the value of the value
+attribute as the button's label.
+
+Push buttons have no default behavior. Each push button may have
+client-side scripts associated with the element's event attributes.
+When an event occurs (e.g., the user presses the button, releases it,
+etc.), the associated script is triggered.
+
+
+.. _reference-button-accesskey:
+
+accesskey
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accesskey`.
+
+
+.. _reference-button-alt:
+
+alt
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-alt`.
+
+
+.. _reference-button-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-button-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-button-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-button-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-button-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-button-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-button-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-button`
+    specific information.
+
+
+.. _reference-button-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-button-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-button-tabindex:
+
+tabindex
+========
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-tabindex`.
+
+
+.. _reference-button-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-title`.
+
+
+.. _reference-button-type:
+
+type
+====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-type`.
+
+:aspect:`Default:`
+    button
+
+
+.. _reference-button-value:
+
+value
+=====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-value`.
+
+[tsref:(cObject).FORM.FormObject.BUTTON]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Checkbox/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Checkbox/Index.rst
new file mode 100644 (file)
index 0000000..3de4a63
--- /dev/null
@@ -0,0 +1,169 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-checkbox:
+
+========
+CHECKBOX
+========
+
+Creates a checkbox.
+
+Checkboxes are on/off switches that may be toggled by the user. A switch is
+"on" when the control element's checked attribute is set. When a form is
+submitted, only "on" checkbox controls can become successful.
+
+Several checkboxes in a form may share the same control name. Thus, for
+example, checkboxes allow users to select several values for the same
+property. A CHECKBOX object only displays one checkbox in the form.
+
+
+.. _reference-checkbox-accesskey:
+
+accesskey
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accesskey`.
+
+
+.. _reference-checkbox-alt:
+
+alt
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-alt`.
+
+
+.. _reference-checkbox-checked:
+
+checked
+=======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-checked`.
+
+
+.. _reference-checkbox-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-checkbox-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-checkbox-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-checkbox-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-checkbox-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-checkbox-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-checkbox-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-checkbox`
+    specific information.
+
+
+.. _reference-checkbox-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-checkbox-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-checkbox-tabindex:
+
+tabindex
+========
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-tabindex`.
+
+
+.. _reference-checkbox-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-title`.
+
+
+.. _reference-checkbox-type:
+
+type
+====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-type`.
+
+:aspect:`Default:`
+    checkbox
+
+
+.. _reference-checkbox-value:
+
+value
+=====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-value`.
+
+[tsref:(cObject).FORM.FormObject.CHECKBOX]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Fieldset/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Fieldset/Index.rst
new file mode 100644 (file)
index 0000000..7884cca
--- /dev/null
@@ -0,0 +1,96 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-fieldset:
+
+========
+FIELDSET
+========
+
+The FIELDSET element allows authors to group thematically related controls
+and labels. Grouping controls makes it easier for users to understand the
+purpose while simultaneously facilitating tabbing navigation for visual user
+agents and speech navigation for speech-oriented user agents. The proper use
+of this element makes documents more accessible.
+
+
+.. _reference-fieldset-1-2-3-4:
+
+1, 2, 3, 4 ...
+==============
+
+:aspect:`Property:`
+    1, 2, 3, 4 ...
+
+:aspect:`Data type:`
+    [array of FORM objects]
+
+:aspect:`Description:`
+    FORM objects that are part of the FIELDSET.
+
+
+.. _reference-fieldset-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-fieldset-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-fieldset-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-fieldset-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-fieldset-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-fieldset`
+    specific information.
+
+
+.. _reference-fieldset-legend:
+
+legend
+======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-legend`.
+
+
+.. _reference-fieldset-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+[tsref:(cObject).FORM.FormObject.FIELDSET]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Fileupload/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Fileupload/Index.rst
new file mode 100644 (file)
index 0000000..d7490ed
--- /dev/null
@@ -0,0 +1,156 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-fileupload:
+
+==========
+FILEUPLOAD
+==========
+
+Creates a file select control. User agents may use the value of the value
+attribute as the initial file name.
+
+This control type allows the user to select files so that their contents may
+be submitted with a form.
+
+
+.. _reference-fileupload-accesskey:
+
+accesskey
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accesskey`.
+
+
+.. _reference-fileupload-alt:
+
+alt
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-alt`.
+
+
+.. _reference-fileupload-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-fileupload-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-fileupload-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-fileupload-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-fileupload-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-fileupload-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-fileupload-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-fileupload`
+    specific information.
+
+
+.. _reference-fileupload-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-fileupload-size:
+
+size
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-size`.
+
+
+.. _reference-fileupload-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-fileupload-tabindex:
+
+tabindex
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-tabindex`.
+
+
+.. _reference-fileupload-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-title`.
+
+
+.. _reference-fileupload-type:
+
+type
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-type`.
+
+:aspect:`Default:`
+    file
+
+[tsref:(cObject).FORM.FormObject.FILEUPLOAD]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Form/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Form/Index.rst
new file mode 100644 (file)
index 0000000..928d05c
--- /dev/null
@@ -0,0 +1,313 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-form:
+
+====
+FORM
+====
+
+A form will always start with the FORM object. TYPO3 recognizes this object
+and sends all TypoScript data to the FORM extension.
+
+
+.. _reference-form-accept:
+
+accept
+======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accept`.
+
+
+.. _reference-form-accept-charset:
+
+accept-charset
+==============
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accept-charset`.
+
+
+.. _reference-form-action:
+
+action
+======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-action`.
+
+
+.. _reference-form-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-form-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-form-enctype:
+
+enctype
+=======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-enctype`.
+
+
+.. _reference-form-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-form-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-form-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-form`
+    specific information.
+
+
+.. _reference-form-method:
+
+method
+======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-method`.
+
+
+.. _reference-form-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-form-postprocessor:
+
+postProcessor
+=============
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-postProcessor`.
+
+
+.. _reference-form-prefix:
+
+prefix
+======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-prefix`.
+
+
+.. _reference-form-rules:
+
+rules
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-rules`.
+
+
+.. _reference-form-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-form-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-title`.
+
+
+[tsref:(cObject).FORM]
+
+.. _reference-form-example:
+
+Example
+=======
+
+This example shows a simple payment form. At the beginning the layout of the
+radio buttons is changed for the form view. The label and the input field
+are switched.
+
+The example builds a form as TypoScript library which can be assigned to a
+marker or used inside a fluid template. The defined layout settings are only
+valid within this TS library.
+
+.. code-block:: typoscript
+
+  lib.form = FORM
+  lib.form {
+    method = post
+
+    postProcessor {
+      # ...
+    }
+
+    form {
+      layout {
+        radio (
+          <input />
+          <label />
+        )
+      }
+    }
+
+    10 = FIELDSET
+    10 {
+      legend = Name
+
+      10 = SELECT
+      10 {
+        label = Title
+
+        10 = OPTION
+        10 {
+          data = Mr.
+          selected = 1
+        }
+
+        20 = OPTION
+        20 {
+          data = Mrs.
+        }
+
+        30 = OPTION
+        30 {
+          data = Ms.
+        }
+
+        40 = OPTION
+        40 {
+          data = Dr.
+        }
+
+        50 = OPTION
+        50 {
+          data = Viscount
+        }
+      }
+
+      20 = TEXTLINE
+      20 {
+        label = First name
+      }
+
+      30 = TEXTLINE
+      30 {
+        label = Last name
+      }
+    }
+
+    20 = FIELDSET
+    20 {
+      legend = Address
+
+      10 = TEXTLINE
+      10 {
+        label = Street
+      }
+
+      20 = TEXTLINE
+      20 {
+        label = City
+      }
+
+      30 = TEXTLINE
+      30 {
+        label = State
+      }
+
+      40 = TEXTLINE
+      40 {
+        label = ZIP code
+      }
+    }
+
+    30 = FIELDSET
+    30 {
+      legend = Payment details
+
+      10 = FIELDSET
+      10 {
+        legend = Credit card
+
+        10 = RADIO
+        10 {
+          label = American Express
+          name = creditcard
+        }
+
+        20 = RADIO
+        20 {
+          label = Mastercard
+          name = creditcard
+        }
+
+        30 = RADIO
+        30 {
+          label = Visa
+          name = creditcard
+        }
+
+        40 = RADIO
+        40 {
+          label = Blockbuster Card
+          name = creditcard
+        }
+      }
+
+      20 = TEXTLINE
+      20 {
+        label = Card number
+      }
+
+      30 = TEXTLINE
+      30 {
+        label = Expiry date
+      }
+    }
+
+    40 = SUBMIT
+    40 {
+      value = Submit my details
+    }
+  }
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Header/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Header/Index.rst
new file mode 100644 (file)
index 0000000..3b8940f
--- /dev/null
@@ -0,0 +1,30 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-header:
+
+======
+HEADER
+======
+
+Creates a textual headline wrapped with a headline tag (e.g. h1). This
+element can be used for a visual separation or transportation of content. It
+is neither displayed on the confirmation page nor in the email.
+
+.. _reference-header-content:
+
+content
+=======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-content`.
+
+
+.. _reference-header-headingSize:
+
+headingSize
+===========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-headingSize`.
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Hidden/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Hidden/Index.rst
new file mode 100644 (file)
index 0000000..727c6d6
--- /dev/null
@@ -0,0 +1,100 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-hidden:
+
+======
+HIDDEN
+======
+
+Creates a hidden control.
+
+Authors may create controls that are not rendered (visually) but whose
+values are submitted with a form. This control type can generally be used to
+store information between client/ server exchanges that would otherwise
+be lost due to the stateless nature of HTTP (see [RFC2616]).
+
+
+.. _reference-hidden-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-hidden-filters:
+
+filters
+=======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-filters`.
+
+
+.. _reference-hidden-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-hidden-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-hidden-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-hidden`
+    specific information.
+
+
+.. _reference-hidden-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-hidden-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-hidden-type:
+
+type
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-type`.
+
+
+.. _reference-hidden-value:
+
+value
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-value`.
+
+[tsref:(cObject).FORM.FormObject.HIDDEN]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Imagebutton/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Imagebutton/Index.rst
new file mode 100644 (file)
index 0000000..3ec8af6
--- /dev/null
@@ -0,0 +1,181 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-imagebutton:
+
+===========
+IMAGEBUTTON
+===========
+
+Creates a graphical submit button. The value of the src attribute specifies
+the URI of the image that will decorate the button. For accessibility
+reasons, authors should provide alternate text for the image via the alt
+attribute.
+
+When a pointing device is used to click on the image, the form is submitted
+and the click coordinates passed to the server. The x value is measured in
+pixels from the left of the image, and the y value in pixels from the top of
+the image. The submitted data includes name.x=x-value and name.y=y-value
+where "name" is the value of the name attribute, and x-value and y-value are
+the x and y coordinate values, respectively.
+
+If the server takes different actions depending on the location clicked,
+users of non-graphical browsers will be disadvantaged. For this reason,
+authors should consider alternate approaches:
+
+- Use multiple submit buttons (each with its own image) in place of a
+  single graphical submit button. Authors may use style sheets to control
+  the positioning of these buttons.
+
+- Use a client-side image map together with scripting.
+
+
+.. _reference-imagebutton-accesskey:
+
+accesskey
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accesskey`.
+
+
+.. _reference-imagebutton-alt:
+
+alt
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-alt`.
+
+
+.. _reference-imagebutton-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-imagebutton-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-imagebutton-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-imagebutton-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-imagebutton-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-imagebutton-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-imagebutton-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-imagebutton`
+    specific information.
+
+
+.. _reference-imagebutton-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-imagebutton-src:
+
+src
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-src`.
+
+
+.. _reference-imagebutton-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-imagebutton-tabindex:
+
+tabindex
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-tabindex`.
+
+
+.. _reference-imagebutton-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-title`.
+
+
+.. _reference-imagebutton-type:
+
+type
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-type`.
+
+:aspect:`Default:`
+    image
+
+
+.. _reference-imagebutton-value:
+
+value
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-value`.
+
+[tsref:(cObject).FORM.FormObject.IMAGEBUTTON]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Index.rst
new file mode 100644 (file)
index 0000000..7c9485a
--- /dev/null
@@ -0,0 +1,175 @@
+.. include:: ../../Includes.txt
+
+
+.. _form-objects:
+
+============
+FORM objects
+============
+
+The editor is not bound to the following FORM objects. Whenever FORM will be
+put in TypoScript, the contents of this property will be sent to the
+FORM plugin. However, one can use regular TYPO3 content objects (cObjects)
+as well. This means the integrator has the possibility to add COA, TEXT or
+even HMENU in the FORM TypoScript.
+
+Due to technical limitations it is **not** possible to nest form objects
+inside content objects. The following nesting will not work:
+:ts:`FORM` > :ts:`COA` > :ts:`TEXTLINE`.
+
+Furthermore, using cObjects is only allowed when **not** using the form
+content element/ wizard in the backend. This is due to security reasons.
+The functionality is only available when embedding a form directly in the
+TypoScript setup.
+
+.. toctree::
+    :maxdepth: 5
+    :titlesonly:
+    :glob:
+
+    ObjectAttributes/Index
+    Button/Index
+    Checkbox/Index
+    Fieldset/Index
+    Fileupload/Index
+    Form/Index
+    Header/Index
+    Hidden/Index
+    Imagebutton/Index
+    Optgroup/Index
+    Option/Index
+    Password/Index
+    Radio/Index
+    Reset/Index
+    Select/Index
+    Submit/Index
+    Textarea/Index
+    Textblock/Index
+    Textline/Index
+
+============== ================================================= ================================================= ================================================= ================================================= ====================================================== ===================================================
+Element        BUTTON                                            CHECKBOX                                          FIELDSET                                          FILEUPLOAD                                        FORM                                                   HEADER
+============== ================================================= ================================================= ================================================= ================================================= ====================================================== ===================================================
+accept                                                                                                                                                                                                                 :ref:`X <reference-objects-attributes-accept>`
+accept-charset                                                                                                                                                                                                         :ref:`X <reference-objects-attributes-accept-charset>`
+accesskey      :ref:`X <reference-objects-attributes-accesskey>` :ref:`X <reference-objects-attributes-accesskey>`                                                   :ref:`X <reference-objects-attributes-accesskey>`
+action                                                                                                                                                                                                                 :ref:`X <reference-objects-attributes-action>`
+alt            :ref:`X <reference-objects-attributes-alt>`       :ref:`X <reference-objects-attributes-alt>`                                                         :ref:`X <reference-objects-attributes-alt>`
+checked                                                          :ref:`X <reference-objects-attributes-checked>`
+class          :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`
+content                                                                                                                                                                                                                                                                       :ref:`X <reference-objects-attributes-content>`
+cols
+data
+dir            :ref:`X <reference-objects-attributes-dir>`       :ref:`X <reference-objects-attributes-dir>`       :ref:`X <reference-objects-attributes-dir>`       :ref:`X <reference-objects-attributes-dir>`       :ref:`X <reference-objects-attributes-dir>`
+disabled       :ref:`X <reference-objects-attributes-disabled>`  :ref:`X <reference-objects-attributes-disabled>`                                                    :ref:`X <reference-objects-attributes-disabled>`
+enctyp                                                                                                                                                                                                                 :ref:`X <reference-objects-attributes-enctype>`
+filters
+headingSize                                                                                                                                                                                                                                                                   :ref:`X <reference-objects-attributes-headingSize>`
+id             :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`
+label          :ref:`X <reference-objects-attributes-label>`     :ref:`X <reference-objects-attributes-label>`                                                       :ref:`X <reference-objects-attributes-label>`
+lang           :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`
+layout         :ref:`X <reference-layout>`                       :ref:`X <reference-layout>`                       :ref:`X <reference-layout>`                       :ref:`X <reference-layout>`                       :ref:`X <reference-layout>`
+legend                                                                                                             :ref:`X <reference-objects-attributes-legend>`
+maxlength
+method                                                                                                                                                                                                                 :ref:`X <reference-objects-attributes-method>`
+multiple
+name           :ref:`X <reference-objects-attributes-name>`      :ref:`X <reference-objects-attributes-name>`                                                        :ref:`X <reference-objects-attributes-name>`      :ref:`X <reference-objects-attributes-name>`
+postProcessor                                                                                                                                                                                                          :ref:`X <reference-objects-attributes-postProcessor>`
+prefix                                                                                                                                                                                                                 :ref:`X <reference-objects-attributes-prefix>`
+readonly
+rows
+rules                                                                                                                                                                                                                  :ref:`X <reference-objects-attributes-rules>`
+selected
+size                                                                                                                                                                 :ref:`X <reference-objects-attributes-size>`
+src
+style          :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`
+tabindex       :ref:`X <reference-objects-attributes-tabindex>`  :ref:`X <reference-objects-attributes-tabindex>`                                                    :ref:`X <reference-objects-attributes-tabindex>`
+title          :ref:`X <reference-objects-attributes-title>`     :ref:`X <reference-objects-attributes-title>`                                                       :ref:`X <reference-objects-attributes-title>`     :ref:`X <reference-objects-attributes-title>`
+type           :ref:`X <reference-objects-attributes-type>`      :ref:`X <reference-objects-attributes-type>`                                                        :ref:`X <reference-objects-attributes-type>`
+value          :ref:`X <reference-objects-attributes-value>`     :ref:`X <reference-objects-attributes-value>`
+============== ================================================= ================================================= ================================================= ================================================= ====================================================== ===================================================
+
+============== ================================================= ================================================= ================================================= ================================================= ================================================= =================================================
+Element        HIDDEN                                            IMAGEBUTTON                                       OPTGROUP                                          OPTION                                            PASSWORD                                          RADIO
+============== ================================================= ================================================= ================================================= ================================================= ================================================= =================================================
+accept
+accept-charset
+accesskey                                                        :ref:`X <reference-objects-attributes-accesskey>`                                                                                                     :ref:`X <reference-objects-attributes-accesskey>` :ref:`X <reference-objects-attributes-accesskey>`
+action
+alt                                                              :ref:`X <reference-objects-attributes-alt>`                                                                                                           :ref:`X <reference-objects-attributes-alt>`       :ref:`X <reference-objects-attributes-alt>`
+checked                                                                                                                                                                                                                                                                  :ref:`X <reference-objects-attributes-checked>`
+class          :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`
+content
+cols
+data                                                                                                                                                                 :ref:`X <reference-objects-attributes-data>`
+dir                                                              :ref:`X <reference-objects-attributes-dir>`                                                                                                           :ref:`X <reference-objects-attributes-dir>`       :ref:`X <reference-objects-attributes-dir>`
+disabled                                                         :ref:`X <reference-objects-attributes-disabled>`  :ref:`X <reference-objects-attributes-disabled>`  :ref:`X <reference-objects-attributes-disabled>`  :ref:`X <reference-objects-attributes-disabled>`  :ref:`X <reference-objects-attributes-disabled>`
+enctype
+filters        :ref:`X <reference-objects-attributes-filters>`                                                                                                                                                         :ref:`X <reference-objects-attributes-filters>`
+headingSize
+id             :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`
+label                                                            :ref:`X <reference-objects-attributes-label>`     :ref:`X <reference-objects-attributes-label>`     :ref:`X <reference-objects-attributes-label>`     :ref:`X <reference-objects-attributes-label>`     :ref:`X <reference-objects-attributes-label>`
+lang           :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`
+layout         :ref:`X <reference-layout>`                       :ref:`X <reference-layout>`                       :ref:`X <reference-layout>`                       :ref:`X <reference-layout>`                       :ref:`X <reference-layout>`                       :ref:`X <reference-layout>`
+legend
+maxlength                                                                                                                                                                                                              :ref:`X <reference-objects-attributes-maxlength>`
+method
+multiple
+name           :ref:`X <reference-objects-attributes-name>`      :ref:`X <reference-objects-attributes-name>`                                                                                                          :ref:`X <reference-objects-attributes-name>`      :ref:`X <reference-objects-attributes-name>`
+postProcessor
+prefix
+readonly                                                                                                                                                                                                               :ref:`X <reference-objects-attributes-readonly>`
+rows
+rules
+selected                                                                                                                                                             :ref:`X <reference-objects-attributes-selected>`
+size                                                                                                                                                                                                                   :ref:`X <reference-objects-attributes-size>`
+src                                                              :ref:`X <reference-objects-attributes-src>`
+style          :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`
+tabindex                                                         :ref:`X <reference-objects-attributes-tabindex>`                                                                                                      :ref:`X <reference-objects-attributes-tabindex>`  :ref:`X <reference-objects-attributes-tabindex>`
+title                                                            :ref:`X <reference-objects-attributes-title>`     :ref:`X <reference-objects-attributes-title>`     :ref:`X <reference-objects-attributes-title>`     :ref:`X <reference-objects-attributes-title>`     :ref:`X <reference-objects-attributes-title>`
+type           :ref:`X <reference-objects-attributes-type>`      :ref:`X <reference-objects-attributes-type>`                                                                                                          :ref:`X <reference-objects-attributes-type>`      :ref:`X <reference-objects-attributes-type>`
+value          :ref:`X <reference-objects-attributes-value>`     :ref:`X <reference-objects-attributes-value>`                                                       :ref:`X <reference-objects-attributes-value>`     :ref:`X <reference-objects-attributes-value>`     :ref:`X <reference-objects-attributes-value>`
+============== ================================================= ================================================= ================================================= ================================================= ================================================= =================================================
+
+============== ================================================= ================================================= ================================================= ================================================= ================================================= =================================================
+Element        RESET                                             SELECT                                            SUBMIT                                            TEXTAREA                                          TEXTBLOCK                                         TEXTLINE
+============== ================================================= ================================================= ================================================= ================================================= ================================================= =================================================
+accept
+accept-charset
+accesskey      :ref:`X <reference-objects-attributes-accesskey>`                                                   :ref:`X <reference-objects-attributes-accesskey>` :ref:`X <reference-objects-attributes-accesskey>`                                                   :ref:`X <reference-objects-attributes-accesskey>`
+action
+alt            :ref:`X <reference-objects-attributes-alt>`                                                         :ref:`X <reference-objects-attributes-alt>`                                                                                                           :ref:`X <reference-objects-attributes-alt>`
+checked
+class          :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`     :ref:`X <reference-objects-attributes-class>`                                                       :ref:`X <reference-objects-attributes-class>`
+content                                                                                                                                                                                                                :ref:`X <reference-objects-attributes-content>`
+cols                                                                                                                                                                 :ref:`X <reference-objects-attributes-cols>`
+data
+dir            :ref:`X <reference-objects-attributes-dir>`                                                         :ref:`X <reference-objects-attributes-dir>`       :ref:`X <reference-objects-attributes-dir>`                                                         :ref:`X <reference-objects-attributes-dir>`
+disabled       :ref:`X <reference-objects-attributes-disabled>`  :ref:`X <reference-objects-attributes-disabled>`  :ref:`X <reference-objects-attributes-disabled>`  :ref:`X <reference-objects-attributes-disabled>`                                                    :ref:`X <reference-objects-attributes-disabled>`
+enctype
+filters
+headingSize
+id             :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`        :ref:`X <reference-objects-attributes-id>`                                                          :ref:`X <reference-objects-attributes-id>`
+label          :ref:`X <reference-objects-attributes-label>`     :ref:`X <reference-objects-attributes-label>`     :ref:`X <reference-objects-attributes-label>`     :ref:`X <reference-objects-attributes-label>`                                                       :ref:`X <reference-objects-attributes-label>`
+lang           :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`      :ref:`X <reference-objects-attributes-lang>`                                                        :ref:`X <reference-objects-attributes-lang>`
+layout         :ref:`X <reference-layout>`                       :ref:`X <reference-layout>`                       :ref:`X <reference-layout>`
+legend
+maxlength                                                                                                                                                                                                                                                                :ref:`X <reference-objects-attributes-maxlength>`
+method
+multiple                                                         :ref:`X <reference-objects-attributes-multiple>`
+name           :ref:`X <reference-objects-attributes-name>`      :ref:`X <reference-objects-attributes-name>`      :ref:`X <reference-objects-attributes-name>`      :ref:`X <reference-objects-attributes-name>`                                                        :ref:`X <reference-objects-attributes-name>`
+postProcessor
+prefix
+readonly                                                                                                                                                             :ref:`X <reference-objects-attributes-readonly>`                                                    :ref:`X <reference-objects-attributes-readonly>`
+rows                                                                                                                                                                 :ref:`X <reference-objects-attributes-rows>`
+rules
+selected
+size                                                             :ref:`X <reference-objects-attributes-size>`                                                                                                                                                            :ref:`X <reference-objects-attributes-size>`
+src
+style          :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`     :ref:`X <reference-objects-attributes-style>`                                                       :ref:`X <reference-objects-attributes-style>`
+tabindex       :ref:`X <reference-objects-attributes-tabindex>`  :ref:`X <reference-objects-attributes-tabindex>`  :ref:`X <reference-objects-attributes-tabindex>`  :ref:`X <reference-objects-attributes-tabindex>`                                                    :ref:`X <reference-objects-attributes-tabindex>`
+title          :ref:`X <reference-objects-attributes-title>`     :ref:`X <reference-objects-attributes-title>`     :ref:`X <reference-objects-attributes-title>`     :ref:`X <reference-objects-attributes-title>`                                                       :ref:`X <reference-objects-attributes-title>`
+type           :ref:`X <reference-objects-attributes-type>`                                                        :ref:`X <reference-objects-attributes-type>`
+value          :ref:`X <reference-objects-attributes-value>`                                                       :ref:`X <reference-objects-attributes-value>`                                                                                                         :ref:`X <reference-objects-attributes-value>`
+============== ================================================= ================================================= ================================================= ================================================= ================================================= =================================================
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/ObjectAttributes/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/ObjectAttributes/Index.rst
new file mode 100644 (file)
index 0000000..bcff9f0
--- /dev/null
@@ -0,0 +1,976 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-object-attributes:
+
+=================
+Object Attributes
+=================
+
+.. contents::
+    :local:
+    :depth: 1
+
+
+.. _reference-objects-attributes-accept:
+
+accept
+======
+
+:aspect:`Property:`
+    accept
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute specifies a comma-separated list of content types that a
+    server processing this form will handle correctly.
+
+    User agents may use this information to filter out non-conforming files
+    when prompting a user to select files to be sent to the server (cf. the
+    INPUT element when type="file").
+
+    RFC2045: For a complete list, see http://www.iana.org/assignments/media-types/
+
+
+.. _reference-objects-attributes-accept-charset:
+
+accept-charset
+==============
+
+:aspect:`Property:`
+    accept-charset
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute specifies the list of character encodings for input data
+    that is accepted by the server processing this form.
+
+    The value is a space- and/or comma-delimited list of charset values.
+
+    The client must interpret this list as an exclusive-or list. I.e., the
+    server is able to accept any single character encoding per entity
+    received.
+
+    The default value for this attribute is the reserved string "UNKNOWN".
+    User agents may interpret this value as the character encoding that was
+    used to transmit the document containing this FORM element.
+
+    RFC2045: For a complete list, see http://www.iana.org/assignments/character-sets/
+
+
+.. _reference-objects-attributes-accesskey:
+
+accesskey
+=========
+
+:aspect:`Property:`
+    accesskey
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute assigns an access key to an element.
+
+    An access key is a single character from the document character set.
+
+    **Note**: Authors should consider the input method of the expected
+    reader when specifying an accesskey.
+
+    Pressing an access key assigned to an element gives focus to the
+    element.
+
+    The action that occurs when an element receives focus depends on the
+    element. For example, when a user activates a link defined by the
+    element, the user agent generally follows the link. When a user
+    activates a radio button, the user agent changes the value of the radio
+    button. When the user activates a text field, it allows input, etc.
+
+
+.. _reference-objects-attributes-action:
+
+action
+======
+
+:aspect:`Property:`
+    action
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute specifies a form processing agent.
+
+    In normal circumstances the action attribute will be filled
+    automatically, because the form must call the same URI where the form
+    resides.
+
+    Besides specifying a page uid it is also possible to set an anchor. See
+    the examples below.
+
+    .. code-block:: typoscript
+
+      action = #anchor
+      action = 4#anchor
+
+
+.. _reference-objects-attributes-alt:
+
+alt
+===
+
+:aspect:`Property:`
+    alt
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    For user agents that cannot display images, forms, or applets, this
+    attribute specifies alternative text. The language of this text is
+    specified by the lang attribute.
+
+
+.. _reference-objects-attributes-checked:
+
+checked
+=======
+
+:aspect:`Property:`
+    checked
+
+:aspect:`Data type:`
+    boolean/ checked
+
+:aspect:`Description:`
+    When the type attribute has the value "radio" or "checkbox", this
+    boolean attribute specifies that the button is activated.
+
+    User agents must ignore this attribute for other control types.
+
+    **Examples:**
+
+    .. code-block:: typoscript
+
+      checked = 1
+      checked = 0
+      checked = checked
+
+
+.. _reference-objects-attributes-class:
+
+class
+=====
+
+:aspect:`Property:`
+    class
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute assigns a class name or set of class names to an element.
+
+    Any number of elements may be assigned the same class name or names.
+
+    Multiple class names must be separated by white space characters.
+
+
+.. _reference-objects-attributes-cols:
+
+cols
+====
+
+:aspect:`Property:`
+    cols
+
+:aspect:`Data type:`
+    integer
+
+:aspect:`Description:`
+    This attribute specifies the visible width.
+
+    Users should be able to enter longer lines than this, so user agents
+    should provide some means to scroll through the contents of the control
+    when the contents extend beyond the visible area. User agents may wrap
+    visible text lines to keep long lines visible without the need for
+    scrolling.
+
+:aspect:`Default:`
+    40
+
+
+.. _reference-objects-attributes-content:
+
+content
+=======
+
+:aspect:`Property:`
+    content
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute contains the content of a FORM object.
+
+
+.. _reference-objects-attributes-data:
+
+data
+====
+
+:aspect:`Property:`
+    data
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute contains the content of a FORM object.
+
+
+.. _reference-objects-attributes-dir:
+
+dir
+===
+
+:aspect:`Property:`
+    dir
+
+:aspect:`Data type:`
+    ltr/ rtl
+
+:aspect:`Description:`
+    This attribute specifies the base direction of directionally neutral
+    text (i.e., text that does not have inherent directionality as defined
+    in [UNICODE]) in an element's content and attribute values.
+
+    It also specifies the directionality of tables. Possible values:
+
+    - LTR: Left-to-right text or table.
+
+    - RTL: Right-to-left text or table.
+
+    In addition to specifying the language of a document with the lang
+    attribute, authors may need to specify the base directionality
+    (left-to-right or right-to-left) of portions of a document's text, of a
+    table structure, etc. This is done with the dir attribute.
+
+
+.. _reference-objects-attributes-disabled:
+
+disabled
+========
+
+:aspect:`Property:`
+    disabled
+
+:aspect:`Data type:`
+    boolean/ disabled
+
+:aspect:`Description:`
+    When set for a form control, this boolean attribute disables the control
+    for user input.
+
+    When set, the disabled attribute has the following effects on an
+    element:
+
+    - Disabled controls do not receive focus.
+
+    - Disabled controls are skipped in tabbing navigation.
+
+    - Disabled controls cannot be successful.
+
+    This attribute is inherited but local declarations override the
+    inherited value.
+
+    How disabled elements are rendered depends on the user agent. For
+    example, some user agents "gray out" disabled menu items, button labels,
+    etc.
+
+    **Examples:**
+
+    .. code-block:: typoscript
+
+      disabled = 1
+      disabled = 0
+      disabled = disabled
+
+
+.. _reference-objects-attributes-enctype:
+
+enctype
+=======
+
+:aspect:`Property:`
+    enctype
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute specifies the content type used to submit the form to the
+    server (when the value of method is "post"). The default value for this
+    attribute is "application/x-www-form-urlencoded".
+
+    The value "multipart/form-data" should be used in combination with the
+    INPUT element, type="file".
+
+:aspect:`Default:`
+    application/x-www-form-urlencoded
+
+
+.. _reference-objects-attributes-filters:
+
+filters
+=======
+
+:aspect:`Property:`
+    filters
+
+:aspect:`Data type:`
+    [array of numbers]
+
+    ->filters
+
+:aspect:`Description:`
+    Add filters to the FORM object.
+
+    This accepts multiple filters for one FORM object, but you have to add
+    these filters one by one. The submitted data for this particular object
+    will be filtered by the assigned filters in the given order.
+
+    The filtered data will be shown to the visitor when there are errors in
+    the form or on a confirmation page. Otherwise the filtered data will be
+    send by mail to the receiver.
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      filters {
+        1 = alphabetic
+        1 (
+          allowWhiteSpace = 1
+        )
+        2 = titlecase
+      }
+
+    **Submitted data:** john doe3
+
+    **Filtered:** John Doe
+
+    **Note:**: By default, all submitted data will be filtered by a Cross
+    Site Scripting (XSS) filter to prevent security issues.
+
+:aspect:`Default:`
+    .. code-block:: typoscript
+
+      filters {
+        0 = removexss
+      }
+
+
+.. _reference-objects-attributes-headingSize:
+
+headingSize
+===========
+
+:aspect:`Property:`
+    headingSize
+
+:aspect:`Data type:`
+    h1, h2, h3, h4, h5
+
+:aspect:`Description:`
+    This attributes allows to wrap the content of a FORM object with a
+    headline tag.
+
+:aspect:`Default:`
+    h1
+
+
+.. _reference-objects-attributes-id:
+
+id
+==
+
+:aspect:`Property:`
+    id
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute assigns an id to an element.
+
+    This id must be unique in a document.
+
+    If an id has been assigned to the object and a value has been entered
+    for the label, the "for" attribute will inherit the id.
+
+    **Example for FORM object BUTTON:**
+
+    .. code-block:: html
+
+      <label for="click">Push this button</label>
+      <input type="button" id="click" value="Click me" />
+
+
+.. _reference-objects-attributes-label:
+
+label
+=====
+
+:aspect:`Property:`
+    label
+
+:aspect:`Data type:`
+    string/ cObject
+
+:aspect:`Description:`
+    The value of the label of a FORM object.
+
+    By default the value of the label is a TEXT cObject, but you can use
+    other cObjects as well. When no cObject type is used it assumes you want
+    to use TEXT. In this case you can assign the value directly to the label
+    property or indirectly to the value property of the label.
+
+    For more information about cObjects, take a look in the document TSREF.
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      label = TEXT
+      label {
+        value = First name
+      }
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      label = First name
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      label.value = First name
+
+
+.. _reference-objects-attributes-lang:
+
+lang
+====
+
+:aspect:`Property:`
+    lang
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute specifies the base language of an element's attribute
+    values and text content. The default value of this attribute is unknown.
+
+    Briefly, language codes consist of a primary code and a possibly empty
+    series of subcodes:
+
+    - language-code = primary-code ( "-" subcode )\*
+
+    Here are some sample language codes:
+
+    - *en*: English
+
+    - *en-US*: the U.S. version of English
+
+    - *en-cockney*: the Cockney version of English
+
+    - *i-navajo*: the Navajo language spoken by some Native Americans
+
+    - *x-klingon*: The primary tag "x" indicates an experimental language tag
+
+
+.. _reference-objects-attributes-layout:
+
+layout
+======
+
+:aspect:`Property:`
+    layout
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-layout`.
+
+
+.. _reference-objects-attributes-legend:
+
+legend
+======
+
+:aspect:`Property:`
+    legend
+
+:aspect:`Data type:`
+    string/ cObject
+
+:aspect:`Description:`
+    The value of the legend of a FORM object.
+
+    By default the value of the legend is a TEXT cObject, but you can use
+    other cObjects as well. When no cObject type is used it assumes you want
+    to use TEXT. In this case you can assign the value directly to the
+    legend property or indirectly to the value property of the legend.
+
+    For more information about cObjects, take a look in the document TSREF.
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      legend = TEXT
+      legend {
+        value = Personal information
+      }
+
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      legend = Personal information
+
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      legend.value = Personal information
+
+
+.. _reference-objects-attributes-maxlength:
+
+maxlength
+=========
+
+:aspect:`Property:`
+    maxlength
+
+:aspect:`Data type:`
+    integer
+
+:aspect:`Description:`
+    This attribute specifies the maximum number of characters the user may
+    enter. This number may exceed the specified size, in which case the user
+    agent should offer a scrolling mechanism. The default value for this
+    attribute is an unlimited number.
+
+
+.. _reference-objects-attributes-method:
+
+method
+======
+
+:aspect:`Property:`
+    method
+
+:aspect:`Data type:`
+    post/ get
+
+:aspect:`Description:`
+    Specifies which HTTP method will be used to submit form data.
+
+    Only form data submitted with the entered or default method will be
+    processed.
+
+:aspect:`Default:`
+    get
+
+
+.. _reference-objects-attributes-multiple:
+
+multiple
+========
+
+:aspect:`Property:`
+    multiple
+
+:aspect:`Data type:`
+    boolean/ multiple
+
+:aspect:`Description:`
+    If set, this boolean attribute allows multiple selections.
+
+    If not set, the SELECT element only permits single selections.
+
+    **Examples:**
+
+    .. code-block:: typoscript
+
+      multiple = 1
+      multiple = 0
+      multiple = multiple
+
+
+.. _reference-objects-attributes-name:
+
+name
+====
+
+:aspect:`Property:`
+    name
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute names the element so that submitted data can be
+    identified by processing the form server side.
+
+    If no name has been given, it will get assigned an internal counter
+    together with the prefix, like:
+
+    .. code-block:: html
+
+      <input type="button" name="tx_form[21]" value="click" />
+      <input type="checkbox" name="tx_form[22]" value="click" />
+
+
+.. _reference-objects-attributes-postProcessor:
+
+postProcessor
+=============
+
+:aspect:`Property:`
+    postProcessor
+
+:aspect:`Data type:`
+    [array of numbers]
+
+:aspect:`Description:`
+    Add postprocessors to the FORM.
+
+    This accepts multiple postprocessors for one FORM object, but they have
+    to be added one by one.
+
+    **Example** :
+
+    .. code-block:: typoscript
+
+      postProcessor {
+        1 = mail
+        1 {
+          recipientEmail = bar@foo.org
+          senderEmail = foo@bar.com
+        }
+      }
+
+
+.. _reference-objects-attributes-prefix:
+
+prefix
+======
+
+:aspect:`Property:`
+    prefix
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    The prefix of the values in the name attributes of the FORM objects.
+
+    <input name=" **prefix** [first\_name]" value="" />
+
+:aspect:`Default:`
+    tx\_form
+
+
+.. _reference-objects-attributes-readonly:
+
+readonly
+========
+
+:aspect:`Property:`
+    readonly
+
+:aspect:`Data type:`
+    boolean/ readonly
+
+:aspect:`Description:`
+    When set for a form control, this boolean attribute prohibits changes to
+    the control.
+
+    The readonly attribute specifies whether the control may be modified by
+    the user.
+
+    When set, the readonly attribute has the following effects on an
+    element:
+
+    - Read-only elements receive focus but cannot be modified by the user.
+
+    - Read-only elements are included in tabbing navigation.
+
+    - Read-only elements may be successful.
+
+    How read-only elements are rendered depends on the user agent.
+
+    **Examples:**
+
+    .. code-block:: html
+
+      readonly = 1
+      readonly = 0
+      readonly = disabled
+
+    **Note**: The only way to modify dynamically the value of the readonly
+    attribute is through a script.
+
+
+.. _reference-objects-attributes-rows:
+
+rows
+====
+
+:aspect:`Property:`
+    rows
+
+:aspect:`Data type:`
+    integer
+
+:aspect:`Description:`
+    This attribute specifies the number of visible text lines.
+
+    Users should be able to enter more lines than this, so user agents
+    should provide some means to scroll through the contents of the control
+    when the contents extend beyond the visible area.
+
+:aspect:`Default:`
+    5
+
+
+.. _reference-objects-attributes-rules:
+
+rules
+=====
+
+:aspect:`Property:`
+    rules
+
+:aspect:`Data type:`
+    [array of numbers]
+
+:aspect:`Description:`
+    Add validation rules to the FORM.
+
+    This accepts multiple validation rules for one FORM object, but the
+    rules have to be added one by one. It is also possible to add validation
+    rules for different FORM objects.
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      rules {
+        1 = required
+        1 {
+          element = first_name
+        }
+        2 = required
+        2 {
+          element = last_name
+          showMessage = 0
+          error = TEXT
+          error {
+            value = Please enter your last name
+          }
+        }
+      }
+
+    Validation rules are a powerful tool to add validation to the form.
+    Please take a look at the rules section in this manual.
+
+
+.. _reference-objects-attributes-selected:
+
+selected
+========
+
+:aspect:`Property:`
+    selected
+
+:aspect:`Data type:`
+    boolean/ selected
+
+:aspect:`Description:`
+    When set, this boolean attribute specifies that a option is pre-
+    selected.
+
+    **Examples:**
+
+    .. code-block:: typoscript
+
+      selected = 1
+      selected = 0
+      selected = selected
+
+
+.. _reference-objects-attributes-size:
+
+size
+====
+
+:aspect:`Property:`
+    size
+
+:aspect:`Data type:`
+    integer
+
+:aspect:`Description:`
+    This attribute tells the user agent the initial width of the control.
+    The size has to be entered as integer without any measuring unit.
+
+
+.. _reference-objects-attributes-src:
+
+src
+===
+
+:aspect:`Property:`
+    src
+
+:aspect:`Data type:`
+    imgResource
+
+:aspect:`Description:`
+    This attribute specifies the location of the image to be used to
+    decorate the graphical submit button. GIFBUILDER objects are not
+    allowed.
+
+
+.. _reference-objects-attributes-style:
+
+style
+=====
+
+:aspect:`Property:`
+    style
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute specifies CSS style information for the current element.
+
+
+.. _reference-objects-attributes-tabindex:
+
+tabindex
+========
+
+:aspect:`Property:`
+    tabindex
+
+:aspect:`Data type:`
+    integer
+
+:aspect:`Description:`
+    This attribute specifies the position of the current element in the
+    tabbing order for the current document. This value must be a number
+    between 0 and 32767. User agents should ignore leading zeros.
+
+    The tabbing order defines the order in which elements will receive focus
+    when navigated by the user via the keyboard. The tabbing order may
+    include elements nested within other elements.
+
+    Elements that may receive focus should be navigated by user agents
+    according to the following rules:
+
+    #. Those elements that support the tabindex attribute and assign a
+       positive value to it are navigated first. Navigation proceeds from
+       the element with the lowest tabindex value to the element with the
+       highest value. Values neither need to be sequential nor must begin
+       with any particular value. Elements that have identical tabindex
+       values should be navigated in the order they appear in the character
+       stream.
+
+    #. Those elements that do not support the tabindex attribute or support
+       it and assign it a value of "0" are navigated next. These elements
+       are navigated in the order they appear in the character stream.
+
+    #. Elements that are disabled do not participate in the tabbing order.
+
+    The actual key sequence that causes tabbing navigation or element
+    activation depends on the configuration of the user agent (e.g., the
+    "tab" key is used for navigation and the "enter" key is used to activate
+    a selected element),
+
+    User agents may also define key sequences to navigate the tabbing order
+    in reverse. When the end (or beginning) of the tabbing order is reached,
+    user agents may circle back to the beginning (or end).
+
+
+.. _reference-objects-attributes-title:
+
+title
+=====
+
+:aspect:`Property:`
+    title
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute offers advisory information about the element for which
+    it is set. Unlike the TITLE element, which provides information about an
+    entire document and may only appear once, the title attribute may
+    annotate any number of elements. Please consult an element's definition
+    to verify that it supports this attribute.
+
+    Values of the title attribute may be rendered by user agents in a
+    variety of ways. For instance, visual browsers frequently display the
+    title as a "tool tip" (a short message that appears when the pointing
+    device pauses over an object). Audio user agents may speak the title
+    information in a similar context.
+
+
+.. _reference-objects-attributes-type:
+
+type
+====
+
+:aspect:`Property:`
+    type
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Defines the type of form input control to create.
+
+
+.. _reference-objects-attributes-value:
+
+value
+=====
+
+:aspect:`Property:`
+    value
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    This attribute assigns the initial value to the object.
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Optgroup/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Optgroup/Index.rst
new file mode 100644 (file)
index 0000000..5a9e742
--- /dev/null
@@ -0,0 +1,110 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-optgroup:
+
+========
+OPTGROUP
+========
+
+The OPTGROUP element allows authors to group choices logically. This is
+particularly helpful when the user must choose from a long list of options;
+groups of related choices are easier to grasp and remember than a single
+long list of options. All OPTGROUP elements must be specified directly
+within a SELECT element (i.e., groups may not be nested).
+
+An OPTGROUP object can only exist between a SELECT object.
+
+
+.. _reference-optgroup-1-2-3-4:
+
+1, 2, 3, 4 ...
+==============
+
+:aspect:`Property:`
+    1, 2, 3, 4 ...
+
+:aspect:`Data type:`
+    [array of FORM objects]
+
+:aspect:`Description:`
+    OPTION objects, part of the OPTGROUP
+
+
+.. _reference-optgroup-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-optgroup-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-optgroup-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-optgroup-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+:aspect:`Default:`
+    optgroup
+
+
+.. _reference-optgroup-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-optgroup-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-optgroup`
+    specific information.
+
+
+.. _reference-optgroup-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-optgroup-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-title`.
+
+[tsref:(cObject).FORM.FormObject.OPTGROUP]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Option/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Option/Index.rst
new file mode 100644 (file)
index 0000000..6db85ee
--- /dev/null
@@ -0,0 +1,115 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-option:
+
+======
+OPTION
+======
+
+Defines an element inside a select/ drop-down list.
+
+An OPTION object can only exist "between" a SELECT or OPTGROUP object.
+
+
+.. _reference-option-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-option-data:
+
+data
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-data`.
+
+
+.. _reference-option-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-option-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-option-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-option-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-option-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-option`
+    specific information.
+
+
+.. _reference-option-selected:
+
+selected
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-selected`.
+
+
+.. _reference-option-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-option-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-title`.
+
+
+.. _reference-option-value:
+
+value
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-value`.
+
+[tsref:(cObject).FORM.FormObject.OPTION]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Password/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Password/Index.rst
new file mode 100644 (file)
index 0000000..be61de8
--- /dev/null
@@ -0,0 +1,198 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-password:
+
+========
+PASSWORD
+========
+
+Creates a single-line text input control, but the input text is rendered in
+such a way as to hide the characters (e.g., a series of asterisks). This
+control type is often used for sensitive input such as passwords. Note that
+the current value is the text entered by the user, not the text rendered by
+the user agent.
+
+**Note** . Form designers should note that this mechanism affords only light
+security protection. Although the password is masked by user agents from
+casual observers, it is transmitted to the server in clear text, and may be
+read by anyone with low-level access to the network.
+
+
+.. _reference-password-accesskey:
+
+accesskey
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accesskey`.
+
+
+.. _reference-password-alt:
+
+alt
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-alt`.
+
+
+.. _reference-password-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-password-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-password-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-password-filters:
+
+filters
+=======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-filters`.
+
+
+.. _reference-password-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-password-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-password-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+    tag
+
+
+.. _reference-password-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-password`
+    specific information.
+
+
+.. _reference-password-maxlength:
+
+maxlength
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-maxlength`.
+
+
+.. _reference-password-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-password-readonly:
+
+readonly
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-readonly`.
+
+
+.. _reference-password-size:
+
+size
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-size`.
+
+
+.. _reference-password-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-password-tabindex:
+
+tabindex
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-tabindex`.
+
+
+.. _reference-password-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-title`.
+
+
+.. _reference-password-type:
+
+type
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-type`.
+
+:aspect:`Default:`
+    password
+
+
+.. _reference-password-value:
+
+value
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-value`.
+
+[tsref:(cObject).FORM.FormObject.PASSWORD]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Radio/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Radio/Index.rst
new file mode 100644 (file)
index 0000000..ce3df5e
--- /dev/null
@@ -0,0 +1,190 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-radio:
+
+=====
+RADIO
+=====
+
+Creates a radio button.
+
+Radio buttons are on/ off switches that may be toggled by the user. A switch
+is "on" when the control element's checked attribute is set. When a form is
+submitted, only "on" radio button controls can become successful.
+
+Several radio buttons in a form may share the same control name. Thus, for
+example, radio buttons allow users to select several values for the same
+property.
+
+Radio buttons are like checkboxes except that when several share the same
+control name, they are mutually exclusive: when one is switched "on", all
+others with the same name are switched "off".
+
+Radio buttons are normally grouped in a FIELDSET object.
+
+**Note from W3C for user agent behaviour**: If no radio button in a set
+sharing the same control name is initially "on", user agent behavior for
+choosing which control is initially "on" is undefined.
+
+**Note**: Since existing implementations handle this case differently, the
+current specification differs from RFC 1866 ([RFC1866] section 8.1.2.4),
+which states:
+
+At all times, exactly one of the radio buttons in a set is checked. If
+none of the elements of a set of radio buttons specifies \`checked',
+then the user agent must check the first radio button of the set initially.
+
+Since user agent behavior differs, authors should ensure that in each set of
+radio buttons that one is initially "on".
+
+
+.. _reference-radio-accesskey:
+
+accesskey
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accesskey`.
+
+
+.. _reference-radio-alt:
+
+alt
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-alt`.
+
+
+.. _reference-radio-checked:
+
+checked
+=======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-checked`.
+
+
+.. _reference-radio-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-radio-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-radio-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-radio-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-radio-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-radio-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-radio-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-radio`
+    specific information.
+
+
+.. _reference-radio-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-radio-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-radio-tabindex:
+
+tabindex
+========
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-tabindex`.
+
+
+.. _reference-radio-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-title`.
+
+
+.. _reference-radio-type:
+
+type
+====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-type`.
+
+:aspect:`Default:`
+    radio
+
+
+.. _reference-radio-value:
+
+value
+=====
+
+:aspect:`Description:`
+    See general information for :ref:`reference-objects-attributes-value`.
+
+[tsref:(cObject).FORM.FormObject.RADIO]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Reset/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Reset/Index.rst
new file mode 100644 (file)
index 0000000..6854cdd
--- /dev/null
@@ -0,0 +1,154 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-reset:
+
+=====
+RESET
+=====
+
+Creates a reset button.
+
+When activated, a reset button resets all controls to their initial values.
+
+
+.. _reference-reset-accesskey:
+
+accesskey
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accesskey`.
+
+
+.. _reference-reset-alt:
+
+alt
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-alt`.
+
+
+.. _reference-reset-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-reset-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-reset-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-reset-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-reset-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-reset-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-reset-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-reset`
+    specific information.
+
+
+.. _reference-reset-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-reset-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-reset-tabindex:
+
+tabindex
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-tabindex`.
+
+
+.. _reference-reset-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-title`.
+
+
+.. _reference-reset-type:
+
+type
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-type`.
+
+:aspect:`Default:`
+    reset
+
+
+.. _reference-reset-value:
+
+value
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-value`.
+
+[tsref:(cObject).FORM.FormObject.RESET]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Select/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Select/Index.rst
new file mode 100644 (file)
index 0000000..314b211
--- /dev/null
@@ -0,0 +1,165 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-select:
+
+======
+SELECT
+======
+
+The SELECT object creates a menu. Each choice offered by the menu is
+represented by an OPTION object. A SELECT object must contain at least one
+OPTION object
+
+**Pre-selected options**
+
+Zero or more choices may be pre-selected for the user. User agents should
+determine which choices are pre-selected as follows:
+
+- If no OPTION object has the selected attribute set, user agent behavior
+  for choosing which option is initially selected is undefined.
+  **Note**: Since existing implementations handle this case differently, the
+  current specification differs from RFC 1866 ([RFC1866] section 8.1.3),
+  which states: The initial state has the first option selected, unless a
+  SELECTED attribute is present on any of the <OPTION> elements. Since user
+  agent behavior differs, one should ensure that each menu includes a
+  default pre-selected OPTION.
+
+- If one OPTION object has the selected attribute set, it should be pre-
+  selected.
+
+- If the SELECT object has the multiple attribute set and more than one
+  OPTION object has the selected attribute set, they should all be pre-
+  selected.
+
+- It is considered an error if more than one OPTION object has the selected
+  attribute set and the SELECT object does not have the multiple attribute
+  set. User agents may vary in how they handle this error, but should not
+  pre-select more than one choice.
+
+
+.. _reference-select-1-2-3-4:
+
+1, 2, 3, 4 ...
+==============
+
+:aspect:`Property:`
+    1, 2, 3, 4 ...
+
+:aspect:`Data type:`
+    [array of FORM objects]
+
+:aspect:`Description:`
+    OPTION and/ or OPTGROUP objects, part of the SELECT.
+
+
+.. _reference-select-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-select-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-select-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-select-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-select-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-select-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-select`
+    specific information.
+
+
+.. _reference-select-multiple:
+
+multiple
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-multiple`.
+
+
+.. _reference-select-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-select-size:
+
+size
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-size`.
+
+
+.. _reference-select-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-select-tabindex:
+
+tabindex
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-tabindex`.
+
+
+.. _reference-select-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-title`.
+
+[tsref:(cObject).FORM.FormObject.SELECT]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Submit/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Submit/Index.rst
new file mode 100644 (file)
index 0000000..e7dc89d
--- /dev/null
@@ -0,0 +1,152 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-submit:
+
+======
+SUBMIT
+======
+
+Creates a submit button.
+
+When activated, a submit button submits a form. A form may contain more than
+one submit button.
+
+
+.. _reference-submit-accesskey:
+
+accesskey
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accesskey`.
+
+
+.. _reference-submit-alt:
+
+alt
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-alt`.
+
+
+.. _reference-submit-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-submit-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-submit-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-submit-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-submit-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-submit-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-submit-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-submit`
+    specific information.
+
+
+.. _reference-submit-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-submit-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-submit-tabindex:
+
+tabindex
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-tabindex`.
+
+
+.. _reference-submit-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-title`.
+
+
+.. _reference-submit-type:
+
+type
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-type`.
+
+
+.. _reference-submit-value:
+
+value
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-value`.
+
+[tsref:(cObject).FORM.FormObject.SUBMIT]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Textarea/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Textarea/Index.rst
new file mode 100644 (file)
index 0000000..2c731ec
--- /dev/null
@@ -0,0 +1,169 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-textarea:
+
+========
+TEXTAREA
+========
+
+The TEXTAREA object creates a multi-line text input control. User agents
+should use the contents of this object as the initial value of the control
+and should render this text initially.
+
+
+.. _reference-textarea-accesskey:
+
+accesskey
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accesskey`.
+
+
+.. _reference-textarea-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-textarea-cols:
+
+cols
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-cols`.
+
+
+.. _reference-textarea-data:
+
+data
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-data`.
+
+
+.. _reference-textarea-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-textarea-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-textarea-filters:
+
+filters
+=======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-filters`.
+
+
+.. _reference-textarea-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-textarea-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-textarea-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-textarea-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-textarea`
+    specific information.
+
+
+.. _reference-textarea-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-textarea-readonly:
+
+readonly
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-readonly`.
+
+
+.. _reference-textarea-rows:
+
+rows
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-rows`.
+
+
+.. _reference-textarea-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-textarea-tabindex:
+
+tabindex
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-tabindex`.
+
+
+.. _reference-textarea-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-title`.
+
+[tsref:(cObject).FORM.FormObject.TEXTAREA]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Textblock/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Textblock/Index.rst
new file mode 100644 (file)
index 0000000..e3e219c
--- /dev/null
@@ -0,0 +1,22 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-textblock:
+
+=========
+TEXTBLOCK
+=========
+
+Creates a block of text. This element can be used for a visual separation or
+transportation of content. It is neither displayed on the confirmation page
+nor in the email.
+
+
+.. _reference-textblock-content:
+
+content
+=======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-content`.
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Objects/Textline/Index.rst b/typo3/sysext/form/Documentation/Configuration/Objects/Textline/Index.rst
new file mode 100644 (file)
index 0000000..905f9a8
--- /dev/null
@@ -0,0 +1,185 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-textline:
+
+========
+TEXTLINE
+========
+
+Creates a single-line text input control.
+
+
+.. _reference-textline-accesskey:
+
+accesskey
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-accesskey`.
+
+
+.. _reference-textline-alt:
+
+alt
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-alt`.
+
+
+.. _reference-textline-class:
+
+class
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-class`.
+
+
+.. _reference-textline-dir:
+
+dir
+===
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-dir`.
+
+
+.. _reference-textline-disabled:
+
+disabled
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-disabled`.
+
+
+.. _reference-textline-filters:
+
+filters
+=======
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-filters`.
+
+
+.. _reference-textline-id:
+
+id
+==
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-id`.
+
+
+.. _reference-textline-label:
+
+label
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-label`.
+
+
+.. _reference-textline-lang:
+
+lang
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-lang`.
+
+
+.. _reference-textline-layout:
+
+layout
+======
+
+:aspect:`Description:`
+    See general information for :ref:`reference-layout` and the :ref:`reference-layout-textline`
+    specific information.
+
+
+.. _reference-textline-maxlength:
+
+maxlength
+=========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-maxlength`.
+
+
+.. _reference-textline-name:
+
+name
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-name`.
+
+
+.. _reference-textline-readonly:
+
+readonly
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-readonly`.
+
+
+.. _reference-textline-size:
+
+size
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-size`.
+
+
+.. _reference-textline-style:
+
+style
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-style`.
+
+
+.. _reference-textline-tabindex:
+
+tabindex
+========
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-tabindex`
+
+
+.. _reference-textline-title:
+
+title
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-title`.
+
+
+.. _reference-textline-type:
+
+type
+====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-type`.
+
+
+.. _reference-textline-value:
+
+value
+=====
+
+:aspect:`Description:`
+    See general information for  :ref:`reference-objects-attributes-value`.
+
+[tsref:(cObject).FORM.FormObject.TEXTLINE]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Postprocessors/Index.rst b/typo3/sysext/form/Documentation/Configuration/Postprocessors/Index.rst
new file mode 100644 (file)
index 0000000..767e8f2
--- /dev/null
@@ -0,0 +1,46 @@
+.. include:: ../../Includes.txt
+
+
+.. _reference-postprocessors:
+
+==============
+postProcessors
+==============
+
+Add postProcessors to the FORM.
+
+postProcessors define how TYPO3 processes submitted forms after the form is
+rendered according to filters and rules.
+
+Multiple postProcessors are accepted for one FORM object, but you have to
+add these postProcessors one by one.
+
+Currently there are two postProcessors:
+
+.. toctree::
+    :maxdepth: 5
+    :titlesonly:
+    :glob:
+
+    Mail/Index.rst
+    Redirect/Index.rst
+
+**Example:**
+
+.. code-block:: typoscript
+
+  postProcessor {
+    1 = mail
+    1 {
+      recipientEmail = bar@foo.org
+      senderEmail = foo@bar.com
+      subject = Baz
+    }
+    2 = redirect
+    2 {
+      destination = 5
+    }
+  }
+
+The processing will be done in order of the postProcessors.
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Postprocessors/Mail/Index.rst b/typo3/sysext/form/Documentation/Configuration/Postprocessors/Mail/Index.rst
new file mode 100644 (file)
index 0000000..0a7e1b5
--- /dev/null
@@ -0,0 +1,276 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-postprocessors-mail:
+
+====
+mail
+====
+
+The mail postProcessor sends submitted data by mail.
+
+
+.. _reference-postprocessors-mail-ccemail:
+
+ccEmail
+=======
+
+:aspect:`Property:`
+    ccEmail
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Email address the submitted data gets sent to as a carbon copy.
+
+
+.. _reference-postprocessors-mail-messages-error:
+
+messages.error
+==============
+
+:aspect:`Property:`
+    messages.error
+
+:aspect:`Data type:`
+    string/ cObject
+
+:aspect:`Description:`
+    Overriding the default text of the error message, describing the error.
+
+    When no cObject type is set, the message is a simple string. The value
+    can directly be assigned to the messages.error property. If one needs
+    the functionality of cObjects, just define the message appropriately.
+    Any cObject is allowed.
+
+    For more information about cObjects, take a look in the document TSREF.
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      messages.error = TEXT
+      messages.error {
+        data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:messagesError
+      }
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      messages.error = Error while submitting form
+
+:aspect:`Description:`
+    *Local language:*"There was an error when sending the form by mail"
+
+
+.. _reference-postprocessors-mail-messages-success:
+
+messages.success
+================
+
+:aspect:`Property:`
+    messages.success
+
+:aspect:`Data type:`
+    string/ cObject
+
+:aspect:`Description:`
+    Overriding the default text of the confirmation message.
+
+    When no cObject type is set, the message is a simple string. The value
+    can directly be assigned to the messages.success property. If one needs
+    the functionality of cObjects, just define the message appropriately.
+    Any cObject is allowed.
+
+    For more information about cObjects, take a look in the document TSREF.
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      messages.success = TEXT
+      messages.success {
+        data = LLL:EXT:theme/Resources/Private/Language/Form/locallang.xlf:messagesSuccess
+      }
+
+    **Example:**
+
+    .. code-block:: typoscript
+
+      messages.success = Thanks for submitting
+
+:aspect:`Default:`
+    *Local language:*"The form has been sent successfully by mail"
+
+
+.. _reference-postprocessors-mail-organization:
+
+organization
+============
+
+:aspect:`Property:`
+    organization
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Organization mail header.
+
+
+.. _reference-postprocessors-mail-priority:
+
+priority
+========
+
+:aspect:`Property:`
+    priority
+
+:aspect:`Data type:`
+    integer
+
+:aspect:`Description:`
+    Priority of the email. Integer value between 1 and 5. If the priority is
+    configured, but too high, it will be set to 5, which means very low
+    priority.
+
+:aspect:`Default:`
+    3
+
+
+.. _reference-postprocessors-mail-recipientemail:
+
+recipientEmail
+==============
+
+:aspect:`Property:`
+    recipientEmail
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Email address the submitted data gets sent to.
+
+
+.. _reference-postprocessors-mail-senderemail:
+
+senderEmail
+===========
+
+:aspect:`Property:`
+    senderEmail
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Email address which is shown as sender of the email (from header).
+
+:aspect:`Default:`
+    TYPO3\_CONF\_VARS['MAIL']['defaultMailFromAddress']
+
+
+.. _reference-postprocessors-mail-senderemailfield:
+
+senderEmailField
+================
+
+:aspect:`Property:`
+    senderEmailField
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Name of the form field which holds the sender's email address (from
+    header).
+
+    Normally, you can find the (filtered) name in the HTML output between
+    the square brackets like tx\_form[name] where name is the name of the
+    object.
+
+    Only used if senderEmail is not set.
+
+
+.. _reference-postprocessors-mail-sendername:
+
+senderName
+==========
+
+:aspect:`Property:`
+    senderName
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Name which is shown as sender of the email (from header).
+
+:aspect:`Default:`
+    TYPO3\_CONF\_VARS['MAIL']['defaultMailFromName']
+
+
+.. _reference-postprocessors-mail-sendernamefield:
+
+senderNameField
+===============
+
+:aspect:`Property:`
+    senderNameField
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Name of the form field which holds the sender's name (from header).
+
+    Normally you can find the (filtered) name in the HTML output between the
+    square brackets like tx\_form[name] where name is the name of the
+    object.
+
+    Only used if senderName is not set.
+
+
+.. _reference-form-subject:
+
+subject
+=======
+
+:aspect:`Property:`
+    subject
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Subject of the email sent by the form.
+
+:aspect:`Default:`
+    Formmail on 'Your\_HOST'
+
+
+.. _reference-postprocessors-mail-subjectfield:
+
+subjectField
+============
+
+:aspect:`Property:`
+    subjectField
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    Name of the form field which holds the subject.
+
+    Normally you can find the (filtered) name in the HTML output between the
+    square brackets like tx\_form[name] where name is the name of the
+    object.
+
+    Only used if subject is not set.
+
+[tsref:(cObject).FORM->postProcessor.mail]
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Postprocessors/Redirect/Index.rst b/typo3/sysext/form/Documentation/Configuration/Postprocessors/Redirect/Index.rst
new file mode 100644 (file)
index 0000000..6fabe9d
--- /dev/null
@@ -0,0 +1,26 @@
+.. include:: ../../../Includes.txt
+
+
+.. _reference-postprocessors-redirect:
+
+========
+redirect
+========
+
+The redirect postProcessor redirects the user to a defined destination.
+
+.. _reference-postprocessors-redirect-destination:
+
+destination
+===========
+
+:aspect:`Property:`
+    destination
+
+:aspect:`Data type:`
+    string
+
+:aspect:`Description:`
+    One can supply a uid of a page (e.g. 5) or a url (e.g. www.typo3.org).
+    The user will be redirected to this destination.
+
diff --git a/typo3/sysext/form/Documentation/Configuration/Reference/Attributes/Index.rst b/typo3/sysext/form/Documentation/Configuration/Reference/Attributes/Index.rst
deleted file mode 100644 (file)
index 7b26e5c..0000000
+++ /dev/null
@@ -1,201 +0,0 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../../Includes.txt
-
-
-
-
-
-.. _form-attributes:
-
-Attributes
-""""""""""
-
-These attributes can either be assigned to a FORM Object (label,
-legend), to a rule or to a filter (error, message) or to a
-postprocessor (success, error).
-
-
-.. _reference-label:
-
-label
-~~~~~
-
-The value of the label of the object.
-
-By default the value of the label is a TEXT cObj, but you can use
-other cObj as well. When no cObj type is used it assumes you want to
-use TEXT. In this case you can assign the value directly to the label
-property or indirectly to the value property of the label.
-
-For more information about cObjects, take a look in the document TSREF
-
-**Example:**
-
-::
-
-   label = TEXT
-   label {
-           value = First name
-   }
-
-**Example:**
-
-::
-
-   label = First name
-
-**Example:**
-
-::
-
-   label.value = First name
-
-
-.. _reference-legend:
-
-legend
-~~~~~~
-
-The value of the legend of the object.
-
-By default the value of the label is a TEXT cObj, but you can use
-other cObj as well. When no cObj type is used it assumes you want to
-use TEXT. In this case you can assign the value directly to the label
-property or indirectly to the value property of the label.
-
-For more information about cObjects, take a look in the document TSREF
-
-**Example:**
-
-::
-
-   legend = TEXT
-   legend {
-           value = Personal information
-   }
-
-**Example:**
-
-::
-
-   legend = Personal information
-
-**Example:**
-
-::
-
-   legend.value = Personal information
-
-
-.. _reference-success:
-
-success
-~~~~~~~
-
-Overriding the default text of the confirmation message.
-
-By default the value of the message is a TEXT cObj, but you can use
-other cObj as well. When no cObj type is used it assumes you want to
-use TEXT. In this case you can assign the value directly to the
-message property or indirectly to the value property of the message.
-
-For more information about cObjects, take a look in the document TSREF
-
-**Example:**
-
-::
-
-   success = TEXT
-   success {
-           value = Thanks for submitting
-   }
-
-**Example:**
-
-::
-
-   success = Thanks for submitting
-
-**Example:**
-
-::
-
-   success.value = Thanks for submitting
-
-
-.. _reference-error:
-
-error
-~~~~~
-
-Overriding the default text of the error message, describing the
-error.
-
-By default the value of the message is a TEXT cObj, but you can use
-other cObj as well. When no cObj type is used it assumes you want to
-use TEXT. In this case you can assign the value directly to the
-message property or indirectly to the value property of the message.
-
-For more information about cObjects, take a look in the document TSREF
-
-**Example:**
-
-::
-
-   error = TEXT
-   error {
-           value = The value does not appear to be a hostname
-   }
-
-**Example:**
-
-::
-
-   error = The value does not appear to be a hostname
-
-**Example:**
-
-::
-
-   error.value = The value does not appear to be a hostname
-
-
-.. _reference-message:
-
-message
-~~~~~~~
-
-Overriding the default text of the message, describing the rule.
-
-By default the value of the The message is a TEXT cObj, but you can
-use other cObj as well. When no cObj type is used it assumes you want
-to use TEXT. In this case you can assign the value directly to the
-message property or indirectly to the value property of the message.
-
-For more information about cObjects, take a look in the document TSREF
-
-**Example:**
-
-::
-
-   message = TEXT
-   message {
-           value = Use the right pattern
-   }
-
-**Example:**
-
-::
-
-   message = Use the right pattern
-
-**Example:**
-
-::
-
-   message.value = Use the right pattern
-
diff --git a/typo3/sysext/form/Documentation/Configuration/Reference/Functions/Index.rst b/typo3/sysext/form/Documentation/Configuration/Reference/Functions/Index.rst
deleted file mode 100644 (file)
index 17cd145..0000000
+++ /dev/null
@@ -1,4700 +0,0 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../../Includes.txt
-
-
-
-
-.. _form-functions:
-
-Functions
-"""""""""
-
-
-.. _reference-layout:
-
-layout
-~~~~~~
-
-Change the default layout for the FORM objects.
-
-The FORM consists of FORM objects, which each have their own layout.
-The layout of these objects can be changed for the whole form or just
-for a particular object. By default the overall markup is based on
-ordered lists with list elements in it, to have a proper layout
-framework which is accessible too. Some objects are considered being
-container objects, they have child objects. These objects are FORM and
-FIELDSET. To have a proper markup for these objects, we use nested
-ordered lists.
-
-**Example:**
-
-::
-
-   <form>
-           <ol>
-                   <li>
-                           <fieldset>
-                                   <ol>
-                                           <li>
-                                                   <input />
-                                           </li>
-                                   </ol>
-                           </fieldset>
-                   </li>
-                   <li>
-                           <input />
-                   </li>
-           </ol>
-   </form>
-
-Some people will say that SELECT and OPTGROUP are container objects as
-well, and actually they are right: They contain child objects as well.
-But they are not allowed to use this markup.
-
-
-.. _change-layout-for-whole-form:
-
-Change the layout for the whole form
-''''''''''''''''''''''''''''''''''''
-
-We can change the layout of the objects, the container wrap and the
-element wrap.
-
-::
-
-   lib.form = FORM
-   lib.form {
-           layout {
-                   form (
-                           <form>
-                                   <containerWrap />
-                           </form>
-                   )
-                   containerWrap (
-                           <ol>
-                                   <elements />
-                           </ol>
-                   )
-                   elementWrap (
-                           <li>
-                                   <element />
-                           </li>
-                   )
-                   radio (
-                           <label />
-                           <input />
-                   )
-           }
-           ...
-   }
-
-As you can see, we use a (X)HTML kind of markup, actually it's XML,
-with some extra tags. These tags are:
-
-- containerWrap: Marker for container.
-
-- elements: Marker where to put the child elements within a container.
-
-- element: Marker for single element.
-
-- content: Marker which will be filled with cObjects
-
-layout.containerWrap and layout.elementWrap can only be defined for
-the whole form, not individually.
-
-
-.. _reference-layout-containerwrap:
-
-containerWrap
-#############
-
-.. container:: table-row
-
-   Property
-         containerWrap
-
-   Data type
-         string
-
-   Description
-         Inner wrap for container objects.
-
-         The <elements /> tag will be substituted with all the child elements,
-         including their outer wraps.
-
-   Default
-         <ol><elements /></ol>
-
-
-
-.. _reference-layout-elementwrap:
-
-elementWrap
-###########
-
-.. container:: table-row
-
-   Property
-         elementWrap
-
-   Data type
-         string
-
-   Description
-         Outer wrap for regular objects.
-
-         The <element /> tag will be substituted with the child element.
-
-   Default
-         <li><element /></li>
-
-
-
-.. _reference-layout-label:
-
-label
-#####
-
-.. container:: table-row
-
-   Property
-         label
-
-   Data type
-         string
-
-   Description
-         Layout for the labels.
-
-         The <labelvalue /> tag will be substituted with the label text.
-
-         The <mandatory /> tag will be substituted with the validation rule
-         message, styled by it's own layout.
-
-         The <error /> tag will be substituted with the error message from the
-         validation rule when the submitted value is not valid.
-
-   Default
-         <label><labelvalue /><mandatory /><error /></label>
-
-
-
-.. _reference-layout-mandatory:
-
-mandatory
-#########
-
-.. container:: table-row
-
-   Property
-         mandatory
-
-   Data type
-         string
-
-   Description
-         Layout for the validation rule message to describe the rule.
-
-         The <mandatoryvalue /> tag will be substituted with the validation
-         rule message.
-
-   Default
-         <em><mandatoryvalue /></em>
-
-
-
-.. _reference-layout-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string
-
-   Description
-         Layout for the validation rule error message when the submitted data
-         does not validate.
-
-         The <errorvalue /> tag will be substituted with the validation rule
-         error message.
-
-   Default
-         <strong><errorvalue /></strong>
-
-
-
-.. _reference-layout-legend:
-
-legend
-######
-
-.. container:: table-row
-
-   Property
-         legend
-
-   Data type
-         string
-
-   Description
-         Layout for the legend.
-
-   Default
-         <legend><legendvalue /></legend>
-
-
-
-.. _reference-layout-button:
-
-button
-######
-
-.. container:: table-row
-
-   Property
-         button
-
-   Data type
-         string
-
-   Description
-         Layout for the BUTTON object.
-
-   Default
-         <label /><input />
-
-
-
-.. _reference-layout-checkbox:
-
-checkbox
-########
-
-.. container:: table-row
-
-   Property
-         checkbox
-
-   Data type
-         string
-
-   Description
-         Layout for the checkbox object.
-
-   Default
-         <label /><input />
-
-
-
-.. _reference-layout-content:
-
-content
-#######
-
-.. container:: table-row
-
-   Property
-         content
-
-   Data type
-         string
-
-   Description
-         Layout for content.
-
-         The <content /> tag is mainly a marker which will be substituted with
-         the actual content, probably from cObjects.
-
-   Default
-         <content />
-
-
-
-.. _reference-layout-fieldset:
-
-fieldset
-########
-
-.. container:: table-row
-
-   Property
-         fieldset
-
-   Data type
-         string
-
-   Description
-         Layout for the FIELDSET object.
-
-         The <containerwrap /> tag will be substituted by the outer container
-         wrap and includes all child elements.
-
-   Default
-         <fieldset><legend /><containerWrap /></fieldset>
-
-
-
-.. _reference-layout-fileupload:
-
-fileupload
-##########
-
-.. container:: table-row
-
-   Property
-         fileupload
-
-   Data type
-         string
-
-   Description
-         Layout for the FILEUPLOAD object.
-
-   Default
-         <label /><input />
-
-
-
-.. _reference-layout-form:
-
-form
-####
-
-.. container:: table-row
-
-   Property
-         form
-
-   Data type
-         string
-
-   Description
-         Layout for the FORM object.
-
-         The <containerwrap /> tag will be substituted by the outer container
-         wrap and includes all child elements.
-
-   Default
-         <form><containerWrap /></form>
-
-
-
-.. _reference-layout-hidden:
-
-hidden
-######
-
-.. container:: table-row
-
-   Property
-         hidden
-
-   Data type
-         string
-
-   Description
-         Layout for the HIDDEN object.
-
-   Default
-         <input />
-
-
-
-.. _reference-layout-imagebutton:
-
-imagebutton
-###########
-
-.. container:: table-row
-
-   Property
-         imagebutton
-
-   Data type
-         string
-
-   Description
-         Layout for the IMAGEBUTTON object.
-
-   Default
-         <label /><input />
-
-
-
-.. _reference-layout-optgroup:
-
-optgroup
-########
-
-.. container:: table-row
-
-   Property
-         optgroup
-
-   Data type
-         string
-
-   Description
-         Layout for the OPTGROUP object.
-
-         The <elements /> tag will be substituted with all the child elements,
-         which actually can only be OPTION objects.
-
-   Default
-         <optgroup><elements /></optgroup>
-
-
-
-.. _reference-layout-option:
-
-option
-######
-
-.. container:: table-row
-
-   Property
-         option
-
-   Data type
-         string
-
-   Description
-         Layout for the OPTION object.
-
-   Default
-         <option />
-
-
-
-.. _reference-layout-password:
-
-password
-########
-
-.. container:: table-row
-
-   Property
-         password
-
-   Data type
-         string
-
-   Description
-         Layout for the PASSWORD object.
-
-   Default
-         <label /><input />
-
-
-
-.. _reference-layout-radio:
-
-radio
-#####
-
-.. container:: table-row
-
-   Property
-         radio
-
-   Data type
-         string
-
-   Description
-         Layout for the RADIO object.
-
-   Default
-         <label /><input />
-
-
-
-.. _reference-layout-reset:
-
-reset
-#####
-
-.. container:: table-row
-
-   Property
-         reset
-
-   Data type
-         string
-
-   Description
-         Layout for the RESET object.
-
-   Default
-         <label /><input />
-
-
-
-.. _reference-layout-select:
-
-select
-######
-
-.. container:: table-row
-
-   Property
-         select
-
-   Data type
-         string
-
-   Description
-         Layout for the SELECT object.
-
-         The <elements /> tag will be substituted with all the child elements,
-         which only can be OPTGROUP or OPTION objects.
-
-   Default
-         <label /><select><elements /></select>
-
-
-
-.. _reference-layout-submit:
-
-submit
-######
-
-.. container:: table-row
-
-   Property
-         submit
-
-   Data type
-         string
-
-   Description
-         Layout for the SUBMIT object.
-
-   Default
-         <label /><input />
-
-
-
-.. _reference-layout-textarea:
-
-textarea
-########
-
-.. container:: table-row
-
-   Property
-         textarea
-
-   Data type
-         string
-
-   Description
-         Layout for the TEXTAREA object
-
-   Default
-         <label /><textarea />
-
-
-
-.. _reference-layout-textline:
-
-textline
-########
-
-.. container:: table-row
-
-   Property
-         textline
-
-   Data type
-         string
-
-   Description
-         Layout for the TEXTLINE object
-
-   Default
-         <label /><input />
-
-
-[tsref:(cObject).FORM->layout]
-
-
-.. _change-layout-individual-form:
-
-Change the layout for an individual FORM object
-'''''''''''''''''''''''''''''''''''''''''''''''
-
-It's also possible to override the layout setting for a particular
-object within the form, like a checkbox. The layout function within an
-object only accepts the markup, like this:
-
-::
-
-   lib.form = FORM
-   lib.form {
-           10 = CHECKBOX
-           10 {
-                   label = I want to receive the monthly newsletter by email
-                   layout {
-                           <input />
-                           <label />
-                   }
-           }
-           ...
-   }
-
-Here we switch the input field and the label, just for this particular
-checkbox.
-
-
-.. _reference-rules:
-
-rules
-~~~~~
-
-Add validation rules to the FORM.
-
-Validation rules are a powerfull tool to add validation to the form.
-The rules function will always be used at the beginning of the form
-and belongs to the FORM object.
-
-This accepts multiple validation rules for one FORM object, but you
-have to add these rules one by one. Of course it's also possible to
-add validation rules for different FORM objects.
-
-::
-
-   rules {
-       1 = required
-       1 (
-           element = first_name
-       )
-       2 = required
-       2 {
-           element = last_name
-           showMessage = 0
-           error = TEXT
-           error {
-               value = Please enter your last name
-           }
-       }
-   }
-
-When a rule is added, it will automatically add a message to the
-object you've connected the rule with. This message will be shown in
-the local language and will tell the user it's input needs to be
-according to this rule. The message can be hidden or overruled with
-your own text.
-
-The validation will be done by the order of the rules. The validation
-can be stopped when a certain rule is not valid. By default all
-validation rules will be processed.
-
-
-.. _reference-rules-alphabetic:
-
-alphabetic
-''''''''''
-
-Checks if the submitted value only has the characters a-z or A-Z
-
-
-.. _reference-rules-alphabetic-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-alphabetic-allowwhitespace:
-
-allowWhiteSpace
-###############
-
-.. container:: table-row
-
-   Property
-         allowWhiteSpace
-
-   Data type
-         boolean
-
-   Description
-         If allowWhiteSpace = 1, whitespace is allowed in front of, after or
-         between the characters.
-
-   Default
-         0
-
-
-
-.. _reference-rules-alphabetic-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-alphabetic-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-alphabetic-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         For this rule the default message consists of two parts, the second
-         one will only be added when allowWhiteSpace has been set. This is not
-         possible when adding your own message.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value = Use alphabetic characters
-            }
-
-         **Example:**
-
-         ::
-
-            message = Use alphabetic characters
-
-         **Example:**
-
-         ::
-
-            message.value = Use alphabetic characters
-
-   Default
-         local language:Use alphabetic characters(, whitespace allowed)
-
-
-
-.. _reference-rules-alphabetic-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = The value contains not only alphabetic characters
-            }
-
-         **Example:**
-
-         ::
-
-            error = The value contains not only alphabetic characters
-
-         **Example:**
-
-         ::
-
-            error.value = The value contains not only alphabetic characters
-
-   Default
-         local language:The value contains not only alphabetic characters
-
-
-[tsref:(cObject).FORM->rules.alphabetic]
-
-
-.. _reference-rules-alphanumeric:
-
-alphanumeric
-''''''''''''
-
-Checks if the submitted value only has the characters a-z, A-Z or 0-9
-
-
-.. _reference-rules-alphanumeric-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-alphanumeric-allowwhitespace:
-
-allowWhiteSpace
-###############
-
-.. container:: table-row
-
-   Property
-         allowWhiteSpace
-
-   Data type
-         boolean
-
-   Description
-         If allowWhiteSpace = 1, whitespace is allowed in front of, after or
-         between the characters.
-
-   Default
-         0
-
-
-
-.. _reference-rules-alphanumeric-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-alphanumeric-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-alphanumeric-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         For this rule the default message consists of two parts, the second
-         one will only be added when allowWhiteSpace has been set. This is not
-         possible when adding your own message.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value = Use alphanumeric characters
-            }
-
-         **Example:**
-
-         ::
-
-            message = Use alphanumeric characters
-
-         **Example:**
-
-         ::
-
-            message.value = Use alphabetic characters
-
-   Default
-         local language:Use alphanumeric characters(, whitespace allowed)
-
-
-
-.. _reference-rules-alphanumeric-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = The value contains not only alphanumeric characters
-            }
-
-         **Example:**
-
-         ::
-
-            error = The value contains not only alphanumeric characters
-
-         **Example:**
-
-         ::
-
-            error.value = The value contains not only alphanumeric characters
-
-   Default
-         local language:The value contains not only alphanumeric characters
-
-
-[tsref:(cObject).FORM->rules.alphanumeric]
-
-
-.. _reference-rules-between:
-
-between
-'''''''
-
-Checks if the submitted value is between the given minimum and maximum
-value. By default minimum and maximum are excluded, but can be
-included in the validation.
-
-
-.. _reference-rules-between-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-between-minimum:
-
-minimum
-#######
-
-.. container:: table-row
-
-   Property
-         minimum
-
-   Data type
-         integer
-
-   Description
-         The minimum value of the comparison
-
-
-
-.. _reference-rules-between-maximum:
-
-maximum
-#######
-
-.. container:: table-row
-
-   Property
-         maximum
-
-   Data type
-         integer
-
-   Description
-         The maximum value of the comparison
-
-
-
-.. _reference-rules-between-inclusive:
-
-inclusive
-#########
-
-.. container:: table-row
-
-   Property
-         inclusive
-
-   Data type
-         boolean
-
-   Description
-         If inclusive = 1, the minimum and maximum value are included in the
-         comparison.
-
-
-
-.. _reference-rules-between-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-between-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-between-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         For this rule the default message consists of two parts, the second
-         one will only be added when inclusive has been set. This is not
-         possible when adding your own message. The markers %minimum and
-         %maximum will be replaced with the values set by TypoScript.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value =  The value must be between %minimum and %maximum
-            }
-
-         **Example:**
-
-         ::
-
-            message =  The value must be between %minimum and %maximum
-
-         **Example:**
-
-         ::
-
-            message.value =  The value must be between %minimum and %maximum
-
-   Default
-         local language: The value must be between %minimum and %maximum(,
-         inclusively)
-
-
-
-.. _reference-rules-between-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         For this rule, the error message consists of two parts. The second one
-         will be added when inclusive has been set. This is not possible when
-         overriding the error message with your own message. The markers
-         %minimum and %maximum will be replaced with the values set by
-         TypoScript.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = The value is not between %minimum and %maximum
-            }
-
-         **Example:**
-
-         ::
-
-            error = The value is not between %minimum and %maximum
-
-         **Example:**
-
-         ::
-
-            error.value = The value is not between %minimum and %maximum
-
-   Default
-         local language: The value is not between %minimum and %maximum(,
-         inclusively)
-
-
-[tsref:(cObject).FORM->rules.between]
-
-
-.. _reference-rules-date:
-
-date
-''''
-
-Checks if the submitted value is a valid date, and the format is equal
-to the one set in TypoScript.
-
-The format configuration is like the PHP strftime() conversion
-specifiers. The message shown to the visitor supports the format as
-well, but will be shown to the visitor in a human readable way.
-%e-%m-%Y becomes d-mm-yyyy in English.
-
-
-.. _reference-rules-date-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-date-format:
-
-format
-######
-
-.. container:: table-row
-
-   Property
-         format
-
-   Data type
-         strftime-conf
-
-   Description
-         The format of the submitted data.
-
-         See the PHP-manual (strftime) for the codes, or datatype "strftime-
-         conf" in the TYPO3 document TSref.
-
-   Default
-         %e-%m-%Y
-
-
-
-.. _reference-rules-date-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-date-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-date-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         The %format marker will be replaced with a human readable format.
-         %e-%m-%Y becomes d-mm-yyyy in English.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value = (%format)
-            }
-
-         **Example:**
-
-         ::
-
-            message = (%format)
-
-         **Example:**
-
-         ::
-
-            message.value = (%format)
-
-   Default
-         local language: (%format)
-
-
-
-.. _reference-rules-date-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = The value does not appear to be a valid date
-            }
-
-         **Example:**
-
-         ::
-
-            error = The value does not appear to be a valid date
-
-         **Example:**
-
-         ::
-
-            error.value = The value does not appear to be a valid date
-
-   Default
-         local language: The value does not appear to be a valid date
-
-
-[tsref:(cObject).FORM->rules.date]
-
-
-.. _reference-rules-digit:
-
-digit
-'''''
-
-Checks if the submitted value only has the characters 0-9.
-
-
-.. _reference-rules-digit-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-digit-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-digit-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-digit-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value = Use digit characters
-            }
-
-         **Example:**
-
-         ::
-
-            message = Use digit characters
-
-         **Example:**
-
-         ::
-
-            message.value = Use digit characters
-
-   Default
-         local language: Use digit characters
-
-
-
-.. _reference-rules-digit-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = The value contains not only digit characters
-            }
-
-         **Example:**
-
-         ::
-
-            error = The value contains not only digit characters
-
-         **Example:**
-
-         ::
-
-            error.value = The value contains not only digit characters
-
-   Default
-         local language: The value contains not only digit characters
-
-
-[tsref:(cObject).FORM->rules.digit]
-
-
-.. _reference-rules-email:
-
-email
-'''''
-
-Checks if the submitted value is a valid email address.
-
-Validates an RFC 2822 email address, except does not allow most
-punctuation and non-ascii alphanumeric characters. Also does not take
-length requirements into account. Allows domain name and IP addresses,
-and ensures that the IP address entered is valid.
-
-
-.. _reference-rules-email-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-email-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-email-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-email-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value = (john.doe@domain.com)
-            }
-
-         **Example:**
-
-         ::
-
-            message = (john.doe@domain.com)
-
-         **Example:**
-
-         ::
-
-            message.value = (john.doe@domain.com)
-
-   Default
-         local language: (john.doe@domain.com)
-
-
-
-.. _reference-rules-email-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = This is not a valid email address
-            }
-
-         **Example:**
-
-         ::
-
-            error = This is not a valid email address
-
-         **Example:**
-
-         ::
-
-            error.value = This is not a valid email address
-
-   Default
-         local language: This is not a valid email address
-
-
-
-[tsref:(cObject).FORM->rules.email]
-
-
-.. _reference-rules-equals:
-
-equals
-''''''
-
-Compares the submitted data of two FORM objects. If they are not
-equal, the rule does not validate.
-
-The rule and error messages will be put in the label of the object the
-rule is attached with by the property "element".
-
-
-.. _reference-rules-equals-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-         The rule and error message will be added to the label of this object
-
-
-
-.. _reference-rules-equals-field:
-
-field
-#####
-
-.. container:: table-row
-
-   Property
-         field
-
-   Data type
-         string
-
-   Description
-         The name of the object to compare with.
-
-         Like "element" above.
-
-
-
-.. _reference-rules-equals-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-equals-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-equals-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         The %field marker will be replaces with the property "field".
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value = This field must be equal to '%field'
-            }
-
-         **Example:**
-
-         ::
-
-            message = This field must be equal to '%field'
-
-         **Example:**
-
-         ::
-
-            message.value = This field must be equal to '%field'
-
-   Default
-         local language: This field must be equal to '%field'
-
-
-
-.. _reference-rules-equals-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         The %field marker will be replaces with the property "field".
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = The value does not equal the value in field '%field'
-            }
-
-         **Example:**
-
-         ::
-
-            error = The value does not equal the value in field '%field'
-
-         **Example:**
-
-         ::
-
-            error.value = The value does not equal the value in field '%field'
-
-   Default
-         local language: The value does not equal the value in field '%field'
-
-
-[tsref:(cObject).FORM->rules.equals]
-
-
-.. _reference-rules-float:
-
-float
-'''''
-
-Checks if the submitted value is a floating point number, AKA floats,
-doubles or real numbers.
-
-Float depends on your config.locale\_all setting. For German
-(config.locale\_all = de\_DE) you get the following values (partly)
-with the PHP function localeconv():
-
-'decimal\_point' => string '.' Decimal point character'thousands\_sep'
-=> string '' Thousands separator'mon\_decimal\_point' => string ','
-Monetary decimal point character'mon\_thousands\_sep' => string '.'
-Monetary thousands separator
-
-First both thousands separators are deleted from the float, then the
-decimal points are replaced by a dot to get a proper float which PHP
-can always handle.
-
-
-.. _reference-rules-float-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-float-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-float-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-float-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value = Enter a float
-            }
-
-         **Example:**
-
-         ::
-
-            message = Enter a float
-
-         **Example:**
-
-         ::
-
-            message.value = Enter a float
-
-   Default
-         local language: Enter a float
-
-
-
-.. _reference-rules-float-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = The value does not appear to be a float
-            }
-
-         **Example:**
-
-         ::
-
-            error = The value does not appear to be a float
-
-         **Example:**
-
-         ::
-
-            error.value = The value does not appear to be a float
-
-   Default
-         local language: The value does not appear to be a float
-
-
-[tsref:(cObject).FORM->rules.float]
-
-
-.. _reference-rules-greaterthan:
-
-greaterthan
-'''''''''''
-
-Checks if the submitted value is greater than the integer set with
-TypoScript.
-
-
-.. _reference-rules-greaterthan-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-greaterthan-minimum:
-
-minimum
-#######
-
-.. container:: table-row
-
-   Property
-         minimum
-
-   Data type
-         integer
-
-   Description
-         The submitted value must be greater than the minimum value
-
-
-
-.. _reference-rules-greaterthan-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-greaterthan-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-greaterthan-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         The marker %minimum will be replaced with the value set by TypoScript.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value = The value must be greater than %minimum
-            }
-
-         **Example:**
-
-         ::
-
-            message = The value must be greater than %minimum
-
-         **Example:**
-
-         ::
-
-            message.value = The value must be greater than %minimum
-
-   Default
-         local language: The value must be greater than %minimum
-
-
-
-.. _reference-rules-greaterthan-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         The marker %minimum will be replaced with the value set by TypoScript.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = The value does not appear to be greater than %minimum
-            }
-
-         **Example:**
-
-         ::
-
-            error = The value does not appear to be greater than %minimum
-
-         **Example:**
-
-         ::
-
-            error.value = The value does not appear to be greater than %minimum
-
-   Default
-         local language: The value does not appear to be greater than %minimum
-
-
-[tsref:(cObject).FORM->rules.greaterthan]
-
-
-.. _reference-rules-inarray:
-
-inarray
-'''''''
-
-Compares the submitted value with the values in the array set in
-TypoScript.
-
-
-.. _reference-rules-inarray-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-inarray-array:
-
-array
-#####
-
-.. container:: table-row
-
-   Property
-         array
-
-   Data type
-         [array of numbers]
-
-   Description
-         The array containing the values which will be compared with the
-         incoming data
-
-         **Example:**
-
-         ::
-
-            array {
-                1 = TYPO3
-                2 = FLOW3
-                3 = CMS
-                4 = OPEN SOURCE
-            }
-
-
-
-.. _reference-rules-inarray-strict:
-
-strict
-######
-
-.. container:: table-row
-
-   Property
-         strict
-
-   Data type
-         boolean
-
-   Description
-         The types of the needle in the haystack are also checked if strict = 1
-
-   Default
-         0
-
-
-
-.. _reference-rules-inarray-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-inarray-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-inarray-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         By default the value of the The message is a TEXT cObj, but you can
-         use other cObj as well. When no cObj type is used it assumes you want
-         to use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value = Only a few values are possible
-            }
-
-         **Example:**
-
-         ::
-
-            message = Only a few values are possible
-
-         **Example:**
-
-         ::
-
-            message.value = Only a few values are possible
-
-   Default
-         local language: Only a few values are possible
-
-
-
-.. _reference-rules-inarray-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = The value does not appear to be valid
-            }
-
-         **Example:**
-
-         ::
-
-            error = The value does not appear to be valid
-
-         **Example:**
-
-         ::
-
-            error.value = The value does not appear to be valid
-
-   Default
-         local language: The value does not appear to be valid
-
-
-[tsref:(cObject).FORM->rules.inarray]
-
-
-.. _reference-rules-integer:
-
-integer
-'''''''
-
-Checks if the submitted value is an integer.
-
-
-.. _reference-rules-integer-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-integer-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-integer-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-integer-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         By default the value of the The message is a TEXT cObj, but you can
-         use other cObj as well. When no cObj type is used it assumes you want
-         to use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value = Use an integer
-            }
-
-         **Example:**
-
-         ::
-
-            message = Use an integer
-
-         **Example:**
-
-         ::
-
-            message.value = Use an integer
-
-   Default
-         local language: Use an integer
-
-
-
-.. _reference-rules-integer-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = The value does not appear to be an integer
-            }
-
-         **Example:**
-
-         ::
-
-            error = The value does not appear to be an integer
-
-         **Example:**
-
-         ::
-
-            error.value = The value does not appear to be an integer
-
-   Default
-         local language: The value does not appear to be an integer
-
-
-[tsref:(cObject).FORM->rules.integer]
-
-
-.. _reference-rules-ip:
-
-ip
-''
-
-Checks if the submitted value is an IP address.
-
-
-.. _reference-rules-ip-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-ip-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row
-
-   Property
-         breakOnError
-
-   Data type
-         boolean
-
-   Description
-         If breakOnError = 1 and the rule does not validate, all remaining
-         rules will not be processed.
-
-
-
-.. _reference-rules-ip-showmessage:
-
-showMessage
-###########
-
-.. container:: table-row
-
-   Property
-         showMessage
-
-   Data type
-         boolean
-
-   Description
-         If showMessage = 0, a message describing the rule will not be added to
-         the label of the object.
-
-   Default
-         1
-
-
-
-.. _reference-rules-ip-message:
-
-message
-#######
-
-.. container:: table-row
-
-   Property
-         message
-
-   Data type
-         string / cObject
-
-         ->message
-
-   Description
-         Overriding the default text of the message, describing the rule.
-
-         By default the value of the The message is a TEXT cObj, but you can
-         use other cObj as well. When no cObj type is used it assumes you want
-         to use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            message = TEXT
-            message {
-                value = (123.123.123.123)
-            }
-
-         **Example:**
-
-         ::
-
-            message = (123.123.123.123)
-
-         **Example:**
-
-         ::
-
-            message.value = (123.123.123.123)
-
-   Default
-         local language: (123.123.123.123)
-
-
-
-.. _reference-rules-ip-error:
-
-error
-#####
-
-.. container:: table-row
-
-   Property
-         error
-
-   Data type
-         string / cObject
-
-         ->error
-
-   Description
-         Overriding the default text of the error message, describing the
-         error.
-
-         By default the value of the message is a TEXT cObj, but you can use
-         other cObj as well. When no cObj type is used it assumes you want to
-         use TEXT. In this case you can assign the value directly to the
-         message property or indirectly to the value property of the message.
-
-         For more information about cObjects, take a look in the document TSREF
-
-         **Example:**
-
-         ::
-
-            error = TEXT
-            error {
-                value = The value does not appear to be a valid IP address
-            }
-
-         **Example:**
-
-         ::
-
-            error = The value does not appear to be a valid IP address
-
-         **Example:**
-
-         ::
-
-            error.value = The value does not appear to be a valid IP address
-
-   Default
-         local language: The value does not appear to be a valid IP address
-
-
-[tsref:(cObject).FORM->rules.ip]
-
-
-.. _reference-rules-length:
-
-length
-''''''
-
-Checks if the submitted value is of a certain length. A minimum length
-can be used or a minimum and a maximum length.
-
-
-.. _reference-rules-length-element:
-
-element
-#######
-
-.. container:: table-row
-
-   Property
-         element
-
-   Data type
-         string
-
-   Description
-         Name of the object. Normally you can find the (filtered) name in the
-         HTML output between the square brackets like tx\_form[name] where name
-         is the name of the object.
-
-
-
-.. _reference-rules-length-minimum:
-
-minimum
-#######
-
-.. container:: table-row
-
-   Property
-         minimum
-
-   Data type
-         integer
-
-   Description
-         The minimum length of the submitted value
-
-
-
-.. _reference-rules-length-maximum:
-
-maximum
-#######
-
-.. container:: table-row
-
-   Property
-         maximum
-
-   Data type
-         integer
-
-   Description
-         The maximum length of the submitted value. Maximum can only be used in
-         combination with minimum.
-
-
-
-.. _reference-rules-length-breakonerror:
-
-breakOnError
-############
-
-.. container:: table-row