Template:Dts

Template documentation

This template uses (or will be using) Lua programming language. Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates.

Dts (date time sorting) is used to correctly sort and display dates in a sortable table (see Help:Sorting).

What it solves

Dates in their customary formats, if simply treated as alphanumeric text strings, sort in nonsensical ways:

• 1/8/2013 sorts alphanumerically before 5/3/1967, because 1 is less than 5;
• February 5, 1922 sorts alphanumerically before January 3, 1922, because F comes before J.

Use of the YYYY-MM-DD format would solve this problem, but with minor exceptions that format is not used in articles (see WP:DATEFORMAT).

This template automatically attaches a "hidden key" to dates, causing them to sort correctly while still being displayed in one of the customary display formats such as February 5, 1922 or 5 Feb 1922.

Parameters

Dates

The year, month and day can either be entered separately or as a single date.

{{dts|year|month|day|BC}}

{{dts|date}}

1st parameter – Year (optional if month is given) Positive number (1 to 999,999,999,999) represent years AD or BC (dependant on the fourth parameter). Negative numbers (−1 to −999,999,999,999) represent years BC (without the fourth parameter). Year numbers must not contain commas or other formatting. 2nd parameter – Month (optional if the day is not given either) Full month name – e.g. February Abbreviated month name – e.g. Feb Month number – (either zero-padded or not) e.g. 2 or 02 3rd parameter – Day (optional) Day number – (either zero-padded or not) e.g. 7 or 07 4th parameter – (optional) May be BC, AD, BCE or CE Used with a positive year number

1st parameter – the full date By default YYYY-MM-DD format becomes month-day-year format while other formats remain in the order they are input. Abbreviated months are accepted and are abbreviated in the output. Capitalisation and comma mistakes are corrected. A single number is interpreted as a year, otherwise the date is parsed by the module. The following formats are accepted: YYYY-MM-DD DD-MM-YYYY DD Month YYYY Month DD, YYYY YYYY-MM DD Month Month DD Month YYYY YYYY Month Day and month numbers may be 1 or 2 digits, and year numbers may only be 3 or 4 digits. If you need to input a number less than 1000, use leading zeroes (e.g. "0700"). BC years can only be parsed if the date is only the year number. If you need to include the day or month for BC years or years greater than 9999, you must use separate parameters for year, month and day.

Examples

input style	input code	hidden sort key	visible output
{{dts|year}}	{{dts|1893}}	Template:Dts/outhide1	01893-01-01-00001893
	{{dts|-89}}	Template:Dts/outhide1	-9911-01-01-000089 BC
	{{dts|-10000}}	Template:Dts/outhide1	-0000-01-01-000010000 BC
{{dts|month}}	{{dts|Oct}}	Template:Dts/outhide	Template:Dts/out
{{dts|month year}}	{{dts|February 1767}}	Template:Dts/outhide	Template:Dts/out
{{dts|day month year}}	{{dts|12 Aug 1987}}	Template:Dts/outhide	Template:Dts/out
{{dts|month day, year}}	{{dts|July 1, 1867}}	Template:Dts/outhide	Template:Dts/out
{{dts|day month}}	{{dts|25 October}}	Template:Dts/outhide	Template:Dts/out
{{dts|month day}}	{{dts|Jan 1}}	Template:Dts/outhide	Template:Dts/out
{{dts|YYYY-MM-DD}}	{{dts|2014-12-09}}	Template:Dts/outhide0	02014-12-09-0000December 9, 2014
{{dts|year|month}}	{{dts|1990|10}}	Template:Dts/outhide1	01990-10-01-0000October 1990
	{{dts|1980|Dec}}	Template:Dts/outhide2	Template:Dts/out2
	{{dts|1970|August}}	Template:Dts/outhide2	Template:Dts/out2
{{dts|year|month|day}}	{{dts|2024|Jun|12}}	Template:Dts/outhide2	Template:Dts/out2
	{{dts|-204|11|22}}	Template:Dts/outhide1	-9796-11-22-0000November 22, 204 BC
{{dts|year|month|day|era}}	{{dts|44|3|15|BC}}	Template:Dts/outhide1	-9956-03-15-0000March 15, 44 BC
	{{dts|94|Oct|17|AD}}	Template:Dts/outhide2	Template:Dts/out2
{{dts||month}}	{{dts||May}}	Template:Dts/outhide2	Template:Dts/out2
{{dts||month|day}}	{{dts||Sep|12}}	Template:Dts/outhide2	Template:Dts/out2

Formatting

Using format produces a format that depends on, but is not necessarily equal to the format of the supplied date. The format parameter can take nine values.

Examples

value	function	input code	hidden sort key	visible output
	format depends on the input	{{dts|26 Jan 1788}}	Template:Dts/outhide	Template:Dts/out
		{{dts|March 12, 1557}}	Template:Dts/outhide	Template:Dts/out
		{{dts|1975-02-13}}	Template:Dts/outhide0	01975-02-13-0000February 13, 1975
dmy	displays the date in day-month-year format	{{dts|Sep 13, 1888|format=dmy}}	Template:Dts/outhide	Template:Dts/outdmy
		{{dts|1983-01-03|format=dmy}}	Template:Dts/outhide0	Template:Dts/outdmy0
