Template:Date/doc

From MattWiki
Jump to: navigation, search

Description

This template converts a date to one of the standard date formats used on the English Wikipedia. This template should only be used internally in other templates.

If you want sortable dates for a table, use {{Dts}} instead.

Syntax

This template takes up to two parameters, both of which are optional:

{{date|<date to be formatted>|<date formatting style>}}

  • <date to be formatted> is an (optional) date to be formatted.
    If no date is specified, the template emits the current date.
    For example, {{date}} produces 24 September 2017. To avoid emitting the current date if none is input, use Template:fdate.
    If a date is provided, but is not recognized as one, the text is just returned as is. Most dates will however be recognized as such, including all the formats typically used on Wikipedia. Numerous variations thereof are also supported, including abbreviated or lower-case month names; genitive "st", "nd", "rd", "th"; extraneous white space; missing comma etc.
    Notes:
    • Some dates are converted even if they are not real dates, and some dates are not converted even though they are real dates. See known issues below.
    • Only dates within the range 1 January 1000 and 31 December 9999 are supported. Dates with two-digit years will have unexpected results. Other dates outside the range 1000–9999 will be treated as if the second parameter were "none".
  • <date formatting style> controls the date format in which the result is to be emitted. Recognized values for the second parameter are:
    • none applies no formatting whatsoever
    • dmy gives d mmmm yyyy (e.g. 25 December 2011). This is the default format.
    • mdy gives mmmm d, yyyy (e.g. December 25, 2011)
    • ymd gives yyyy mmmm dd (e.g. 2011 December 25)
    • iso gives an ISO 8601 style yyyy-mm-dd (e.g. 2011-12-25)
    If a date to be formatted is provided but no style is specified, the template emits a date in "d month yyyy" format, as it appears (for example) on discussion pages. When no date is specified, then the current date is emitted with no year, either in "d month" format for formatting style dmy, or in "month d" format for formatting styles mdy, ymd and iso.
    Notes:
    • Although these are the four formats supported by MediaWiki's date autoformatting mechanism, only dmy/ldmy and mdy/lmdy are in accordance with the English language Wikipedia's Manual of Style. The use of iso/liso (ISO 8601) format within article prose is expressly discouraged by the Manual of Style; this format should only be used in tables or lists.
    • In each case, the result is exactly the same as what would be emitted by MediaWiki's date autoformatting mechanism.
      However, dates are not manipulated by MediaWiki's date autoformatting mechanism even when linked. This permits dates to have a consistent appearance regardless of whether they are linked or not.
    • Wikipedia caches the current version of pages, and the template may display the date that the page was cached, rather than the current date.

Examples

With valid input

Format Input Output
No format specified {{date|2006-08-04}} 4 August 2006
{{date|Aug 4, 2006}} 4 August 2006
{{date|4 Aug 2006}} 4 August 2006
{{date|4 Aug}} 4 August
{{date|Aug 4}} 4 August
{{date}} 24 September 2017
none format {{date|2006-08-04|none}} 2006-08-04
{{date|Aug 4, 2006|none}} Aug 4, 2006
{{date|4 Aug 2006|none}} 4 Aug 2006
{{date|4 Aug|none}} 4 Aug
{{date|Aug 4|none}} Aug 4
{{date||none}}
dmy format {{date|2006-08-04|dmy}} 4 August 2006
{{date|Aug 4, 2006|dmy}} 4 August 2006
{{date|4 Aug 2006|dmy}} 4 August 2006
{{date|4 Aug|dmy}} 4 August
{{date|Aug 4|dmy}} 4 August
{{date||dmy}} 24 September
mdy format {{date|2006-08-04|mdy}} August 4, 2006
{{date|Aug 4, 2006|mdy}} August 4, 2006
{{date|4 Aug 2006|mdy}} August 4, 2006
{{date|4 Aug|mdy}} August 4
{{date|Aug 4|mdy}} August 4
{{date||mdy}} September 24
ymd format {{date|2006-08-04|ymd}} 2006 August 4
{{date|Aug 4, 2006|ymd}} 2006 August 4
{{date|4 Aug 2006|ymd}} 2006 August 4
{{date|4 Aug|ymd}} August 4
{{date|Aug 4|ymd}} August 4
{{date||ymd}} September 24
iso format {{date|2006-08-04|iso}} 2006-08-04
{{date|Aug 4, 2006|iso}} 2006-08-04
{{date|4 Aug 2006|iso}} 2006-08-04
{{date|4 Aug|iso}} August 4
{{date|Aug 4|iso}} August 4
{{date||iso}} September 24

Other acceptable input

A wide variety of other input formats are handled correctly by the template:

Input Output
{{date|1st December 2008}} (ordinal 'st') 1 December 2008
{{date|June 24 2006}} (missing comma) 24 June 2006
{{date|24 june 2006}} (lowercase month name) 24 June 2006
{{date|24 jun}} (abbreviated month name) 24 June
{{date|June 2006}} June 2006

Invalid input

Input strings that the template cannot format are returned unaltered. This includes strings containing characters such as square brackets, so any links will result in unformatted output.

Input Output
{{date|23007-031-24}} 23007-031-24
{{date|[[1 December]] [[2008]]|ymd}} 1 December 2008
{{date|1 December [[2008 in film|2008]]|mdy}} 1 December 2008

Known issues

Out-of-range values are "fixed"
  • The PHP library that this template ultimately depends on converts out-of-range values to the next-best in-range values. As a result, some date-like values that are not actually valid dates get converted anyway. These include...
    • all dates with zero day-of-the-month. Such a "zero-th" day of a month gets converted into the last day of the previous month.
      For example, {{date|June 0, 2006}} results in 31 May 2006.
      Similarly, {{date|0 January 2006}} becomes 31 December 2005.
    • all dates with day-number values that exceed the number of days in the specified month cause the date to be incremented into the next month.
      For example, {{date|31 November 2008}} results in 1 December 2008, since November has only 30 days.
      Similarly, {{date|February 29, 2007}} results in 1 March 2007, since 2007 was not a leap year.
      Note: Due to a parser peculiarity in the PHP library, 'December 32' and '32 December' are treated differently, and the latter results in an error (which causes this template to emit it unchanged), and only the former "overflows" into the next month.
Non-Gregorian dates are treated as Gregorian
  • The PHP library that this template ultimately depends on assumes that all dates, irrespective of context, are Gregorian calendar dates. Consequently:
    • some dates that would be valid in a non-Gregorian context are treated as out-of-range dates and converted to the next-best in-range values. For example, {{date|30 February 1712}} results in 1 March 1712 because – even though 30 February 1712 is a valid date in the Swedish calendar – February 1712 had only 29 days in the Gregorian calendar.
    • ten dates are not reformatted. These are 29 February & 1 March of the years 1000, 1100, 1300, 1400, 1500. The cause of this is the same as that of the Swedish 30 February 1712.
    • some dates that would not be valid in some contexts are converted normally. For example, 29 February 1912 or 1 February 1918 are not valid in a Russian context, but perfectly valid in the Gregorian one.
ISO 8601 format not suitable for years before 1583

The ISO 8601 standard requires mutual agreement between those using the format to use years earlier than 1583. Since no agreement has been obtained from our readers, that format should not be used for such years, nor for any date not in the Gregorian calendar.

Does not provide Microformats

See also