Modèle:Dts/doc
{{#invoke:Message box|mbox}}
This template is used on many pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
{{#invoke:Message box|mbox}} {{#invoke:Message box|mbox}} {{#invoke:Lua banner|main}}
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 August 2013 sorts alphanumerically before 5 March 1967, because 1 is less than 5;
- February 5, 1922 sorts alphanumerically before 3 janvier 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
{{dts|year|month|day|BC}} | {{dts|date}} |
---|---|
|
|
input style | input code | hidden sort key | visible output |
---|---|---|---|
{{dts|year}} | {{dts|1893}}
|
1893 | 1893 |
{{dts|-89}}
| |||
{{dts|-10000}}
| |||
{{dts|month}} | {{dts|Oct}}
|
Oct | Oct |
{{dts|month year}} | {{dts|February 1767}}
|
February 1767 | February 1767 |
{{dts|day month year}} | {{dts|12 Aug 1987}}
|
12 Aug 1987 | 12 Aug 1987 |
{{dts|month day, year}} | {{dts|July 1, 1867}}
|
July 1, 1867 | July 1, 1867 |
{{dts|day month}} | {{dts|25 October}}
|
25 October | 25 October |
{{dts|month day}} | {{dts|Jan 1}}
|
Jan 1 | Jan 1 |
{{dts|YYYY-MM-DD}} | {{dts|2014-12-09}}
|
2014-12-09 | 2014-12-09 |
{{dts|year|month}} | {{dts|1990|10}}
|
1990 | 1990 |
{{dts|1980|Dec}}
|
1980 | 1980 | |
{{dts|1970|August}}
|
1970 | 1970 | |
{{dts|year|month|day}} | {{dts|2024|Jun|12}}
|
2024 | 2024 |
{{dts|-204|11|22}}
| |||
{{dts|year|month|day|era}} | {{dts|44|3|15|BC}}
|
44 | 44 |
{{dts|94|Oct|17|AD}}
|
94 | 94 | |
{{dts||month}} | {{dts||May}}
|
||
{{dts||month|day}} | {{dts||Sep|12}}
|
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.
value | function | input code | hidden sort key | visible output |
---|---|---|---|---|
format depends on the input | {{dts|26 Jan 1788}}
|
26 Jan 1788 | 26 Jan 1788 | |
{{dts|March 12, 1557}}
|
March 12, 1557 | March 12, 1557 | ||
{{dts|1975-02-13}}
|
1975-02-13 | 1975-02-13 | ||
dmy |
displays the date in day-month-year format | {{dts|Sep 13, 1888|format=dmy}}
|
Sep 13, 1888 | Sep 13, 1888 |
{{dts|1983-01-03|format=dmy}}
|
1983-01-03 | 1983-01-03 | ||
dm |
displays only the day and month in day-month format | {{dts|Feb 26, 1788|format=dm}}
|
Feb 26, 1788 | Feb 26, 1788 |
{{dts|2020-10-15|format=dm}}
|
2020-10-15 | 2020-10-15 | ||
mdy |
displays the date in month-day-year format | {{dts|August 31, 1901|format=mdy}}
|
August 31, 1901 | August 31, 1901 |
{{dts|2006-11-08|format=mdy}}
|
2006-11-08 | 2006-11-08 | ||
md |
displays only the day and month in month-day format | {{dts|26 Jun 1988|format=md}}
|
26 Jun 1988 | 26 Jun 1988 |
{{dts|2002-02-27|format=md}}
|
2002-02-27 | 2002-02-27 | ||
my |
displays only the month and year in month-year format | {{dts|16 November 1488|format=my}}
|
16 November 1488 | 16 November 1488 |
d |
displays only the day | {{dts|6 July 1666|format=d}}
|
6 July 1666 | 6 July 1666 |
m |
displays only the month | {{dts|1980-02-12|format=m}}
|
1980-02-12 | 1980-02-12 |
y |
displays only the year | {{dts|-26|Jan|18|format=y}}
| ||
hide |
hides the date | {{dts|15 October 1800|format=hide}}
|
15 October 1800 | 15 October 1800 |
Abbreviation
There are two ways of abbreviating the month name.
- Directly input an abbreviated month name.
- Use the
abbr=on
parameter.
abbreviation method | input code | hidden sort key | visible output |
---|---|---|---|
none | {{dts|2000-01-01}}
|
2000-01-01 | 2000-01-01 |
{{dts|2000|1|1}}
|
2000 | 2000 | |
{{dts|1 January 2000}}
|
1 January 2000 | 1 January 2000 | |
{{dts|2000|January|1}}
|
2000 | 2000 | |
abbreviated input | {{dts|1 Jan 2000}}
|
1 Jan 2000 | 1 Jan 2000 |
{{dts|2000|Jan|1}}
|
2000 | 2000 | |
abbr=on |
{{dts|1 January 2000|abbr=on}}
|
1 January 2000 | 1 January 2000 |
{{dts|2000|January|1|abbr=on}}
|
2000 | 2000 | |
{{dts|2000-01-01|abbr=on}}
|
2000-01-01 | 2000-01-01 | |
{{dts|2000|1|1|abbr=on}}
|
2000 | 2000 |
Additional sort key
In case two dates in a table are identical they may be ordered using the addkey
parameter.
input code | hidden sort key | visible output |
---|---|---|
{{dts|2010-10-10|addkey=3}}
|
2010-10-10 | 2010-10-10 |
{{dts|2010-10-09}}
|
2010-10-09 | 2010-10-09 |
{{dts|2010-10-10|addkey=1}}
|
2010-10-10 | 2010-10-10 |
{{dts|2010-10-10}}
|
2010-10-10 | 2010-10-10 |
{{dts|2010-10-10|addkey=4}}
|
2010-10-10 | 2010-10-10 |
{{dts|2010-10-11}}
|
2010-10-11 | 2010-10-11 |
{{dts|2010-10-10|addkey=2}}
|
2010-10-10 | 2010-10-10 |
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.
35 June 1900
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
- m:Template:dts (backlinks edit), 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