Skip to content

Commit

Permalink
[DOCS] Document date element in EXT:form
Browse files Browse the repository at this point in the history
Resolves: #84458
Releases: master, 9.5
Change-Id: I0f54f01f2f1adee798c0df7358f61f865039d4e8
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/62417
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Ralf Zimmermann <ralf.zimmermann@tritum.de>
Reviewed-by: Ralf Zimmermann <ralf.zimmermann@tritum.de>
  • Loading branch information
Björn Jacob authored and waldhacker1 committed Nov 23, 2019
1 parent 8610cb0 commit 6ccbe2f
Show file tree
Hide file tree
Showing 122 changed files with 3,121 additions and 87 deletions.
2 changes: 1 addition & 1 deletion typo3/sysext/form/Documentation/ApiReference/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2181,7 +2181,7 @@ partialRootPaths
.. _apireference-finisheroptions-emailfinisher-options-templaterootpaths:

templateRootPaths
++++++++++++++++
+++++++++++++++++

:aspect:`Data type`
array
Expand Down
11 changes: 8 additions & 3 deletions typo3/sysext/form/Documentation/Concepts/Validators/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,14 @@ providing a minimum and/ or maximum date. The validator has 2 options:
- Minimum date: The minimum date.
- Maximum date: The maximum date.

The date string for the above mentioned fields is expected to be formatted
according to the `W3C standard <http://www.w3.org/TR/NOTE-datetime.html>`_
which is "YYYY-MM-DDT##:##:##+##:##", for example "2005-08-15T15:52:01+00:00".
The properties ``minimum`` and ``maximum`` must have the format 'Y-m-d' which
represents the RFC 3339 'full-date' format.

Read more: https://www.w3.org/TR/2011/WD-html-markup-20110405/input.date.html

The input must be a DateTime object. This input can be tested against a minimum
date and a maximum date. The minimum date and the maximum date are strings. The minimum
date and the maximum date can be configured through the validator options.


.. _concepts-validators-email:
Expand Down
42 changes: 28 additions & 14 deletions typo3/sysext/form/Documentation/Config/proto/formEditor/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,7 @@ formEditorPartials
FormElement-Telephone: 'Stage/SimpleTemplate'
FormElement-Url: 'Stage/SimpleTemplate'
FormElement-Number: 'Stage/SimpleTemplate'
FormElement-Date: 'Stage/SimpleTemplate'
Modal-InsertElements: Modals/InsertElements
Modal-InsertPages: Modals/InsertPages
Modal-ValidationErrors: Modals/ValidationErrors
Expand All @@ -489,6 +490,7 @@ formEditorPartials
Inspector-ValidatorsEditor: Inspector/ValidatorsEditor
Inspector-RequiredValidatorEditor: Inspector/RequiredValidatorEditor
Inspector-CheckboxEditor: Inspector/CheckboxEditor
Inspector-ValidationErrorMessageEditor: Inspector/ValidationErrorMessageEditor
Inspector-Typo3WinBrowserEditor: Inspector/Typo3WinBrowserEditor
:aspect:`Good to know`
Expand Down Expand Up @@ -538,6 +540,10 @@ formElementPropertyValidatorsDefinition
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label
FormElementIdentifierWithinCurlyBracesExclusive:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label
FileSize:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FileSize.label
RFC3339FullDate:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.RFC3339FullDate.label
:aspect:`Related options`
- :ref:`"[TextEditor] propertyValidators"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-texteditor>`
Expand Down Expand Up @@ -589,6 +595,10 @@ formElementPropertyValidatorsDefinition.<formElementPropertyValidatorIdentifier>
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label
FormElementIdentifierWithinCurlyBracesExclusive:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FormElementIdentifierWithinCurlyBraces.label
FileSize:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.FileSize.label
RFC3339FullDate:
errorMessage: formEditor.formElementPropertyValidatorsDefinition.RFC3339FullDate.label
:aspect:`Related options`
- :ref:`"[TextEditor] propertyValidators"<typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.propertyvalidators-texteditor>`
Expand Down Expand Up @@ -639,26 +649,30 @@ formElementGroups
label: formEditor.formElementGroups.page.label
:aspect:`Related options`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Password.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.password.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Text.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.text.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Page.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.page.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.advancedpassword.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Checkbox.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.checkbox.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.GridContainer.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.gridcontainer.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Date.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.date.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Email.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.email.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Hidden.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.hidden.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.ImageUpload.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.imageupload.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.MultiCheckbox.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.multicheckbox.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.MultiSelect.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.multiselect.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Number.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.number.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Page.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.page.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Password.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.password.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.RadioButton.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.radiobutton.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.SingleSelect.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.singleselect.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.FileUpload.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.fileupload.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.GridRow.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.gridrow.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Fieldset.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.fieldset.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.ContentElement.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.contentelement.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.DatePicker.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.datepicker.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.StaticText.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.statictext.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.SummaryPage.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.summarypage.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Telephone.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.telephone.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Text.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.text.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Textarea.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.textarea.formeditor.group>`
- :ref:`"TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formElementsDefinition.Url.formEditor.group"<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.url.formeditor.group>`

:aspect:`Good to know`
- :ref:`"Form editor"<concepts-formeditor>`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,16 @@ Properties
[...]
Hidden:
[...]
Email:
[...]
Telephone:
[...]
Url:
[...]
Number:
[...]
Date:
[...]
Checkbox:
[...]
MultiCheckbox:
Expand Down Expand Up @@ -798,6 +808,7 @@ Concrete configurations

formElementTypes/AdvancedPassword
formElementTypes/Checkbox
formElementTypes/Date
formElementTypes/ContentElement
formElementTypes/DatePicker
formElementTypes/Email
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,4 @@ available inspector editors
inspectorEditors/TextEditor
inspectorEditors/Typo3WinBrowserEditor
inspectorEditors/ValidatorsEditor
inspectorEditors/ValidationErrorMessageEditor
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
.. include:: ../../../../../../Includes.txt

.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validationerrormessageeditor:

==============================
[ValidationErrorMessageEditor]
==============================

.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validationerrormessageeditor-introduction:

Introduction
============

Shows a textarea. It allows the definition of custom validation error messages. Within the form editor, one can set
those error messages for all existing validators.


.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.validationerrormessageeditor-properties:

Properties
==========

.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.templatename-validationerrormessageeditor:

templateName
------------

:aspect:`Data type`
string

:aspect:`Needed by`
Backend (form editor)

:aspect:`Mandatory`
Yes

:aspect:`Related options`
- :ref:`TYPO3.CMS.Form.prototypes.\<prototypeIdentifier>.formEditor.formEditorPartials <typo3.cms.form.prototypes.\<prototypeidentifier>.formeditor.formeditorpartials>`

:aspect:`value`
Inspector-ValidationErrorMessageEditor

:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`

