[TASK] EXT:form - add missing documentation for select element options 06/53406/2
authorRalf Zimmermann <ralf.zimmermann@tritum.de>
Wed, 5 Jul 2017 09:08:22 +0000 (11:08 +0200)
committerWouter Wolters <typo3@wouterwolters.nl>
Wed, 19 Jul 2017 17:58:30 +0000 (19:58 +0200)
Add documentation for select elements "prependOptionLabel" and
"prependOptionValue" options.

Resolves: #81797
Releases: master, 8.7
Change-Id: I0fd1d3ccbe7e2a2cbcbb08c7c30d81376353cda3
Reviewed-on: https://review.typo3.org/53406
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Daniel Goerz <ervaude@gmail.com>
Tested-by: Daniel Goerz <ervaude@gmail.com>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect.rst
typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/prependOptionLabel.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/prependOptionValue.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect.rst
typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/prependOptionLabel.rst [new file with mode: 0644]
typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/prependOptionValue.rst [new file with mode: 0644]

index b679457..315ec8d 100644 (file)
@@ -24,6 +24,12 @@ Properties
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.properties.elementerrorclassattribute:
 .. include:: MultiSelect/properties/elementErrorClassAttribute.rst
 
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.properties.prependOptionLabel:
+.. include:: MultiSelect/properties/prependOptionLabel.rst
+
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.properties.prependOptionValue:
+.. include:: MultiSelect/properties/prependOptionValue.rst
+
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor:
 .. include:: MultiSelect/formEditor.rst
 
diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/prependOptionLabel.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/prependOptionLabel.rst
new file mode 100644 (file)
index 0000000..095c480
--- /dev/null
@@ -0,0 +1,29 @@
+properties.prependOptionLabel
+-----------------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.properties.prependOptionLabel
+
+: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`
+      ToDo
+
+:aspect:`Description`
+      If set, this label will be shown as first select-option.
\ No newline at end of file
diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/prependOptionValue.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/MultiSelect/properties/prependOptionValue.rst
new file mode 100644 (file)
index 0000000..aac3fad
--- /dev/null
@@ -0,0 +1,29 @@
+properties.prependOptionValue
+-----------------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.MultiSelect.properties.prependOptionValue
+
+: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')`
+      No
+
+:aspect:`Mandatory`
+      No
+
+:aspect:`Default value (for prototype 'standard')`
+      undefined
+
+.. :aspect:`Good to know`
+      ToDo
+
+:aspect:`Description`
+      If set, this value will be set for the first select-option.
\ No newline at end of file
index 3d59130..d2d6f26 100644 (file)
@@ -24,6 +24,12 @@ Properties
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.properties.elementerrorclassattribute:
 .. include:: SingleSelect/properties/elementErrorClassAttribute.rst
 
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.properties.prependOptionLabel:
+.. include:: SingleSelect/properties/prependOptionLabel.rst
+
+.. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.properties.prependOptionValue:
+.. include:: SingleSelect/properties/prependOptionValue.rst
+
 .. _typo3.cms.form.prototypes.<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor:
 .. include:: SingleSelect/formEditor.rst
 
diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/prependOptionLabel.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/prependOptionLabel.rst
new file mode 100644 (file)
index 0000000..e1d753d
--- /dev/null
@@ -0,0 +1,29 @@
+properties.prependOptionLabel
+-----------------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.properties.prependOptionLabel
+
+: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`
+      ToDo
+
+:aspect:`Description`
+      If set, this label will be shown as first select-option.
\ No newline at end of file
diff --git a/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/prependOptionValue.rst b/typo3/sysext/form/Documentation/ConfigurationReference/prototypes/formElementsDefinition/formElementTypes/SingleSelect/properties/prependOptionValue.rst
new file mode 100644 (file)
index 0000000..03aed71
--- /dev/null
@@ -0,0 +1,29 @@
+properties.prependOptionValue
+-----------------------------
+
+:aspect:`Option path`
+      TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.SingleSelect.properties.prependOptionValue
+
+: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')`
+      No
+
+:aspect:`Mandatory`
+      No
+
+:aspect:`Default value (for prototype 'standard')`
+      undefined
+
+.. :aspect:`Good to know`
+      ToDo
+
+:aspect:`Description`
+      If set, this value will be set for the first select-option.
\ No newline at end of file