Template:Start date/doc

From NARA
< Template:Start date
Revision as of 06:51, 2 October 2022 by NARA>Pigsonthewing (c)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

[[Category:Template documentation pages{{#translation:}}]]

This purpose of the {{start date}} template is to return the date (or date-time) that an event or entity started or was created, and to do so in a standard format. 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.

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 or table rows - if in doubt, see the parent template's documentation
  • more than one date in any parent template
  • dates displayed using AM/PM format - this template only outputs 24-hour clocks

Syntax

  • {{start date|year|month|day}}
  • {{start date|year|month|day|HH|MM|SS|...}} (MM and SS are optional; TimeZone may be a numerical value, or "Z" for UTC; see examples)
Examples
  • {{start date|1993}} → "1993 (1993)"
  • {{start date|1993|02}} → "February 1993 (1993-02)"
  • {{start date|1993|02|24}} → "February 24, 1993 (1993-02-24)"
  • {{start date|1993|02|24|08|30}} → "08:30, February 24, 1993 (1993-02-24T08:30)"
  • {{start date|1993|02|24|08|||+01:00}} → "February 24, 1993 (+01:00) (1993-02-24T08+01:00)"
  • {{start date|1993|02|24|08|||−07:00}} → "February 24, 1993 (−07:00) (1993-02-24T08−07:00)"
  • {{start date|1993|02|24|08|30|23}} → "08:30:23, February 24, 1993 (1993-02-24T08:30:23)"
  • {{start date|1993|02|24|08|30|23|...}} → "08:30:23, February 24, 1993 (UTC) (1993-02-24T08:30:23Z)"
  • {{start date|1993|02|24|08|30|23|...}} → "08:30:23, February 24, 1993 (+01:00) (1993-02-24T08:30:23+01:00)"
  • {{start date|1993|02|24|08|30|23|...}} → "08:30:23, February 24, 1993 (−07:00) (1993-02-24T08:30:23−07:00)"

An optional parameter, df, can be set to "y" or "yes" (or indeed any value) to display the day before the month. The order of parameters does not change (it remains YMD). This is primarily used in articles using DMY format for dates.

Examples
  • {{start date|1993|02|24|df=y}} → "24 February 1993 (1993-02-24)"
  • {{start date|1993|02|24|08|30|df=yes}} → "08:30, 24 February 1993 (1993-02-24T08:30)"

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Start date

[[Category:TemplateData documentation{{#translation:}}]]

Date that an event or entity started or was created

Template parameters

ParameterDescriptionTypeStatus
YYYY1

start year

Numberoptional
MM2

start month

Numberoptional
DD3

start day of month

Numberoptional
HH4

start hours

Numberoptional
MM5

start minutes

Default
0
Numberoptional
SS6

start seconds

Default
0
Numberoptional
TZ7

time zone offset, “+02:00”, “-06:00” or “Z” for UTC

Lineoptional
day firstdf

boolean parameter to put the day before the month name

Default
false
Lineoptional
month firstmf

mf=yes: order mm-dd-yyyy (=the default order)

Default
yes
Stringdeprecated

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.

Example

  • {{Start date|2016|12|31}} → December 31, 2016 (2016-12-31)
    December&nbsp;31,&nbsp;2016<span style="display:none">&#160;(<span class="bday dtstart published updated">2016-12-31</span>)</span>

See also