[TASK] EXT:form - Update documentation
[Packages/TYPO3.CMS.git] / typo3 / sysext / form / Documentation / Configuration / Rules / Date / Index.rst
1 .. include:: ../../../Includes.txt
2
3
4 .. _reference-rules-date:
5
6 ====
7 date
8 ====
9
10 Checks if the submitted value is a valid date, and the format is equal to
11 the one set in TypoScript.
12
13 The format configuration is like the PHP strftime() conversion specifiers.
14 The message shown to the visitor supports the format as well, but will be
15 shown to the visitor in a human readable way.
16 %e-%m-%Y becomes d-mm-yyyy in English.
17
18
19 .. _reference-rules-date-element:
20
21 element
22 =======
23
24 :aspect:`Description:`
25     See general information for :ref:`reference-validation-attributes-element`.
26
27
28 .. _reference-rules-date-error:
29
30 error
31 =====
32
33 :aspect:`Description:`
34     See general information for :ref:`reference-validation-attributes-error`.
35
36 :aspect:`Default:`
37     *local language:*"The value does not appear to be a valid date"
38
39
40 .. _reference-rules-date-format:
41
42 format
43 ======
44
45 :aspect:`Property:`
46     format
47
48 :aspect:`Data type:`
49     strftime-conf
50
51 :aspect:`Description:`
52     The format of the submitted data.
53
54     See the PHP-manual (strftime) for the codes, or datatype "strftime-conf"
55     in the TYPO3 document TSref.
56
57 :aspect:`Default:`
58     %e-%m-%Y
59
60
61 .. _reference-rules-date-message:
62
63 message
64 =======
65
66 :aspect:`Description:`
67     See general information for :ref:`reference-validation-attributes-message`.
68
69     The %format marker will be replaced with a human readable format.
70     %e-%m-%Y becomes d-mm-yyyy in English.
71
72 :aspect:`Default:`
73     *local language:*"(%format)"
74
75
76 .. _reference-rules-date-showmessage:
77
78 showMessage
79 ===========
80
81 :aspect:`Description:`
82     See general information for :ref:`reference-validation-attributes-showmessage`.
83
84 [tsref:(cObject).FORM->rules.date]
85