Template:End date/doc: Difference between revisions
No edit summary |
m stray hyphen |
||
(14 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> |
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> |
||
{{high-use|40000}} |
|||
== Usage == |
== Usage == |
||
Line 12: | Line 13: | ||
Examples: |
Examples: |
||
* |
*{{tlx|End date|1993|2|24}} → "{{End date|1993|2|24}}" |
||
*{{tlx|End date| |
*{{tlx|End date|1993|2|24|08|30}} → "{{End date|1993|2|24|08|30}}" |
||
An optional parameter, df, can be set to "y" or "yes" (or indeed any value) to display the day before the month. This is primarily used in articles about events in parts of the world where the day precedes the month in a date. |
An optional parameter, df, can be set to "y" or "yes" (or indeed any value) to display the day before the month. This is primarily used in articles about events in parts of the world where the day precedes the month in a date. |
||
Line 19: | Line 20: | ||
Examples: |
Examples: |
||
* |
*{{tlx|End date|1993|2|24|df{{=}}yes}} → "{{End date|1993|2|24|df=yes}}" |
||
'''Note:''' The template will appear broken when the parameters are left blank (as seen above). |
|||
=== Parameters === |
=== Parameters === |
||
{{TemplateDataHeader}} |
{{TemplateDataHeader}} |
||
<templatedata>{ |
<templatedata>{ |
||
"description": "Date that an event or entity |
"description": "Date that an event or entity ended or was dissolved", |
||
"params": { |
"params": { |
||
"1": {"label": "YYYY", "description": " |
"1": {"label": "YYYY", "description": "end year", "type": "number"}, |
||
"2": {"label": "MM", "description": " |
"2": {"label": "MM", "description": "end month", "inherits": "1"}, |
||
"3": {"label": "DD", "description": " |
"3": {"label": "DD", "description": "end day of month", "inherits": "1"}, |
||
"4": {"label": "HH", "description": " |
"4": {"label": "HH", "description": "end hours", "inherits": "1"}, |
||
"5": {"label": "MM", "description": " |
"5": {"label": "MM", "description": "end minutes", "inherits": "1", "default": "0"}, |
||
"6": {"label": "SS", "description": " |
"6": {"label": "SS", "description": "end seconds", "inherits": "5"}, |
||
"7": {"label": "TZ", "description": "time zone offset, “+02:00”, “-06:00” or “Z” for UTC", "inherits": "1", "type": "string/line"}, |
"7": {"label": "TZ", "description": "time zone offset, “+02:00”, “-06:00” or “Z” for UTC", "inherits": "1", "type": "string/line"}, |
||
"df": {"label": "day first", "description": "boolean parameter to put the date before the month name", "default": "false", "type": "string/line"} |
"df": {"label": "day first", "description": "boolean parameter to put the date before the month name", "default": "false", "type": "string/line"} |
||
Line 46: | Line 45: | ||
(disable CSS or view source to see the hidden ISO-formatted output). |
(disable CSS or view source to see the hidden ISO-formatted output). |
||
'''Note: due to the requirement exclusive "dtend" in [[hCalendar]], and the accessibility problems that presents when a date is rendered (as seen without CSS) as < |
'''Note: due to the requirement exclusive "dtend" in [[hCalendar]], and the accessibility problems that presents when a date is rendered (as seen without CSS) as <kbd>28 March 1999 (1999-03-29)</kbd> or even <kbd>28 February 1999 (1999-03-01)</kbd> or <kbd>31 December 1999 (2000-01-01)</kbd>, the ''Date end'' template should '''not''' be used for whole-day dates and should have a time of 24:00:00 or 23:59:59.''' |
||
See [[WP:UF|the microformats project]] for further details. |
See [[WP:UF|the microformats project]] for further details. |
||
=== Example === |
|||
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{End date|2016|12|31}}</nowiki>}} |
|||
== See also == |
== See also == |
||
*'''{{tl|Start date}}''' |
*'''{{tl|Start date}}''' |
||
*'''{{tl|Start and end dates}}''' |
|||
*{{tl|trim date}} |
|||
{{Birth, death and age templates|dates}} |
|||
⚫ | |||
<includeonly>{{Sandbox other|| |
|||
<!-- ADD CATEGORIES BELOW THIS LINE --> |
<!-- ADD CATEGORIES BELOW THIS LINE --> |
||
[[Category:Date mathematics templates|{{PAGENAME}}]] |
[[Category:Date mathematics templates|{{PAGENAME}}]] |
||
[[Category:Templates generating hCalendars|{{PAGENAME}}]] |
[[Category:Templates generating hCalendars|{{PAGENAME}}]] |
||
⚫ | |||
<!-- ADD INTERWIKIS BELOW THIS LINE --> |
|||
⚫ | |||
<includeonly> |
|||
[[ca:Plantilla:Data final]] |
|||
[[id:Templat:End date]] |
|||
[[jv:Cithakan:End date]] |
|||
[[ja:Template:End date]] |
|||
[[ka:თარგი:დაასრულე თარიღი]] |
|||
[[simple:Template:End date]] |
|||
[[sl:Predloga:End date]] |
|||
[[sv:Mall:End date]] |
|||
[[zh:Template:End date]] |
|||
</includeonly> |
Latest revision as of 01:21, 24 July 2022
This is a documentation subpage for Template:End date. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 90,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Usage
[edit]This template ({{End date}}) returns a date, or date-time. It also include the same date (and time) duplicated in a hidden (by CSS) ISO date format, for use inside other templates which emit microformats. It should not be used outside such templates. The hidden date degrades gracefully when CSS is not available.
Syntax
[edit]{{End date|year|month|day}}
Examples:
{{End date|1993|2|24}}
→ "February 24, 1993 "{{End date|1993|2|24|08|30}}
→ "08:30, February 24, 1993 "
An optional parameter, df, can be set to "y" or "yes" (or indeed any value) to display the day before the month. This is primarily used in articles about events in parts of the world where the day precedes the month in a date.
Examples:
{{End date|1993|2|24|df=yes}}
→ "24 February 1993 "
Parameters
[edit]TemplateData for End date
Date that an event or entity ended or was dissolved
Parameter | Description | Type | Status | |
---|---|---|---|---|
YYYY | 1 | end year | Number | optional |
MM | 2 | end month | Number | optional |
DD | 3 | end day of month | Number | optional |
HH | 4 | end hours | Number | optional |
MM | 5 | end minutes
| Number | optional |
SS | 6 | end seconds
| Number | optional |
TZ | 7 | time zone offset, “+02:00”, “-06:00” or “Z” for UTC | Line | optional |
day first | df | boolean parameter to put the date before the month name
| Line | optional |
Use in microformats
[edit]The template returns the date as hCalendar's (class="dtend"
). For example:
- (<span class="dtend">1993-02-24T08:30</span>)
(disable CSS or view source to see the hidden ISO-formatted output).
Note: due to the requirement exclusive "dtend" in hCalendar, and the accessibility problems that presents when a date is rendered (as seen without CSS) as 28 March 1999 (1999-03-29) or even 28 February 1999 (1999-03-01) or 31 December 1999 (2000-01-01), the Date end template should not be used for whole-day dates and should have a time of 24:00:00 or 23:59:59.
See the microformats project for further details.
Example
[edit]{{End date|2016|12|31}}
→ December 31, 2016December 31, 2016<span style="display:none"> (<span class="dtend itvend">2016-12-31</span>)</span>
See also
[edit]- {{Start date}}
- {{Start and end dates}}
- {{trim date}}