:aspect:`Description`
.. include:: properties/TemplateName.rst


.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.identifier-validationerrormessageeditor:
.. include:: properties/Identifier.rst


.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.label-validationerrormessageeditor:
.. include:: properties/Label.rst


.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.propertypath-validationerrormessageeditor:
.. include:: properties/PropertyPath.rst


.. _typo3.cms.form.prototypes.<prototypeidentifier>.formelementsdefinition.<formelementtypeidentifier>.formeditor.editors.*.fieldexplanationtext-validationerrormessageeditor:

fieldExplanationText
--------------------

:aspect:`Data type`
string

:aspect:`Needed by`
Backend (form editor)

:aspect:`Mandatory`
No

.. :aspect:`Related options`
@ToDo
:aspect:`Good to know`
- :ref:`"Inspector"<concepts-formeditor-inspector>`
- :ref:`"Translate form editor settings"<concepts-formeditor-translation-formeditor>`

:aspect:`Description`
A text which is shown at the bottom of the ``inspector editor``.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ formEditor.editors.230
TYPO3.CMS.Form.prototypes.<prototypeIdentifier>.formElementsDefinition.AdvancedPassword.formEditor.editors.230

:aspect:`Data type`
string
array/ :ref:`[TextEditor] <typo3.cms.form.prototypes.\<prototypeidentifier>.formelementsdefinition.\<formelementtypeidentifier>.formeditor.editors.*.texteditor>`

:aspect:`Needed by`
Frontend/ Backend (form editor)
Expand All @@ -14,4 +14,15 @@ formEditor.editors.230
No

:aspect:`Default value (for prototype 'standard')`
Undefined
.. code-block:: yaml
:linenos:
:emphasize-lines: 4-
Date:
formEditor:
editors:
230:
identifier: elementDescription
templateName: Inspector-TextEditor
label: formEditor.elements.FormElement.editor.elementDescription.label
propertyPath: properties.elementDescription
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,3 @@ formEditor.editors.800
validatorIdentifier: NotEmpty
propertyPath: properties.fluidAdditionalAttributes.required
propertyValue: required
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@ formEditor.propertyCollections.validators.10
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@ formEditor.propertyCollections.validators.10.editors.100
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Alphanumeric.editor.header.label
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ formEditor.propertyCollections.validators.10.editors.9999
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@ formEditor.propertyCollections.validators.20
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@ formEditor.propertyCollections.validators.20.editors.100
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.Text.editor.header.label
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ formEditor.propertyCollections.validators.20.editors.9999
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,3 @@ formEditor.propertyCollections.validators.30
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@ formEditor.propertyCollections.validators.30.editors.100
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.StringLength.editor.header.label
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,3 @@ formEditor.propertyCollections.validators.30.editors.200
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.minlength
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,3 @@ formEditor.propertyCollections.validators.30.editors.300
10: Integer
additionalElementPropertyPaths:
10: properties.fluidAdditionalAttributes.maxlength
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ formEditor.propertyCollections.validators.30.editors.9999
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@ formEditor.propertyCollections.validators.40
9999:
identifier: removeButton
templateName: Inspector-RemoveElementEditor
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@ formEditor.propertyCollections.validators.40.editors.100
identifier: header
templateName: Inspector-CollectionElementHeaderEditor
label: formEditor.elements.TextMixin.validators.EmailAddress.editor.header.label

0 comments on commit 6ccbe2f

Please sign in to comment.