[TASK] Document property "elementDescription"

The property "elementDescription" has been documented for both the backend (form editor) and the frontend of the form framework. In addition, some minor contextual and spelling problems have been fixed. Resolves: #84229 Releases: master, 9.5 Change-Id: Ifc9039b3dc434a20783d8d67b5d6efcd1eed113e Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/60609 Tested-by: TYPO3com <noreply@typo3.com> Tested-by: Susanne Moog <look@susi.dev> Tested-by: Ralf Zimmermann <ralf.zimmermann@tritum.de> Reviewed-by: Susanne Moog <look@susi.dev> Reviewed-by: Ralf Zimmermann <ralf.zimmermann@tritum.de>
TYPO3 · Apr 28, 2019 · 81dd694 · 81dd694
1 parent a35d35d
commit 81dd694
Show file tree

Hide file tree

Showing 70 changed files with 1,003 additions and 6 deletions.
diff --git a/typo3/sysext/form/Documentation/I/ApiReference/AbstractRenderable/setLabel.rst b/typo3/sysext/form/Documentation/I/ApiReference/AbstractRenderable/setLabel.rst
@@ -1,7 +1,7 @@
 setLabel()
 ''''''''''
 
-Set the label for the form element.
+Set the label of the form element.
 
 Signature::
 

diff --git a/typo3/sysext/form/Documentation/I/ApiReference/Index.rst b/typo3/sysext/form/Documentation/I/ApiReference/Index.rst
@@ -422,8 +422,8 @@ You only need a class which connects to this hook. Then detect the form element
 
 .. _apireference-frontendrendering-programmatically-apimethods:
 
-API Methods
-^^^^^^^^^^^
+Further API Methods
+^^^^^^^^^^^^^^^^^^^
 
 
 .. _apireference-frontendrendering-programmatically-apimethods-formruntime:

diff --git a/typo3/sysext/form/Documentation/I/Config/configuration/Index.rst b/typo3/sysext/form/Documentation/I/Config/configuration/Index.rst
@@ -3909,6 +3909,11 @@ Full default configuration
                 templateName: Inspector-TextEditor
                 label: formEditor.elements.FormElement.editor.label.label
                 propertyPath: label
+              230:
+                  identifier: elementDescription
+                  templateName: Inspector-TextEditor
+                  label: formEditor.elements.FormElement.editor.elementDescription.label
+                  propertyPath: properties.elementDescription
               700:
                 identifier: gridColumnViewPortConfiguration
                 templateName: Inspector-GridColumnViewPortConfigurationEditor
@@ -3938,6 +3943,16 @@ Full default configuration
                 validatorIdentifier: NotEmpty
                 propertyPath: properties.fluidAdditionalAttributes.required
                 propertyValue: required
+                configurationOptions:
+                  validationErrorMessage:
+                    label: formEditor.elements.FormElement.editor.requiredValidator.validationErrorMessage.label
+                    propertyPath: properties.validationErrorMessages
+                    fieldExplanationText: formEditor.elements.FormElement.editor.requiredValidator.validationErrorMessage.fieldExplanationText
+                    errorCodes:
+                      10: 1221560910
+                      20: 1221560718
+                      30: 1347992400
+                      40: 1347992453
               9999:
                 identifier: removeButton
                 templateName: Inspector-RemoveElementEditor

diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/Index.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/Index.rst
@@ -291,6 +291,35 @@ properties
       Array with form element specific properties.
 
 
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties.elementDescription:
+
+properties.elementDescription
+-----------------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.<formElementTypeIdentifier>.properties.elementDescription
+
+:aspect:`Data type`
+      string
+
+:aspect:`Needed by`
+      Frontend/ Backend (form editor)
+
+:aspect:`Mandatory`
+      No
+
+:aspect:`Default value`
+      Undefined
+
+:aspect:`Good to know`
+      - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
+      - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
+
+:aspect:`Description`
+      Set a description of the form element. By default, it is displayed
+      below the form element.
+
+
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.properties.fluidadditionalattributes:
 
 properties.fluidAdditionalAttributes
@@ -385,7 +414,7 @@ label
       - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
 
 :aspect:`Description`
-      The label for the form element.
+      The label of the form element.
 
 
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor:

diff --git a/...Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword.rst b/...Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword.rst
@@ -21,6 +21,9 @@ Properties
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.elementclassattribute:
 .. include:: AdvancedPassword/properties/elementClassAttribute.rst
 
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.elementDescription:
+.. include:: AdvancedPassword/properties/elementDescription.rst
+
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.properties.elementerrorclassattribute:
 .. include:: AdvancedPassword/properties/elementErrorClassAttribute.rst
 
@@ -39,6 +42,9 @@ Properties
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.200:
 .. include:: AdvancedPassword/formEditor/editors/200.rst
 
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.230:
+.. include:: AdvancedPassword/formEditor/editors/230.rst
+
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.editors.300:
 .. include:: AdvancedPassword/formEditor/editors/300.rst
 

diff --git a/...on/I/Config/proto/formElements/formElementTypes/AdvancedPassword/formEditor.rst b/...on/I/Config/proto/formElements/formElementTypes/AdvancedPassword/formEditor.rst
@@ -29,6 +29,11 @@ formEditor
                  templateName: Inspector-TextEditor
                  label: formEditor.elements.FormElement.editor.label.label
                  propertyPath: label
+               230:
+                  identifier: elementDescription
+                  templateName: Inspector-TextEditor
+                  label: formEditor.elements.FormElement.editor.elementDescription.label
+                  propertyPath: properties.elementDescription
                300:
                  identifier: confirmationLabel
                  templateName: Inspector-TextEditor

diff --git a/...proto/formElements/formElementTypes/AdvancedPassword/formEditor/editors/230.rst b/...proto/formElements/formElementTypes/AdvancedPassword/formEditor/editors/230.rst
@@ -0,0 +1,17 @@
+formEditor.editors.230
+----------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.230
+
+:aspect:`Data type`
+      string
+
+:aspect:`Needed by`
+      Frontend/ Backend (form editor)
+
+:aspect:`Mandatory`
+      No
+
+:aspect:`Default value (for prototype 'standard')`
+      Undefined
diff --git a/...ormElements/formElementTypes/AdvancedPassword/properties/elementDescription.rst b/...ormElements/formElementTypes/AdvancedPassword/properties/elementDescription.rst
@@ -0,0 +1,31 @@
+properties.elementDescription
+-----------------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.properties.elementDescription
+
+:aspect:`Data type`
+      string
+
+:aspect:`Needed by`
+      Frontend/ Backend (form editor)
+
+:aspect:`Overwritable within form definition`
+      Yes
+
+:aspect:`Form editor can write this property into the form definition (for prototype 'standard')`
+      Yes
+
+:aspect:`Mandatory`
+      No
+
+:aspect:`Default value (for prototype 'standard')`
+      Undefined
+
+:aspect:`Good to know`
+      - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
+      - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
+
+:aspect:`Description`
+      Set a description of the form element. By default, it is displayed
+      below the form element.
diff --git a/...xt/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox.rst b/...xt/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox.rst
@@ -21,6 +21,9 @@ Properties
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.properties.elementclassattribute:
 .. include:: Checkbox/properties/elementClassAttribute.rst
 
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.properties.elementDescription:
+.. include:: Checkbox/properties/elementDescription.rst
+
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.properties.elementerrorclassattribute:
 .. include:: Checkbox/properties/elementErrorClassAttribute.rst
 
@@ -36,6 +39,9 @@ Properties
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.editors.200:
 .. include:: Checkbox/formEditor/editors/200.rst
 
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.editors.230:
+.. include:: Checkbox/formEditor/editors/230.rst
+
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.editors.700:
 .. include:: Checkbox/formEditor/editors/700.rst
 

diff --git a/...umentation/I/Config/proto/formElements/formElementTypes/Checkbox/formEditor.rst b/...umentation/I/Config/proto/formElements/formElementTypes/Checkbox/formEditor.rst
@@ -29,6 +29,11 @@ formEditor
                  templateName: Inspector-TextEditor
                  label: formEditor.elements.FormElement.editor.label.label
                  propertyPath: label
+               230:
+                  identifier: elementDescription
+                  templateName: Inspector-TextEditor
+                  label: formEditor.elements.FormElement.editor.elementDescription.label
+                  propertyPath: properties.elementDescription
                700:
                  identifier: gridColumnViewPortConfiguration
                  templateName: Inspector-GridColumnViewPortConfigurationEditor

diff --git a/.../Config/proto/formElements/formElementTypes/Checkbox/formEditor/editors/230.rst b/.../Config/proto/formElements/formElementTypes/Checkbox/formEditor/editors/230.rst
@@ -0,0 +1,17 @@
+formEditor.editors.230
+----------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.editors.230
+
+:aspect:`Data type`
+      string
+
+:aspect:`Needed by`
+      Frontend/ Backend (form editor)
+
+:aspect:`Mandatory`
+      No
+
+:aspect:`Default value (for prototype 'standard')`
+      Undefined
diff --git a/.../proto/formElements/formElementTypes/Checkbox/properties/elementDescription.rst b/.../proto/formElements/formElementTypes/Checkbox/properties/elementDescription.rst
@@ -0,0 +1,31 @@
+properties.elementDescription
+-----------------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Checkbox.properties.elementDescription
+
+:aspect:`Data type`
+      string
+
+:aspect:`Needed by`
+      Frontend/ Backend (form editor)
+
+:aspect:`Overwritable within form definition`
+      Yes
+
+:aspect:`Form editor can write this property into the form definition (for prototype 'standard')`
+      Yes
+
+:aspect:`Mandatory`
+      No
+
+:aspect:`Default value (for prototype 'standard')`
+      Undefined
+
+:aspect:`Good to know`
+      - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
+      - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
+
+:aspect:`Description`
+      Set a description of the form element. By default, it is displayed
+      below the form element.
diff --git a/.../form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker.rst b/.../form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker.rst
@@ -21,6 +21,9 @@ Properties
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.elementclassattribute:
 .. include:: DatePicker/properties/elementClassAttribute.rst
 
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.elementDescription:
+.. include:: DatePicker/properties/elementDescription.rst
+
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.properties.elementerrorclassattribute:
 .. include:: DatePicker/properties/elementErrorClassAttribute.rst
 
@@ -51,6 +54,9 @@ Properties
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.200:
 .. include:: DatePicker/formEditor/editors/200.rst
 
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.230:
+.. include:: DatePicker/formEditor/editors/230.rst
+
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.editors.300:
 .. include:: DatePicker/formEditor/editors/300.rst
 

diff --git a/...entation/I/Config/proto/formElements/formElementTypes/DatePicker/formEditor.rst b/...entation/I/Config/proto/formElements/formElementTypes/DatePicker/formEditor.rst
@@ -29,6 +29,11 @@ formEditor
                  templateName: Inspector-TextEditor
                  label: formEditor.elements.FormElement.editor.label.label
                  propertyPath: label
+               230:
+                  identifier: elementDescription
+                  templateName: Inspector-TextEditor
+                  label: formEditor.elements.FormElement.editor.elementDescription.label
+                  propertyPath: properties.elementDescription
                300:
                  identifier: dateFormat
                  templateName: Inspector-TextEditor

diff --git a/...onfig/proto/formElements/formElementTypes/DatePicker/formEditor/editors/230.rst b/...onfig/proto/formElements/formElementTypes/DatePicker/formEditor/editors/230.rst
@@ -0,0 +1,17 @@
+formEditor.editors.230
+----------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.editors.230
+
+:aspect:`Data type`
+      string
+
+:aspect:`Needed by`
+      Frontend/ Backend (form editor)
+
+:aspect:`Mandatory`
+      No
+
+:aspect:`Default value (for prototype 'standard')`
+      Undefined
diff --git a/...roto/formElements/formElementTypes/DatePicker/properties/elementDescription.rst b/...roto/formElements/formElementTypes/DatePicker/properties/elementDescription.rst
@@ -0,0 +1,31 @@
+properties.elementDescription
+-----------------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.DatePicker.properties.elementDescription
+
+:aspect:`Data type`
+      string
+
+:aspect:`Needed by`
+      Frontend/ Backend (form editor)
+
+:aspect:`Overwritable within form definition`
+      Yes
+
+:aspect:`Form editor can write this property into the form definition (for prototype 'standard')`
+      Yes
+
+:aspect:`Mandatory`
+      No
+
+:aspect:`Default value (for prototype 'standard')`
+      Undefined
+
+:aspect:`Good to know`
+      - :ref:`"Custom form element implementations"<concepts-frontendrendering-codecomponents-customformelementimplementations>`
+      - :ref:`"Translate form definition"<concepts-frontendrendering-translation-formdefinition>`
+
+:aspect:`Description`
+      Set a description of the form element. By default, it is displayed
+      below the form element.
diff --git a/...ysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email.rst b/...ysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email.rst
@@ -21,6 +21,9 @@ Properties
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.email.properties.elementclassattribute:
 .. include:: Email/properties/elementClassAttribute.rst
 
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.email.properties.elementDescription:
+.. include:: Email/properties/elementDescription.rst
+
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.email.properties.elementerrorclassattribute:
 .. include:: Email/properties/elementErrorClassAttribute.rst
 
@@ -36,6 +39,9 @@ Properties
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.email.formeditor.editors.200:
 .. include:: Email/formEditor/editors/200.rst
 
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.email.formeditor.editors.230:
+.. include:: Email/formEditor/editors/230.rst
+
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.email.formeditor.editors.400:
 .. include:: Email/formEditor/editors/400.rst
 

diff --git a/...Documentation/I/Config/proto/formElements/formElementTypes/Email/formEditor.rst b/...Documentation/I/Config/proto/formElements/formElementTypes/Email/formEditor.rst
@@ -29,6 +29,11 @@ formEditor
                   templateName: Inspector-TextEditor
                   label: formEditor.elements.FormElement.editor.label.label
                   propertyPath: label
+               230:
+                  identifier: elementDescription
+                  templateName: Inspector-TextEditor
+                  label: formEditor.elements.FormElement.editor.elementDescription.label
+                  propertyPath: properties.elementDescription
                 400:
                   identifier: placeholder
                   templateName: Inspector-TextEditor

diff --git a/...n/I/Config/proto/formElements/formElementTypes/Email/formEditor/editors/230.rst b/...n/I/Config/proto/formElements/formElementTypes/Email/formEditor/editors/230.rst
@@ -0,0 +1,17 @@
+formEditor.editors.230
+----------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.Email.formEditor.editors.230
+
+:aspect:`Data type`
+      string
+
+:aspect:`Needed by`
+      Frontend/ Backend (form editor)
+
+:aspect:`Mandatory`
+      No
+
+:aspect:`Default value (for prototype 'standard')`
+      Undefined