dm	displays only the day and month in day-month format	{{dts|Feb 26, 1788|format=dm}}	Template:Dts/outhide	Template:Dts/outdm
		{{dts|2020-10-15|format=dm}}	Template:Dts/outhide0	Template:Dts/outdm0
mdy	displays the date in month-day-year format	{{dts|August 31, 1901|format=mdy}}	Template:Dts/outhide	Template:Dts/outmdy
		{{dts|2006-11-08|format=mdy}}	Template:Dts/outhide0	02006-11-08-0000November 8, 2006
md	displays only the day and month in month-day format	{{dts|26 Jun 1988|format=md}}	Template:Dts/outhide	Template:Dts/outmd
		{{dts|2002-02-27|format=md}}	Template:Dts/outhide0	Template:Dts/outmd0
my	displays only the month and year in month-year format	{{dts|16 November 1488|format=my}}	Template:Dts/outhide	Template:Dts/outmy
d	displays only the day	{{dts|6 July 1666|format=d}}	Template:Dts/outhide	Template:Dts/outd
m	displays only the month	{{dts|1980-02-12|format=m}}	Template:Dts/outhide0	Template:Dts/outm0
y	displays only the year	{{dts|-26|Jan|18|format=y}}	Template:Dts/outhide2	Template:Dts/outy2
hide	hides the date	{{dts|15 October 1800|format=hide}}	Template:Dts/outhide	Template:Dts/outhide

Abbreviation

There are two ways of abbreviating the month name.

1. Directly input an abbreviated month name.
2. Use the abbr=on parameter.

Examples

abbreviation method	input code	hidden sort key	visible output
none	{{dts|2000-01-01}}	Template:Dts/outhide0	02000-01-01-0000January 1, 2000
	{{dts|2000|1|1}}	Template:Dts/outhide1	02000-01-01-0000January 1, 2000
	{{dts|1 January 2000}}	Template:Dts/outhide	Template:Dts/out
	{{dts|2000|January|1}}	Template:Dts/outhide2	Template:Dts/out2
abbreviated input	{{dts|1 Jan 2000}}	Template:Dts/outhide	Template:Dts/out
	{{dts|2000|Jan|1}}	Template:Dts/outhide2	Template:Dts/out2
abbr=on	{{dts|1 January 2000|abbr=on}}	Template:Dts/outhide	Template:Dts/out
	{{dts|2000|January|1|abbr=on}}	Template:Dts/outhide2	Template:Dts/out2
	{{dts|2000-01-01|abbr=on}}	Template:Dts/outhide0	02000-01-01-0000Jan 1, 2000
	{{dts|2000|1|1|abbr=on}}	Template:Dts/outhide1	02000-01-01-0000Jan 1, 2000

Additional sort key

In case two dates in a table are identical they may be ordered using the addkey parameter.

Examples

input code	hidden sort key	visible output
{{dts|2010-10-10|addkey=3}}	Template:Dts/outhide0	02010-10-10-0003October 10, 2010
{{dts|2010-10-09}}	Template:Dts/outhide0	02010-10-09-0000October 9, 2010
{{dts|2010-10-10|addkey=1}}	Template:Dts/outhide0	02010-10-10-0001October 10, 2010
{{dts|2010-10-10}}	Template:Dts/outhide0	02010-10-10-0000October 10, 2010
{{dts|2010-10-10|addkey=4}}	Template:Dts/outhide0	02010-10-10-0004October 10, 2010
{{dts|2010-10-11}}	Template:Dts/outhide0	02010-10-11-0000October 11, 2010
{{dts|2010-10-10|addkey=2}}	Template:Dts/outhide0	02010-10-10-0002October 10, 2010

Wrapping

To turn off the suppression of word wraps, use the nowrap=off parameter.

Notes

Sorting for incomplete dates

Whole months or years

A whole year or month (and year) is sorted according to its first day.

Missing years

If the year is not specified, the date will be sorted as if the year were the current year.

Blank dates

For no date input at all, the maximum possible sort key is used, so the entry will sort last.

Error handling

Entering an invalid date format will (generally) produce an error message such as the one below.

Template:Dts/invalid input

Errors are tracked in Category:Dts templates with errors.

Calendar choice

The template is not capable of distinguishing Julian and Gregorian calendar dates. Also, it is not capable of taking a date in one calendar as input and outputting a date in the other calendar. Thus, to insure proper sorting, editors must either use one calendar for all dates, or pick a specific changeover date (for example, deciding that 4 October 1582 is Julian and all later dates are Gregorian); this would be done on an article-by article basis. Editors are also responsible for explaining to the reader whether the visible dates are Julian or Gregorian, if there is any possibility of confusion.

Linking

The template formerly linked dates automatically, with link=off used to suppress linking. In accordance with current guidelines linking of dates is no longer supported and instances of link=off should be removed. Transclusions using the |link= parameter are tracked in Category:Dts templates with deprecated parameters.

See also

• Template:Tim, since on Meta e.g. 09999 9999 induces numeric sort mode, "&" is prefixed to force string sort mode.
• {{sort}}, sorting by a specified key (also good for complicated numbers, e.g. scientific notation)
• {{sortname}}, full name sorting (using "last name, first name" as default sort key)
• {{tts}}, for sorting times in result tables of athletic events (only needed in certain cases - see template documentation)
• {{mss}}, for sorting times in tables of eclipses
• {{nts}}, for numbers