[TASK] EXT:form - Update documentation 99/48699/4
authorBjörn Jacob <bjoern.jacob@tritum.de>
Tue, 28 Jun 2016 06:26:26 +0000 (08:26 +0200)
committerAnja Leichsenring <aleichsenring@ab-softlab.de>
Thu, 4 Aug 2016 08:20:48 +0000 (10:20 +0200)
Added new screenshots. Removed documentation for obsolete "breakOnError"
configuration. Corrected grammar and typos.

Resolves: #70087
Releases: master, 7.6
Change-Id: Iaa1e58e0583f8293eb2d26c65fbf35f87ae4e017
Reviewed-on: https://review.typo3.org/48699
Tested-by: Bamboo TYPO3com <info@typo3.com>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
36 files changed:
typo3/sysext/form/Documentation/Administration/DefaultNewRecord/Index.rst
typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/ElementsTab/Index.rst
typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/FormTab/Index.rst
typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/OptionsTab/Index.rst
typo3/sysext/form/Documentation/Administration/WizardSettings/DefaultsReference/ShowTabs/Index.rst
typo3/sysext/form/Documentation/Administration/WizardSettings/ElementsReference/Index.rst
typo3/sysext/form/Documentation/Administration/WizardSettings/Index.rst
typo3/sysext/form/Documentation/Configuration/Index.rst
typo3/sysext/form/Documentation/Configuration/Layout/Index.rst
typo3/sysext/form/Documentation/Configuration/Objects/Index.rst
typo3/sysext/form/Documentation/Configuration/Postprocessors/Index.rst
typo3/sysext/form/Documentation/Configuration/Postprocessors/Mail/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Alphabetic/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Alphanumeric/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Between/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Date/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Digit/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Email/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Equals/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Float/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Greaterthan/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Inarray/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Integer/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Ip/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Length/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Lessthan/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Regexp/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Required/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/Uri/Index.rst
typo3/sysext/form/Documentation/Configuration/Rules/ValidationAttributes/Index.rst
typo3/sysext/form/Documentation/Images/FormCreationWizard.png
typo3/sysext/form/Documentation/Images/FormCreationWizardElementsTab.png [new file with mode: 0644]
typo3/sysext/form/Documentation/Images/FormCreationWizardFormTab.png [new file with mode: 0644]
typo3/sysext/form/Documentation/Images/FormCreationWizardOptionsTab.png [new file with mode: 0644]
typo3/sysext/form/Documentation/Images/FormCreationWizardShowTabs.png [new file with mode: 0644]
typo3/sysext/form/Documentation/Introduction/Index.rst

index ac3e1a8..2d3fafa 100644 (file)
@@ -7,13 +7,13 @@
 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.
