Template:Start and end dates/doc
This is a documentation subpage for Template:Start and end dates. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on many 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. |
This template should not be used in citation templates such as Citation Style 1 because it includes markup that will pollute the COinS metadata they produce; see Wikipedia:COinS. |
This purpose of the {{start and end dates}} template is to return the date range during which an event transpired or an entity existed. It also includes duplicate, machine-readable date (or date-time) in the ISO date format (which is hidden by CSS), for use inside other templates (or table rows) which emit microformats. It should be used only once in each such template and never used outside such templates. The hidden date degrades gracefully when CSS is not available.
Usage
When not to use this template
Do not use this template for:
- dates that are uncertain e.g., "before 4 April 1933"; "around 18 November 1939".
- dates outside the range given under "Limitation", below.
- other, secondary dates
- outside microformat-emitting templates - if in doubt, see the parent template's documentation
- more than one date in any parent template
Syntax
{{start and end dates|year|month|day|year|month|day}}
- Examples
- Standard:
{{start and end dates|1939|9|1|1945|9|2}}
→ September 1, 1939 – September 2, 1945 - Day first:
{{start and end dates|1939|9|1|1945|9|2|df=yes}}
→ 1 September 1939 – 2 September 1945 - Same year:
{{start and end dates|1939|9|1|1939|10|2}}
→ September 1 – October 2, 1939 - Same month and year:
{{start and end dates|1939|9|1|1939|9|2}}
→ September 1–2, 1939 - Present range:
{{start and end dates|1939|9|1|present}}
→ September 1, 1939 – present
Parameters
TemplateData for Start and end dates
<templatedata>{ "description": "Date that an event or entity started or was created and when it ended or was destroyed", "params": { "1": {"label": "YYYY", "description": "start year", "example": "1939", "type": "number"}, "2": {"label": "MM", "description": "start month", "example": "9", "inherits": "1"}, "3": {"label": "DD", "description": "start day of month","example": "1", "inherits": "1"}, "4": {"label": "YYYY", "description": "end year", "example": "1945", "type": "number"}, "5": {"label": "MM", "description": "end month", "example": "9", "inherits": "1"}, "6": {"label": "DD", "description": "end day of month", "example": "2", "inherits": "1"}, "df": {"label": "day first", "description": "boolean parameter to put the date before the month name", "default": "false", "example": "yes", "type": "string/line"} }}</templatedata>
Use in microformats
This template also returns the date, hidden by CSS, in the ISO 8601 format needed by one or more of the following microformats:
usually, but not always, within infobox or similar templates, or tables.
Its use in hCard is for organizations, venues and similar; use {{Birth date}} or {{Birth date and age}} for people.
Similarly, {{End date}} returns the date as hCalendar's (class="dtend"
).
Limitation
This template has no provision to deal with a date in a non-Gregorian calendar. Also, ISO 8601 requires mutual agreement among those exchanging information before using years outside the range 1583–9999 CE. Therefore, use of this template for non-Gregorian dates or dates outside that range constitutes a false claim of conformance to the ISO 8601 standard.
Any editor encountering such usage should change the date to plain text with no template; or if not confident in doing so, raise the matter on this template's talk page.
See also
- {{start date}}
- {{end date}}