Template:End date/doc: Difference between revisions
NARA>CWenger m (stray hyphen) |
(No difference)
|
Revision as of 20:21, 23 July 2022
File:OOjs UI icon book-ltr.svg | This is a documentation subpage for Template:End date. It contains usage information, categories and other content that is not part of the original Template page. |
[[Category:Template documentation pages{{#translation:}}]]
File:Ambox warning yellow.svg | This template is used on approximately 79,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
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
- {{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
This is the TemplateData documentation for this template used by VisualEditor and other tools.
End date
[[Category:TemplateData documentation{{#translation:}}]]
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
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
{{End date|2016|12|31}}
→ December 31, 2016December 31, 2016<span style="display:none"> (<span class="dtend">2016-12-31</span>)</span>
See also
- {{Start date}}
- {{Start and end dates}}
- {{trim date}}