+When an editor creates a new FORM record, the bodytext will be filled by
+default with some simple form settings which are displayed below. The
+integrator can change this setting to specific needs, but 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.
@@ -26,7 +26,7 @@ the functionality is not supported by the list module.
         mailform {
           tt_content_defValues {
             bodytext (
-  enctype = application/x-www-form-urlencoded
+  enctype = multipart/form-data
   method = post
   prefix = tx_form
             )
index a71b3ba..ad2f016 100644 (file)
@@ -3,16 +3,19 @@
 
 .. _wizard-settings-defaults-elements-tab:
 
-============
-Elements tab
-============
+==============
+Tab "Elements"
+==============
 
 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.
+to the form at that point. An editor can also double click a button. When
+doing so, the element will be added at the end of the form.
+
+.. figure:: ../../../../Images/FormCreationWizardElementsTab.png
+    :alt: The form wizard with the tab "Elements".
 
 .. contents::
     :local:
@@ -35,8 +38,8 @@ showAccordions
 :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.
+    property which defines which form elements will be shown in a given
+    accordion.
 
 :aspect:`Default:`
     basic, predefined, content
@@ -56,35 +59,34 @@ showButtons
     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.
+    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**
 
+    - textline (Text Field)
+    - textarea (Textarea)
     - checkbox (Checkbox)
-    - fieldset (Fieldset)
+    - radio (Radio Button)
+    - select (Drop Down)
     - fileupload (Upload Field)
     - hidden (Hidden Field)
     - password (Password Field)
-    - radio (Radio Button)
-    - reset (Reset Button)
-    - select (Drop Down)
+    - fieldset (Fieldset)
     - submit (Submit Button)
-    - textarea (Textarea)
-    - textline (Text Field)
-
-    Additionally, there is the element "button" available which is not visible by default.
+    - reset (Reset Button)
+    - button (Button)
 
     |
 
     **"predefined" elements**
 
+    - name (Full Name)
     - email (Email)
-    - radiogroup (Radio Button Group)
     - checkboxgroup (Checkbox Group)
-    - name (Full Name)
+    - radiogroup (Radio Button Group)
 
     |
 
@@ -106,15 +108,16 @@ The default configuration of the elements tab is as follows.
   mod.wizards {
     form {
       defaults {
+        showTabs = elements, options, form
         tabs {
           elements {
             showAccordions = basic, predefined, content
             accordions {
               basic {
-                showButtons = checkbox, fieldset, fileupload, hidden, password, radio, reset, select, submit, textarea, textline
+                showButtons = textline, textarea, checkbox, radio, select, fileupload, hidden, password, fieldset, submit, reset, button
               }
               predefined {
-                showButtons = email, radiogroup, checkboxgroup, name
+                showButtons = name, email, checkboxgroup, radiogroup
               }
               content {
                 showButtons = header, textblock
index 73d0435..d6f2066 100644 (file)
@@ -3,12 +3,15 @@
 
 .. _wizard-settings-defaults-form-tab:
 
-========
-Form tab
-========
+==========
+Tab "Form"
+==========
 
-The form tab shows the configuration of the outer form, like the
-attributes of the form or the prefix.
+The form tab shows the configuration of the outer form, like the attributes
+of the form or the prefix as well as the post-processor configuration.
+
+.. figure:: ../../../../Images/FormCreationWizardFormTab.png
+    :alt: The form wizard with the tab "Form".
 
 .. contents::
     :local:
@@ -40,8 +43,8 @@ showAccordions
 
     * behaviour
     * prefix
-    * attributes :ref:`> to section <wizard-settings-defaults-form-attributes>`
-    * postProcessor :ref:`> to section <wizard-settings-defaults-form-postprocessor>`
+    * :ref:`attributes <wizard-settings-defaults-form-attributes>`
+    * :ref:`postProcessor <wizard-settings-defaults-form-postprocessor>`
 
 
 .. _wizard-settings-defaults-form-attributes:
@@ -52,15 +55,15 @@ 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
 --------------
 
+.. attention::
+
+    The configuration of the attributes accordion is not working as
+    expected and has to be fixed in a coming version of TYPO3. There is
+    a workaround which is shown below.
+
 (:ts:`mod.wizards.form.defaults.tabs.form.accordions.attributes.showProperties`)
 
 :aspect:`Property:`
@@ -74,8 +77,11 @@ showProperties
     in the accordion.
 
 :aspect:`Default:`
-    accept, accept-charset, action, class, dir, enctype, id, lang, method,
-    name, style, title
+    accept, action, dir, enctype, lang, method, novalidate, class, id, style, title
+
+Since the above shown configuration is not working, the following workaround can
+be applied. To configure the attribute accordion of the form element, address the
+object directly via :ts:`mod.wizards.form.elements.form.accordions.attributes.showProperties`.
 
 
 .. _wizard-settings-defaults-form-postprocessor:
@@ -154,45 +160,24 @@ 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
+      defaults {
+        tabs {
+          form {
+            showAccordions = behaviour, prefix, attributes, postProcessor
+            accordions {
+              postProcessor {
+                showPostProcessors = mail, redirect
+                postProcessors {
+                  mail {
+                    showProperties = recipientEmail, senderEmail, subject
+                  }
+                  redirect {
+                    showProperties = destination
+                  }
+                }
+              }
             }
           }
         }
index 4bc01d2..8b0b89f 100644 (file)
@@ -3,16 +3,19 @@
 
 .. _wizard-settings-defaults-options-tab:
 
-===========
-Options tab
-===========
+=============
+Tab "Options"
+=============
 
 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 editor has to select an element in the form.
 
-The content of this tab depends on the type of element you've chosen in
-the form.
+The content of this tab depends on the type of element the editor has chosen
+in the form.
+
+.. figure:: ../../../../Images/FormCreationWizardOptionsTab.png
+    :alt: The form wizard with the tab "Options".
 
 .. contents::
     :local:
@@ -44,11 +47,11 @@ showAccordions
     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>`
+    - *label*: :ref:`Label Properties <wizard-settings-defaults-options-label>`
+    - *attributes*: :ref:`Attributes Properties <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>`
+    - *validation*: :ref:`Validation <wizard-settings-defaults-validation-label>`
+    - *filters*: :ref:`Filters <wizard-settings-defaults-filters-label>`
     - *various*: Various Properties
 
 :aspect:`Example:`
@@ -63,6 +66,7 @@ showAccordions
               }
             }
           }
+
         }
       }
 
@@ -88,13 +92,13 @@ showProperties
     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.
+    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
+    label
 
 
 .. _wizard-settings-defaults-options-attributes:
@@ -118,17 +122,20 @@ showProperties
     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.
+    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
+    accept, accept-charset, accesskey, action, alt, autocomplete, autofocus,
+    checked, class, cols, contenteditable, contextmenu, dir, draggable,
+    dropzone, disabled, enctype, hidden, height, id, inputmode, label, lang,
+    list, max, maxlength, method, min, minlength, multiple, name,
+    novalidate, pattern, placeholder, readonly, required, rows, selected,
+    selectionDirection, selectionEnd, selectionStart, size, spellcheck, src,
+    step, style, tabindex, text, title, translate, type, value, width, wrap
 
 
 .. _wizard-settings-defaults-validation-label:
@@ -157,8 +164,8 @@ showRules
 
 :aspect:`Default:`
     alphabetic, alphanumeric, between, date, digit, email, equals,
-    float, greaterthan, inarray, integer, ip, length, lessthan,
-    regexp, required, uri
+    fileallowedtypes, filemaximumsize, fileminimumsize, float, greaterthan,
+    inarray, integer, ip, length, lessthan, regexp, required, uri
 
 
 .. _wizard-settings-defaults-options-validation-rules:
@@ -182,30 +189,30 @@ rules.[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
-    =================== ======================================================================
+    =================== ========================================================
+    alphabetic          message, error, showMessage, allowWhiteSpace
+    alphanumeric        message, error, showMessage, allowWhiteSpace
+    between             message, error, showMessage, minimum, maximum, inclusive
+    date                message, error, showMessage, format
+    digit               message, error, showMessage
+    email               message, error, showMessage
+    equals              message, error, showMessage, field
+    fileallowedtypes    message, error, showMessage, types
+    filemaximumsize     message, error, showMessage, maximum
+    fileminimumsize     message, error, showMessage, minimum
+    float               message, error, showMessage
+    greaterthan         message, error, showMessage, minimum
+    inarray             message, error, showMessage, array, strict
+    integer             message, error, showMessage
+    ip                  message, error, showMessage
+    length              message, error, showMessage, minimum, maximum
+    lessthan            message, error, showMessage, maximum
+    regexp              message, error, showMessage, expression
+    required            message, error, showMessage
+    uri                 message, error, showMessage
+    =================== ========================================================
 
 
 .. _wizard-settings-defaults-filters-label:
@@ -235,8 +242,8 @@ showFilters
     For each filter a list of properties to be shown can be defined.
 
 :aspect:`Default:`
-    alphabetic, alphanumeric, currency, digit, integer, lowercase,
-    regexp, titlecase, trim, uppercase
+    alphabetic, alphanumeric, currency, digit, integer, lowercase, regexp,
+    stripnewlines, titlecase, trim, uppercase
 
 
 .. _wizard-settings-defaults-options-filtering-filters:
@@ -286,79 +293,79 @@ The default configuration of the options tab looks like this:
   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
          }
+         attributes {
+            showProperties = accept, accept-charset, accesskey, action, alt, autocomplete, autofocus, checked, class, cols, contenteditable, contextmenu, dir, draggable, dropzone, disabled, enctype, hidden, height, id, inputmode, label, lang, list, max, maxlength, method, min, minlength, multiple, name, novalidate, pattern, placeholder, readonly, required, rows, selected, selectionDirection, selectionEnd, selectionStart, size, spellcheck, src, step, style, tabindex, text, title, translate, type, value, width, wrap
+         }
          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
+                  showProperties = message, error, showMessage, allowWhiteSpace
                }
                alphanumeric {
-                  showProperties = message, error, breakOnError, showMessage, allowWhiteSpace
+                  showProperties = message, error, showMessage, allowWhiteSpace
                }
                between {
-                  showProperties = message, error, breakOnError, showMessage, minimum, maximum, inclusive
+                  showProperties = message, error, showMessage, minimum, maximum, inclusive
                }
                date {
-                  showProperties = message, error, breakOnError, showMessage, format
+                  showProperties = message, error, showMessage, format
                }
                digit {
-                  showProperties = message, error, breakOnError, showMessage
+                  showProperties = message, error, showMessage
                }
                email {
-                  showProperties = message, error, breakOnError, showMessage
+                  showProperties = message, error, showMessage
                }
                equals {
-                  showProperties = message, error, breakOnError, showMessage, field
+                  showProperties = message, error, showMessage, field
                }
                fileallowedtypes {
-                  showProperties = message, error, breakOnError, showMessage, types
+                  showProperties = message, error, showMessage, types
                }
                filemaximumsize {
-                  showProperties = message, error, breakOnError, showMessage, maximum
+                  showProperties = message, error, showMessage, maximum
                }
                fileminimumsize {
-                  showProperties = message, error, breakOnError, showMessage, minimum
+                  showProperties = message, error, showMessage, minimum
                }
                float {
-                  showProperties = message, error, breakOnError, showMessage
+                  showProperties = message, error, showMessage
                }
                greaterthan {
-                  showProperties = message, error, breakOnError, showMessage, minimum
+                  showProperties = message, error, showMessage, minimum
                }
                inarray {
-                  showProperties = message, error, breakOnError, showMessage, array, strict
+                  showProperties = message, error, showMessage, array, strict
                }
                integer {
-                  showProperties = message, error, breakOnError, showMessage
+                  showProperties = message, error, showMessage
                }
                ip {
-                  showProperties = message, error, breakOnError, showMessage
+                  showProperties = message, error, showMessage
                }
                length {
-                  showProperties = message, error, breakOnError, showMessage, minimum, maximum
+                  showProperties = message, error, showMessage, minimum, maximum
                }
                lessthan {
-                  showProperties = message, error, breakOnError, showMessage, maximum
+                  showProperties = message, error, showMessage, maximum
                }
                regexp {
-                  showProperties = message, error, breakOnError, showMessage, expression
+                  showProperties = message, error, showMessage, expression
                }
                required {
-                  showProperties = message, error, breakOnError, showMessage
+                  showProperties = message, error, showMessage
                }
                uri {
-                  showProperties = message, error, breakOnError, showMessage
+                  showProperties = message, error, showMessage
                }
             }
          }
          filtering {
-            showFilters = alphabetic, alphanumeric, currency, digit, integer, lowercase, regexp, titlecase, trim, uppercase
+            showFilters = alphabetic, alphanumeric, currency, digit, integer, lowercase, regexp, stripnewlines, titlecase, trim, uppercase
             filters {
                alphabetic {
                   showProperties = allowWhiteSpace
index 6b69cb4..667d2e3 100644 (file)
@@ -9,6 +9,12 @@ showTabs
 
 (:ts:`mod.wizards.form.defaults.showTabs`)
 
+The configuration "showTabs" defines the outermost tabs on the left
+side of the form wizard.
+
+.. figure:: ../../../../Images/FormCreationWizardShowTabs.png
+    :alt: The form wizard with the main tabs.
+
 :aspect:`Property:`
    showTabs
 
@@ -29,6 +35,8 @@ tabs
 
 (:ts:`mod.wizards.form.defaults.tabs`)
 
+Each of the 3 tabs can be further customized.
+
 :aspect:`Property:`
     tabs
 
index 06f2767..ba46630 100644 (file)
@@ -7,12 +7,12 @@
 Elements reference
 ==================
 
-Overrule the default settings of the :ref:`Option <wizard-settings-defaults-options-tab>`
+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
+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.
+If no elements configuration exists, the default settings will be used.
 
 
 .. _overriding-element-settings:
index 721f955..403d263 100644 (file)
@@ -8,10 +8,10 @@ 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.
+"settings" part and the right "form" part. With TSconfig settings it
+is possible to configure the contents of the left "settings" part. The
+integrator 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**.
 
index eca2c41..baeea59 100644 (file)
@@ -11,7 +11,7 @@ Configuration
 
     .. tip::
 
-      Whenever you see a reference to anything named an "object" in this
+      Whenever there is 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.
 
index 31e07be..92e5b74 100644 (file)
@@ -67,5 +67,3 @@ There are 3 ways to modify the layout:
     LayoutViewSpecific/Index
     LayoutObjectSpecific/Index
 
-
-
index 8218184..1ef14fb 100644 (file)
@@ -7,7 +7,7 @@
 FORM objects
 ============
 
-The editor is not bound to the following FORM objects. Whenever FORM will be
+The editor is not bound to FORM objects shown below. 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
index 0e3f947..10ecace 100644 (file)
@@ -30,9 +30,13 @@ The processing will be done in the order of the postProcessors.
 Custom postProcessors
 =====================
 
-It is also possible to configure a custom class as a postProcessor. Just use the class name as the postProcessor name.
+It is also possible to configure a custom class as a postProcessor. Just use
+the class name as the postProcessor name.
 The postProcessor class should implement `TYPO3\CMS\Form\PostProcess\PostProcessorInterface`
 
+The custom postProcessor is not available within the form wizard. Currently,
+there is no possibility to extend the wizard.
+
 **Example:**
 
 .. code-block:: typoscript
@@ -44,11 +48,14 @@ The postProcessor class should implement `TYPO3\CMS\Form\PostProcess\PostProcess
       senderEmail = foo@bar.com
       subject = Baz
     }
+
     2 = redirect
     2 {
       destination = 5
     }
+
     3 = Vendor\ExtensionName\Folder\ClassName
     3 {
     }
-  }
\ No newline at end of file
+  }
+
index 089e3b5..2f05287 100644 (file)
@@ -19,15 +19,6 @@ allowWhiteSpace
     See general information for  :ref:`reference-validation-attributes-allowwhitespace`.
 
 
-.. _reference-rules-alphabetic-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-alphabetic-element:
 
 element
index 28383e8..e3b8151 100644 (file)
@@ -19,15 +19,6 @@ allowWhiteSpace
     See general information for :ref:`reference-validation-attributes-allowwhitespace`.
 
 
-.. _reference-rules-alphanumeric-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-alphanumeric-element:
 
 element
index f7c1380..4a848cf 100644 (file)
@@ -12,15 +12,6 @@ value. By default, minimum and maximum are excluded, but can be included in
 the validation.
 
 
-.. _reference-rules-between-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-between-element:
 
 element
index 514124d..4781cc3 100644 (file)
@@ -16,15 +16,6 @@ shown to the visitor in a human readable way.
 %e-%m-%Y becomes d-mm-yyyy in English.
 
 
-.. _reference-rules-date-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-date-element:
 
 element
index 366125e..3aedee4 100644 (file)
@@ -10,15 +10,6 @@ digit
 Checks if the submitted value only has the characters 0-9.
 
 
-.. _reference-rules-digit-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-digit-element:
 
 element
index f2577be..fdd51d5 100644 (file)
@@ -15,15 +15,6 @@ requirements into account. Allows domain name and IP addresses, and ensures
 that the IP address entered is valid.
 
 
-.. _reference-rules-email-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-email-element:
 
 element
index 8390e3e..ec82581 100644 (file)
@@ -14,15 +14,6 @@ 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-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-equals-element:
 
 element
index 7816fe6..97f02d7 100644 (file)
@@ -24,15 +24,6 @@ points are replaced by a dot to get a proper float which PHP can handle
 properly.
 
 
-.. _reference-rules-float-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-float-element:
 
 element
index 705fcb8..e2d7574 100644 (file)
@@ -10,15 +10,6 @@ greaterthan
 Checks if the submitted value is greater than the integer set in TypoScript.
 
 
-.. _reference-rules-greaterthan-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-greaterthan-element:
 
 element
index 95126c2..8aa5b07 100644 (file)
@@ -36,15 +36,6 @@ array
       }
 
 
-.. _reference-rules-inarray-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-inarray-element:
 
 element
index ce9bd0f..5d94c1e 100644 (file)
@@ -10,15 +10,6 @@ integer
 Checks if the submitted value is an integer.
 
 
-.. _reference-rules-integer-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-integer-element:
 
 element
index 3e3e09c..0d29fac 100644 (file)
@@ -10,15 +10,6 @@ ip
 Checks if the submitted value is an IP address.
 
 
-.. _reference-rules-ip-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-ip-element:
 
 element
index 5b95033..264e4b9 100644 (file)
@@ -11,15 +11,6 @@ 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-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-length-element:
 
 element
index a27a032..4c2a479 100644 (file)
@@ -10,15 +10,6 @@ lessthan
 Checks if the submitted value is less than the integer set in TypoScript.
 
 
-.. _reference-rules-lessthan-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-lessthan-element:
 
 element
index 6a90121..cc0a8cb 100644 (file)
@@ -11,15 +11,6 @@ Checks if the submitted value matches your own regular expression, using PHP
 function preg\_match().
 
 
-.. _reference-rules-regexp-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-regexp-element:
 
 element
index e1109d4..103e393 100644 (file)
@@ -12,15 +12,6 @@ Checks if the submitted value exists and is not empty.
 0 or "0" are allowed and the rule will return true.
 
 
-.. _reference-rules-required-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-required-element:
 
 element
index 04304e4..43d0cc3 100644 (file)
@@ -13,15 +13,6 @@ following:
 - scheme://usern:passw@domain:port/path/file.ext?querystring#fragment
 
 
-.. _reference-rules-uri-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Description:`
-    See general information for :ref:`reference-validation-attributes-breakonerror`.
-
-
 .. _reference-rules-uri-element:
 
 element
index 3d63d6c..93e4347 100644 (file)
@@ -31,25 +31,6 @@ allowWhiteSpace
     0
 
 
-.. _reference-validation-attributes-breakonerror:
-
-breakOnError
-============
-
-:aspect:`Property:`
-    breakOnError
-
-:aspect:`Data type:`
-    boolean
-
-:aspect:`Description:`
-    If breakOnError = 1 and the rule does not validate, all remaining rules
-    will not be processed.
-
-:aspect:`Default:`
-    0
-
-
 .. _reference-validation-attributes-element:
 
 element
index 0c3284f..2256bbc 100644 (file)
Binary files a/typo3/sysext/form/Documentation/Images/FormCreationWizard.png and b/typo3/sysext/form/Documentation/Images/FormCreationWizard.png differ
diff --git a/typo3/sysext/form/Documentation/Images/FormCreationWizardElementsTab.png b/typo3/sysext/form/Documentation/Images/FormCreationWizardElementsTab.png
new file mode 100644 (file)
index 0000000..c3478cb
Binary files /dev/null and b/typo3/sysext/form/Documentation/Images/FormCreationWizardElementsTab.png differ
diff --git a/typo3/sysext/form/Documentation/Images/FormCreationWizardFormTab.png b/typo3/sysext/form/Documentation/Images/FormCreationWizardFormTab.png
new file mode 100644 (file)
index 0000000..02bcb57
Binary files /dev/null and b/typo3/sysext/form/Documentation/Images/FormCreationWizardFormTab.png differ
diff --git a/typo3/sysext/form/Documentation/Images/FormCreationWizardOptionsTab.png b/typo3/sysext/form/Documentation/Images/FormCreationWizardOptionsTab.png
new file mode 100644 (file)
index 0000000..22a3aff
Binary files /dev/null and b/typo3/sysext/form/Documentation/Images/FormCreationWizardOptionsTab.png differ
diff --git a/typo3/sysext/form/Documentation/Images/FormCreationWizardShowTabs.png b/typo3/sysext/form/Documentation/Images/FormCreationWizardShowTabs.png
new file mode 100644 (file)
index 0000000..0195c2f
Binary files /dev/null and b/typo3/sysext/form/Documentation/Images/FormCreationWizardShowTabs.png differ
index 44f152e..fc1a6b6 100644 (file)
@@ -13,24 +13,18 @@ Introduction
 What does it do?
 ================
 
-This extension allows users to easily build forms using a drag and drop
+This extension allows editors to easily build forms using a drag and drop
 interface. A WYSIWYG view simplifies the process of building a form, and
 relatively non-technical editors can easily add chained validation rules
-on a field-by-field basis (e.g., email or alphanumeric validation).
+on a field-by-field basis (e.g., email and/ or alphanumeric validation).
 Furthermore, filters can be added to each field to manipulate the entered
 form data.
 
 Experienced integrators do not have to use the wizard. Instead, the form
 configuration can be created just using a TypoScript like syntax.
 
-
-.. _screenshots:
-
-Screenshots
-===========
-
 .. figure:: ../Images/FormCreationWizard.png
-    :alt: The form creation wizard
+    :alt: The form wizard with some predefined form elements.
 
-    The form creation wizard with dragging & dropping of form elements
+The screenshot shows the form wizard with some predefined form elements.