Template:Start and end dates/doc

From Nordic Larp Wiki
Jump to navigation Jump to search

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

Example: {{start and end dates|1939|9|1|1945|9|2}} → September 1, 1939 – September 2, 1945 (1939-09-01 – 1945-09-02)

Example (day first): {{start and end dates|1939|9|1|1945|9|2|df=yes}} → 1 September 1939 – 2 September 1945 (1939-09-01 – 1945-09-02)

Parameters

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Start and end dates

Date that an event or entity started or was created and when it ended or was destroyed

Template parameters

ParameterDescriptionTypeStatus
YYYY1

start year

Example
1939
Numberoptional
MM2

start month

Example
9
Numberoptional
DD3

start day of month

Example
1
Numberoptional
YYYY4

end year

Example
1945
Numberoptional
MM5

end month

Example
9
Numberoptional
DD6

end day of month

Example
2
Numberoptional
day firstdf

boolean parameter to put the date before the month name

Default
false
Example
yes
Lineoptional

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").

See the microformats project for further details.

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