From 81dd6946960c5fee9ce12c325fe5cfe7ec3c3dd1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Jacob?= Date: Sun, 28 Apr 2019 11:25:38 +0200 Subject: [PATCH] [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 Tested-by: Susanne Moog Tested-by: Ralf Zimmermann Reviewed-by: Susanne Moog Reviewed-by: Ralf Zimmermann --- .../AbstractRenderable/setLabel.rst | 2 +- .../Documentation/I/ApiReference/Index.rst | 4 +-- .../I/Config/configuration/Index.rst | 15 +++++++++ .../I/Config/proto/formElements/Index.rst | 31 ++++++++++++++++++- .../formElementTypes/AdvancedPassword.rst | 6 ++++ .../AdvancedPassword/formEditor.rst | 5 +++ .../formEditor/editors/230.rst | 17 ++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElementTypes/Checkbox.rst | 6 ++++ .../formElementTypes/Checkbox/formEditor.rst | 5 +++ .../Checkbox/formEditor/editors/230.rst | 17 ++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElementTypes/DatePicker.rst | 6 ++++ .../DatePicker/formEditor.rst | 5 +++ .../DatePicker/formEditor/editors/230.rst | 17 ++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElements/formElementTypes/Email.rst | 6 ++++ .../formElementTypes/Email/formEditor.rst | 5 +++ .../Email/formEditor/editors/230.rst | 17 ++++++++++ .../Email/properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElementTypes/FileUpload.rst | 6 ++++ .../FileUpload/formEditor.rst | 5 +++ .../FileUpload/formEditor/editors/230.rst | 17 ++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElementTypes/ImageUpload.rst | 6 ++++ .../ImageUpload/formEditor.rst | 5 +++ .../ImageUpload/formEditor/editors/230.rst | 17 ++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElementTypes/MultiCheckbox.rst | 6 ++++ .../MultiCheckbox/formEditor.rst | 5 +++ .../MultiCheckbox/formEditor/editors/230.rst | 17 ++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElementTypes/MultiSelect.rst | 6 ++++ .../MultiSelect/formEditor.rst | 5 +++ .../MultiSelect/formEditor/editors/230.rst | 17 ++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElements/formElementTypes/Number.rst | 6 ++++ .../formElementTypes/Number/formEditor.rst | 5 +++ .../Number/formEditor/editors/230.rst | 18 +++++++++++ .../Number/properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElementTypes/Password.rst | 6 ++++ .../formElementTypes/Password/formEditor.rst | 5 +++ .../Password/formEditor/editors/230.rst | 17 ++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElementTypes/RadioButton.rst | 6 ++++ .../RadioButton/formEditor.rst | 5 +++ .../RadioButton/formEditor/editors/230.rst | 17 ++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElementTypes/SingleSelect.rst | 6 ++++ .../SingleSelect/formEditor.rst | 5 +++ .../SingleSelect/formEditor/editors/230.rst | 17 ++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElementTypes/Telephone.rst | 6 ++++ .../formElementTypes/Telephone/formEditor.rst | 5 +++ .../Telephone/formEditor/editors/230.rst | 18 +++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElements/formElementTypes/Text.rst | 6 ++++ .../formElementTypes/Text/formEditor.rst | 5 +++ .../Text/formEditor/editors/230.rst | 18 +++++++++++ .../Text/properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElementTypes/Textarea.rst | 6 ++++ .../formElementTypes/Textarea/formEditor.rst | 5 +++ .../Textarea/formEditor/editors/230.rst | 19 ++++++++++++ .../properties/elementDescription.rst | 31 +++++++++++++++++++ .../formElements/formElementTypes/Url.rst | 6 ++++ .../formElementTypes/Url/formEditor.rst | 5 +++ .../Url/formEditor/editors/230.rst | 19 ++++++++++++ .../Url/properties/elementDescription.rst | 31 +++++++++++++++++++ .../QuickStartForEditors/Index.rst | 3 +- .../QuickStartForIntegrators/Index.rst | 3 +- 70 files changed, 1003 insertions(+), 6 deletions(-) create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/properties/elementDescription.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/formEditor/editors/230.rst create mode 100644 typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/properties/elementDescription.rst diff --git a/typo3/sysext/form/Documentation/I/ApiReference/AbstractRenderable/setLabel.rst b/typo3/sysext/form/Documentation/I/ApiReference/AbstractRenderable/setLabel.rst index 8cc18a46b8dc..56d8d641b49c 100644 --- 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 index 280d6cd041ba..c7a6d80098c4 100644 --- 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 index 0ad40fcf3d64..a32883a0f719 100644 --- 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 index 0bc20ebe3889..7853c3ff03bd 100644 --- 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..formelementsdefinition..properties.elementDescription: + +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition..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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. + + .. _typo3.cms.form.prototypes..formelementsdefinition..properties.fluidadditionalattributes: properties.fluidAdditionalAttributes @@ -385,7 +414,7 @@ label - :ref:`"Translate form definition"` :aspect:`Description` - The label for the form element. + The label of the form element. .. _typo3.cms.form.prototypes..formelementsdefinition..formeditor: diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword.rst index b889bdd64cf7..a8ab70a0b918 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.advancedpassword.properties.elementclassattribute: .. include:: AdvancedPassword/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.advancedpassword.properties.elementDescription: +.. include:: AdvancedPassword/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.advancedpassword.properties.elementerrorclassattribute: .. include:: AdvancedPassword/properties/elementErrorClassAttribute.rst @@ -39,6 +42,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.advancedpassword.formeditor.editors.200: .. include:: AdvancedPassword/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.advancedpassword.formeditor.editors.230: +.. include:: AdvancedPassword/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.advancedpassword.formeditor.editors.300: .. include:: AdvancedPassword/formEditor/editors/300.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword/formEditor.rst index 71ae74a79740..d524b907dd4c 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword/formEditor.rst +++ b/typo3/sysext/form/Documentation/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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword/formEditor/editors/230.rst new file mode 100644 index 000000000000..3541a7bae9db --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword/formEditor/editors/230.rst @@ -0,0 +1,17 @@ +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword/properties/elementDescription.rst new file mode 100644 index 000000000000..49b96efcf114 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/AdvancedPassword/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox.rst index 0873f0475609..e7e2794571d4 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.checkbox.properties.elementclassattribute: .. include:: Checkbox/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.checkbox.properties.elementDescription: +.. include:: Checkbox/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.checkbox.properties.elementerrorclassattribute: .. include:: Checkbox/properties/elementErrorClassAttribute.rst @@ -36,6 +39,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.checkbox.formeditor.editors.200: .. include:: Checkbox/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.checkbox.formeditor.editors.230: +.. include:: Checkbox/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.checkbox.formeditor.editors.700: .. include:: Checkbox/formEditor/editors/700.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox/formEditor.rst index b2950ab0d96a..bf8edcff1a0c 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox/formEditor.rst +++ b/typo3/sysext/form/Documentation/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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox/formEditor/editors/230.rst new file mode 100644 index 000000000000..08c5ce74fee4 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox/formEditor/editors/230.rst @@ -0,0 +1,17 @@ +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox/properties/elementDescription.rst new file mode 100644 index 000000000000..3680ca78f40f --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Checkbox/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker.rst index b08000b3e0ab..f03aa04f7644 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.datepicker.properties.elementclassattribute: .. include:: DatePicker/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.datepicker.properties.elementDescription: +.. include:: DatePicker/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.datepicker.properties.elementerrorclassattribute: .. include:: DatePicker/properties/elementErrorClassAttribute.rst @@ -51,6 +54,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.datepicker.formeditor.editors.200: .. include:: DatePicker/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.datepicker.formeditor.editors.230: +.. include:: DatePicker/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.datepicker.formeditor.editors.300: .. include:: DatePicker/formEditor/editors/300.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker/formEditor.rst index 8ed60ad131c9..6c6558668282 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker/formEditor.rst +++ b/typo3/sysext/form/Documentation/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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker/formEditor/editors/230.rst new file mode 100644 index 000000000000..ae5036b44cfa --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker/formEditor/editors/230.rst @@ -0,0 +1,17 @@ +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker/properties/elementDescription.rst new file mode 100644 index 000000000000..b52b78c4f0b4 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/DatePicker/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email.rst index 9c353dd8c9d8..38a8ba9b8e0b 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.email.properties.elementclassattribute: .. include:: Email/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.email.properties.elementDescription: +.. include:: Email/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.email.properties.elementerrorclassattribute: .. include:: Email/properties/elementErrorClassAttribute.rst @@ -36,6 +39,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.email.formeditor.editors.200: .. include:: Email/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.email.formeditor.editors.230: +.. include:: Email/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.email.formeditor.editors.400: .. include:: Email/formEditor/editors/400.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email/formEditor.rst index 1feb45c267e0..4da2b59b5efc 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email/formEditor.rst +++ b/typo3/sysext/form/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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email/formEditor/editors/230.rst new file mode 100644 index 000000000000..b83a905d2e3c --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email/formEditor/editors/230.rst @@ -0,0 +1,17 @@ +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..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 diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email/properties/elementDescription.rst new file mode 100644 index 000000000000..96849ea22f59 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Email/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Email.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload.rst index 5090a8f32d16..44f863f733a1 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.fileupload.properties.elementclassattribute: .. include:: FileUpload/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.fileupload.properties.elementDescription: +.. include:: FileUpload/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.fileupload.properties.elementerrorclassattribute: .. include:: FileUpload/properties/elementErrorClassAttribute.rst @@ -39,6 +42,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.fileupload.formeditor.editors.200: .. include:: FileUpload/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.fileupload.formeditor.editors.230: +.. include:: FileUpload/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.fileupload.formeditor.editors.300: .. include:: FileUpload/formEditor/editors/300.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/formEditor.rst index 3ae24a0e3ee1..e98b8cfaaf9e 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/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: allowedMimeTypes templateName: Inspector-MultiSelectEditor diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/formEditor/editors/230.rst new file mode 100644 index 000000000000..fbef9a8a2dad --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/formEditor/editors/230.rst @@ -0,0 +1,17 @@ +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.FileUpload.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/properties/elementDescription.rst new file mode 100644 index 000000000000..5d968e6b34bd --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/FileUpload/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.FileUpload.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload.rst index b9db7c3e35f3..1bf6cd462ef1 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.imageupload.properties.elementclassattribute: .. include:: ImageUpload/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.imageupload.properties.elementDescription: +.. include:: ImageUpload/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.imageupload.properties.elementerrorclassattribute: .. include:: ImageUpload/properties/elementErrorClassAttribute.rst @@ -48,6 +51,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.imageupload.formeditor.editors.200: .. include:: ImageUpload/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.imageupload.formeditor.editors.230: +.. include:: ImageUpload/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.imageupload.formeditor.editors.300: .. include:: ImageUpload/formEditor/editors/300.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/formEditor.rst index 16a0c63e923b..970f0f35d5e3 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/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: allowedMimeTypes templateName: Inspector-MultiSelectEditor diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/formEditor/editors/230.rst new file mode 100644 index 000000000000..a184adb8497e --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/formEditor/editors/230.rst @@ -0,0 +1,17 @@ +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.ImageUpload.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/properties/elementDescription.rst new file mode 100644 index 000000000000..edee66475d9b --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/ImageUpload/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.ImageUpload.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox.rst index 3e320dff9cef..ba8c554ef3a5 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.multicheckbox.properties.elementclassattribute: .. include:: MultiCheckbox/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.multicheckbox.properties.elementDescription: +.. include:: MultiCheckbox/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.multicheckbox.properties.elementerrorclassattribute: .. include:: MultiCheckbox/properties/elementErrorClassAttribute.rst @@ -33,6 +36,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.multicheckbox.formeditor.editors.200: .. include:: MultiCheckbox/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.multicheckbox.formeditor.editors.230: +.. include:: MultiCheckbox/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.multicheckbox.formeditor.editors.300: .. include:: MultiCheckbox/formEditor/editors/300.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/formEditor.rst index 162fcf6ed8f7..c2f5598fc484 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/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: options templateName: Inspector-PropertyGridEditor diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/formEditor/editors/230.rst new file mode 100644 index 000000000000..3ee319cdde3f --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/formEditor/editors/230.rst @@ -0,0 +1,17 @@ +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.MultiCheckbox.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/properties/elementDescription.rst new file mode 100644 index 000000000000..3dfceb2cc8be --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiCheckbox/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.MultiCheckbox.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect.rst index 7b5213c5033a..6cd76fcf0ff7 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.multiselect.properties.elementclassattribute: .. include:: MultiSelect/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.multiselect.properties.elementDescription: +.. include:: MultiSelect/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.multiselect.properties.elementerrorclassattribute: .. include:: MultiSelect/properties/elementErrorClassAttribute.rst @@ -39,6 +42,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.multiselect.formeditor.editors.200: .. include:: MultiSelect/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.multiselect.formeditor.editors.230: +.. include:: MultiSelect/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.multiselect.formeditor.editors.250: .. include:: MultiSelect/formEditor/editors/250.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/formEditor.rst index f1c3ccee2878..5165e5b6487e 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/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 250: identifier: inactiveOption templateName: Inspector-TextEditor diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/formEditor/editors/230.rst new file mode 100644 index 000000000000..5021bdea4fcf --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/formEditor/editors/230.rst @@ -0,0 +1,17 @@ +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.MultiSelect.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/properties/elementDescription.rst new file mode 100644 index 000000000000..91488f6db1fc --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/MultiSelect/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.MultiSelect.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number.rst index 1bdc6e6a1ed3..71947a3a1958 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.number.properties.elementclassattribute: .. include:: Number/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.number.properties.elementDescription: +.. include:: Number/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.number.properties.elementerrorclassattribute: .. include:: Number/properties/elementErrorClassAttribute.rst @@ -36,6 +39,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.number.formeditor.editors.200: .. include:: Number/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.number.formeditor.editors.230: +.. include:: Number/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.number.formeditor.editors.400: .. include:: Number/formEditor/editors/400.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/formEditor.rst index 9f04042d161c..6e97c9f0257d 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/formEditor/editors/230.rst new file mode 100644 index 000000000000..a7e02390d5aa --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/formEditor/editors/230.rst @@ -0,0 +1,18 @@ + +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Number.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/properties/elementDescription.rst new file mode 100644 index 000000000000..9e2d5d5fd8ee --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Number/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Number.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password.rst index 97126d6da97b..14092972802a 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.password.properties.elementclassattribute: .. include:: Password/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.password.properties.elementDescription: +.. include:: Password/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.password.properties.elementerrorclassattribute: .. include:: Password/properties/elementErrorClassAttribute.rst @@ -33,6 +36,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.password.formeditor.editors.200: .. include:: Password/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.password.formeditor.editors.230: +.. include:: Password/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.password.formeditor.editors.400: .. include:: Password/formEditor/editors/400.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/formEditor.rst index 3aa63ba7a446..a527109eb4a1 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/formEditor/editors/230.rst new file mode 100644 index 000000000000..208f9be2438f --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/formEditor/editors/230.rst @@ -0,0 +1,17 @@ +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Password.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/properties/elementDescription.rst new file mode 100644 index 000000000000..042a8778ac15 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Password/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Password.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton.rst index 86c4bec7c181..077cb4520a7c 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.radiobutton.properties.elementclassattribute: .. include:: RadioButton/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.radiobutton.properties.elementDescription: +.. include:: RadioButton/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.radiobutton.properties.elementerrorclassattribute: .. include:: RadioButton/properties/elementErrorClassAttribute.rst @@ -33,6 +36,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.radiobutton.formeditor.editors.200: .. include:: RadioButton/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.radiobutton.formeditor.editors.230: +.. include:: RadioButton/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.radiobutton.formeditor.editors.300: .. include:: RadioButton/formEditor/editors/300.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/formEditor.rst index bf2b8b5d7c43..9ffd7b2f07d3 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/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: options templateName: Inspector-PropertyGridEditor diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/formEditor/editors/230.rst new file mode 100644 index 000000000000..b83f0f10986e --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/formEditor/editors/230.rst @@ -0,0 +1,17 @@ +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.RadioButton.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/properties/elementDescription.rst new file mode 100644 index 000000000000..14cf472d94ee --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/RadioButton/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.RadioButton.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect.rst index 7325bd60b19f..ce72bc0169de 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.singleselect.properties.elementclassattribute: .. include:: SingleSelect/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.singleselect.properties.elementDescription: +.. include:: SingleSelect/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.singleselect.properties.elementerrorclassattribute: .. include:: SingleSelect/properties/elementErrorClassAttribute.rst @@ -39,6 +42,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.singleselect.formeditor.editors.200: .. include:: SingleSelect/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.singleselect.formeditor.editors.230: +.. include:: SingleSelect/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.singleselect.formeditor.editors.250: .. include:: SingleSelect/formEditor/editors/250.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/formEditor.rst index 5587708167c3..3b84b6eab9d8 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/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 250: identifier: inactiveOption templateName: Inspector-TextEditor diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/formEditor/editors/230.rst new file mode 100644 index 000000000000..d83bb85820d8 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/formEditor/editors/230.rst @@ -0,0 +1,17 @@ +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.SingleSelect.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/properties/elementDescription.rst new file mode 100644 index 000000000000..a7d5a9918480 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/SingleSelect/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.SingleSelect.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone.rst index 2d21d94096b1..f871ad31dc18 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.telephone.properties.elementclassattribute: .. include:: Telephone/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.telephone.properties.elementDescription: +.. include:: Telephone/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.telephone.properties.elementerrorclassattribute: .. include:: Telephone/properties/elementErrorClassAttribute.rst @@ -36,6 +39,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.telephone.formeditor.editors.200: .. include:: Telephone/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.telephone.formeditor.editors.230: +.. include:: Telephone/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.telephone.formeditor.editors.400: .. include:: Telephone/formEditor/editors/400.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/formEditor.rst index dbbe09534894..e00102088582 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/formEditor/editors/230.rst new file mode 100644 index 000000000000..afaa5208fe61 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/formEditor/editors/230.rst @@ -0,0 +1,18 @@ + +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Telephone.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/properties/elementDescription.rst new file mode 100644 index 000000000000..b8ce167bc14f --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Telephone/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Telephone.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text.rst index 4471f8243c73..0ea900719145 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.text.properties.elementclassattribute: .. include:: Text/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.text.properties.elementDescription: +.. include:: Text/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.text.properties.elementerrorclassattribute: .. include:: Text/properties/elementErrorClassAttribute.rst @@ -33,6 +36,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.text.formeditor.editors.200: .. include:: Text/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.text.formeditor.editors.230: +.. include:: Text/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.text.formeditor.editors.400: .. include:: Text/formEditor/editors/400.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/formEditor.rst index 89c404298fd7..8984891d50e6 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/formEditor/editors/230.rst new file mode 100644 index 000000000000..c3ffb5c18e20 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/formEditor/editors/230.rst @@ -0,0 +1,18 @@ + +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Text.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/properties/elementDescription.rst new file mode 100644 index 000000000000..a16b16ef7338 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Text/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Text.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea.rst index 0219ecad9223..bcfa6583faac 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.textarea.properties.elementclassattribute: .. include:: Textarea/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.textarea.properties.elementDescription: +.. include:: Textarea/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.textarea.properties.elementerrorclassattribute: .. include:: Textarea/properties/elementErrorClassAttribute.rst @@ -33,6 +36,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.textarea.formeditor.editors.200: .. include:: Textarea/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.textarea.formeditor.editors.230: +.. include:: Textarea/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.textarea.formeditor.editors.400: .. include:: Textarea/formEditor/editors/400.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/formEditor.rst index e6297d761954..6f63e75f0c07 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/formEditor/editors/230.rst new file mode 100644 index 000000000000..47de70532db2 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/formEditor/editors/230.rst @@ -0,0 +1,19 @@ + + +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Textarea.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/properties/elementDescription.rst new file mode 100644 index 000000000000..b3d55a4e1862 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Textarea/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Textarea.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url.rst index 388c948f7e87..640c2473fde4 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url.rst @@ -21,6 +21,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.url.properties.elementclassattribute: .. include:: Url/properties/elementClassAttribute.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.url.properties.elementDescription: +.. include:: Url/properties/elementDescription.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.url.properties.elementerrorclassattribute: .. include:: Url/properties/elementErrorClassAttribute.rst @@ -36,6 +39,9 @@ Properties .. _typo3.cms.form.prototypes..formelementsdefinition.url.formeditor.editors.200: .. include:: Url/formEditor/editors/200.rst +.. _typo3.cms.form.prototypes..formelementsdefinition.url.formeditor.editors.230: +.. include:: Url/formEditor/editors/230.rst + .. _typo3.cms.form.prototypes..formelementsdefinition.url.formeditor.editors.400: .. include:: Url/formEditor/editors/400.rst diff --git a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/formEditor.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/formEditor.rst index 6dbc754565b8..6bd183ce1bdd 100644 --- a/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/formEditor.rst +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/formEditor/editors/230.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/formEditor/editors/230.rst new file mode 100644 index 000000000000..1c45477a0129 --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/formEditor/editors/230.rst @@ -0,0 +1,19 @@ + + +formEditor.editors.230 +---------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Url.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/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/properties/elementDescription.rst b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/properties/elementDescription.rst new file mode 100644 index 000000000000..3aee099be9ca --- /dev/null +++ b/typo3/sysext/form/Documentation/I/Config/proto/formElements/formElementTypes/Url/properties/elementDescription.rst @@ -0,0 +1,31 @@ +properties.elementDescription +----------------------------- + +:aspect:`Option path` + TYPO3.CMS.Form.prototypes..formElementsDefinition.Url.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"` + - :ref:`"Translate form definition"` + +:aspect:`Description` + Set a description of the form element. By default, it is displayed + below the form element. \ No newline at end of file diff --git a/typo3/sysext/form/Documentation/QuickStartForEditors/Index.rst b/typo3/sysext/form/Documentation/QuickStartForEditors/Index.rst index 1b9256892e8b..427b14c47a30 100644 --- a/typo3/sysext/form/Documentation/QuickStartForEditors/Index.rst +++ b/typo3/sysext/form/Documentation/QuickStartForEditors/Index.rst @@ -7,7 +7,8 @@ Quick Start for Editors ======================= -You are an editor, your admin installed the form extension and you want to get started quickly? Follow these steps! +You are an editor, your admin installed the form extension and you want +to get started quickly? Follow these steps! .. rst-class:: bignums-xxl diff --git a/typo3/sysext/form/Documentation/QuickStartForIntegrators/Index.rst b/typo3/sysext/form/Documentation/QuickStartForIntegrators/Index.rst index 8de37f74992f..658efc4b36ae 100644 --- a/typo3/sysext/form/Documentation/QuickStartForIntegrators/Index.rst +++ b/typo3/sysext/form/Documentation/QuickStartForIntegrators/Index.rst @@ -7,7 +7,8 @@ Quick Start for Integrators =========================== -You could make EXT:form work for your site quickly. Just follow these steps! +You are an integrator, your admin or you installed the form extension +and you want to get started quickly? Just follow these steps! .. rst-class:: bignums-xxl