Difference between revisions of "Template:End date/doc"
imported>Materialscientist m (Reverted edits by Stewartvinrese (talk) to last version by Crissov) |
imported>Sroc (→Parameters: end, not start) |
||
| Line 26: | Line 26: | ||
{{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"} | ||
Revision as of 13:48, 17 December 2014
| 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. |
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}}→ "24 February 1993"
Note: The template will appear broken when the parameters are left blank (as seen above).
Parameters
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
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.
See also
- {{Start date}}