Difference between revisions of "Template:Dts/doc"

From Timelines
Jump to: navigation, search
(Output: additional sort key)
 
(39 intermediate revisions by 11 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
'''{{PAGENAME}}''' stands for <big>'''D'''</big>ate <big>'''T'''</big>able <big>'''S'''</big>orting and is used to correctly sort and display dates in a sortable table (see [[Help:Sorting]]).
+
{{High-use|20200+}}
 +
{{Mbox|type=content|text=Please check that you do actually need this template before using it. Default date sorting does not work for spelled-out month–year or year–month combos and dates before the year 100, but it works in most other circumstances. Furthermore, this template litters the [[devmo:Web/API/Node/textContent|text content]] of tables, and <code>data-sort-value</code> should generally be preferred. For more information, see {{Section link|Help:Sorting|Date sorting problems}}.}}
 +
{{COinS safe|n}}
 +
{{lua|Module:Dts}}
 +
 
 +
'''Dts''' (date time sorting) is used to correctly sort and display dates in a sortable table (see [[Help:Sorting]]).
  
 
==What it solves==
 
==What it solves==
Normally, for proper sorting, dates must be entered in YYYY-MM-DD format. However, that format does not conform to the [[MOS:DATE|Manual of Style]] for date display. This template automatically creates the hidden <code><nowiki><span&nbsp;style="display:none">1776-07-04</span></nowiki></code> for sorting purposes and then displays the date like this: '''July 4, 1776'''. To hide the output, use the {{tl|dtsh}} template instead.
+
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]]).
  
==Calendar choice==
+
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''.
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.
 
  
 
==Parameters==
 
==Parameters==
{{notice|1=Date display can be modified using two named parameters.
+
===Dates===
*To use international date formats, use the <code>format=dmy</code> parameter.
 
*To turn off the suppression of word wraps, use the <code>nowrap=off</code> parameter.
 
}}
 
 
 
 
{|class=wikitable
 
{|class=wikitable
 
|-
 
|-
 
|+The year, month and day can either be entered separately or as a single date.
 
|+The year, month and day can either be entered separately or as a single date.
 
|-
 
|-
!width=50%|{{tlf|dts|''year''|''month''|''day''|''BC''}}
+
! style="width: 50%;" |{{tlf|dts|''year''|''month''|''day''|''BC''}}
!width=50%|{{tlf|dts|''date''}}
+
! style="width: 50%;" |{{tlf|dts|''date''}}
|-valign=top
+
|- style="vertical-align:top;"
 
|
 
|
*1st parameter – Year (optional if month is given)
+
* 1st parameter – Year (optional if month is given)
**Year number – number in the range -9999 through 9999: the numbers -9999 through 0 are used without "bc" and represent astronomical years -9999 through 0, the numbers 1 through 9999 represent that year AD, or BC with the fourth parameter set to bc or BC
+
** Positive number (1 to 999,999,999,999) represent years AD or BC (dependant on the fourth parameter).
*2nd parameter – Month (optional if the day is not given either)
+
** Negative numbers (−1 to −999,999,999,999) represent years BC (without the fourth parameter).
**Full month name – February or february
+
** Year numbers must not contain commas or other formatting.
**Abbreviated month name – Feb or feb
+
* 2nd parameter – Month (optional if the day is not given either)
**Month number – 2 or 02
+
** Full month name – e.g. February
*3rd parameter – Day (optional)
+
** Abbreviated month name – e.g. Feb
**Day number – 7 or 07
+
** Month number – (either zero-padded or not) e.g. 2 or 02
*4th parameter – optional with value BC or bc
+
* 3rd parameter – Day (optional)
**Used with a positive year number
+
** Day number – (either zero-padded or not) e.g. 7 or 07
 
+
* 4th parameter – (optional)
Thus e.g. for the year 5 BC we can use "5|bc" or "-4".
+
** May be BC, AD, BCE or CE
 
+
** Used with a positive year number
A time period (year or month and year) is sorted according to its start, and time periods with the same starting moment are in order of descending length: a year comes before its first month; a month comes before its first day.
 
 
|
 
|
*1st parameter – the full date in international, US or YYYY-MM-DD format
+
* 1st parameter – the full date
**It uses {{[[mw:Help:Extension:ParserFunctions#.23time:|#time:]]}} and so is limited to what the parser function can handle (e.g. it won't go beyond 100 AD).
+
** By default YYYY-MM-DD format becomes month-day-year format while other formats remain in the order they are input.
**International format is left as it is. YYYY-MM-DD format defaults to US format.
+
** Abbreviated months are accepted and are abbreviated in the output.
**Abbreviated months are accepted.
+
** Capitalisation and comma mistakes are corrected.
**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.
 
|}
 
|}
  
===Input===
 
{{tlf|dts|''year''|''month''|''day''|''BC''}}
 
*{{<code>dts|1776|July|4</code>}}
 
{{tlf|dts|''date''}}
 
*{{<code>dts|1776-07-04</code>}}
 
*{{<code>dts|July 4, 1776</code>}}
 
*{{<code>dts|4 July 1776</code>}}
 
  
When supplying a single parameter for the date, it is accepted and interpreted according to the  [http://www.php.net/manual/en/datetime.formats.php php date/time format], except that a single number is interpreted as a year. By default the date is shown as supplied. If the first parameter is not just the year, but no format parameter is supplied, due to a call of function <code>#time</code> the maximum number of calls of this template on a page is 1200.
+
{| class="wikitable sortable"
 +
|+ Examples
 +
!input style
 +
!input code
 +
!hidden sort key
 +
!visible output
 +
{{dts/testcases/row|span=3|a={{tlf|dts|''year''}}|1893}}
 +
{{dts/testcases/row|-89}}
 +
{{dts/testcases/row|-10000}}
 +
{{dts/testcases/row|a={{tlf|dts|''month''}}|Oct}}
 +
{{dts/testcases/row|a={{tlf|dts|''month year''}}|February 1767}}
 +
{{dts/testcases/row|a={{tlf|dts|''day month year''}}|12 Aug 1987}}
 +
{{dts/testcases/row|a={{tlf|dts|''month day, year''}}|July 1, 1867}}
 +
{{dts/testcases/row|a={{tlf|dts|''day month''}}|25 October}}
 +
{{dts/testcases/row|a={{tlf|dts|''month day''}}|Jan 1}}
 +
{{dts/testcases/row|a={{tlf|dts|''YYYY-MM-DD''}}|2014-12-09}}
 +
{{dts/testcases/row|span=3|a={{tlf|dts|''year''|''month''}}|1990|10}}
 +
{{dts/testcases/row|1980|Dec}}
 +
{{dts/testcases/row|1970|August}}
 +
{{dts/testcases/row|span=2|a={{tlf|dts|''year''|''month''|''day''}}|2024|Jun|12}}
 +
{{dts/testcases/row|-204|11|22}}
 +
{{dts/testcases/row|span=2|a={{tlf|dts|''year''|''month''|''day''|''era''}}|44|3|15|BC}}
 +
{{dts/testcases/row|94|Oct|17|AD}}
 +
{{dts/testcases/row|a={{tlf|dts||''month''}}||May}}
 +
{{dts/testcases/row|a={{tlf|dts||''month''|''day''}}||Sep|12}}
 +
|}
  
Using <code>format</code> produces a format that depends on, but is not necessarily equal to the format of the supplied date. This requires multiple calls of function <code>#time</code>, reducing the maximum number of calls of this template on a page in the worst case to 88, see below.
+
===Formatting===
 +
Using <code>format</code> produces a format that depends on, but is not necessarily equal to the format of the supplied date. The <code>format</code> parameter can take nine values.
  
Also see the [[#Examples|examples]] below.
+
{|class="wikitable sortable"
 +
|+ Examples
 +
|-
 +
!value
 +
!function
 +
!input code
 +
!hidden sort key
 +
!visible output
 +
{{dts/testcases/row|span=3|a=&nbsp;|b=format depends on the input|26 Jan 1788}}
 +
{{dts/testcases/row|March 12, 1557}}
 +
{{dts/testcases/row|1975-02-13}}
 +
{{dts/testcases/row|span=2|a=<code>dmy</code>|b=displays the date in day-month-year format|Sep 13, 1888|format=dmy}}
 +
{{dts/testcases/row|1983-01-03|format=dmy}}
 +
{{dts/testcases/row|span=2|a=<code>dm</code>|b=displays only the day and month in day-month format|Feb 26, 1788|format=dm}}
 +
{{dts/testcases/row|2020-10-15|format=dm}}
 +
{{dts/testcases/row|span=2|a=<code>mdy</code>|b=displays the date in month-day-year format|August 31, 1901|format=mdy}}
 +
{{dts/testcases/row|2006-11-08|format=mdy}}
 +
{{dts/testcases/row|span=2|a=<code>md</code>|b=displays only the day and month in month-day format|26 Jun 1988|format=md}}
 +
{{dts/testcases/row|2002-02-27|format=md}}
 +
{{dts/testcases/row|a=<code>my</code>|b=displays only the month and year in month-year format|16 November 1488|format=my}}
 +
{{dts/testcases/row|a=<code>d</code>|b=displays only the day|6 July 1666|format=d}}
 +
{{dts/testcases/row|a=<code>m</code>|b=displays only the month|1980-02-12|format=m}}
 +
{{dts/testcases/row|a=<code>y</code>|b=displays only the year|-26|Jan|18|format=y}}
 +
{{dts/testcases/row|a=<code>hide</code>|b=hides the date|15 October 1800|format=hide}}
 +
|}
  
===Output===
+
===Abbreviation===
Output sent to table
+
There are two ways of abbreviating the month name.
*<code><nowiki><span style="display:none">01776-07-04-0000</span> July 4, 1776</nowiki></code> or
+
# Directly input an abbreviated month name.
*<code><nowiki><span style="display:none">01776-07-04-0000</span> 4 July 1776</nowiki></code>
+
# Use the <code>abbr=on</code> parameter.
  
Output displayed to user<br>
+
{|class="wikitable sortable"
*July 4, 1776 or
+
|+ Examples
*4 July 1776
+
|-
 +
!abbreviation method
 +
!input code
 +
!hidden sort key
 +
!visible output
 +
{{dts/testcases/row|span=4|a=none|2000-01-01}}
 +
{{dts/testcases/row|2000|1|1}}
 +
{{dts/testcases/row|1 January 2000}}
 +
{{dts/testcases/row|2000|January|1}}
 +
{{dts/testcases/row|span=2|a=abbreviated input|1 Jan 2000}}
 +
{{dts/testcases/row|2000|Jan|1}}
 +
{{dts/testcases/row|span=4|a=<code>abbr{{=}}on</code>|1 January 2000|abbr=on}}
 +
{{dts/testcases/row|2000|January|1|abbr=on}}
 +
{{dts/testcases/row|2000-01-01|abbr=on}}
 +
{{dts/testcases/row|2000|1|1|abbr=on}}
 +
|}
  
===Linking===
+
===Additional sort key===
The template formerly linked dates automatically. To turn linking off the parameter <code>link=off</code> was used. In accordance with current guidelines linking is no longer supported. Please do not use this parameter. Please remove it from existing transclusions.
+
In case two dates in a table are identical they may be ordered using the <code>addkey</code> parameter.
  
==Examples==
+
{|class="wikitable sortable"
{|class=wikitable
+
|+ Examples
 
|-
 
|-
!Normal function of the template.
+
!input code
!The template with <code>debug=yes</code>, which causes hidden parts to appear:
+
!hidden sort key
|-valign=top
+
!visible output
|
+
{{dts/testcases/row|2010-10-10|addkey=3}}
{{dts/examples}}
+
{{dts/testcases/row|2010-10-09}}
|
+
{{dts/testcases/row|2010-10-10|addkey=1}}
{{dts/examples|debug=yes}}
+
{{dts/testcases/row|2010-10-10}}
 +
{{dts/testcases/row|2010-10-10|addkey=4}}
 +
{{dts/testcases/row|2010-10-11}}
 +
{{dts/testcases/row|2010-10-10|addkey=2}}
 
|}
 
|}
  
==Abbreviating the month name==
+
===Wrapping===
The template displays the name of the month either in abbreviated form or fully spelt out.  There are two ways of controlling which is used.
+
To turn off the suppression of word wraps, use the <code>nowrap=off</code> parameter.
#Directly input the desired format.
 
#Use the <code>abbr</code> parameter.
 
Note that the method to use is determined by the input.  The first method works wherever the second method fails and only in these cases.  The following explains which method to use.
 
  
;All numeric input
+
==Notes==
If the month is input as a number, the default is to spell it out in full. 
+
===Sorting for incomplete dates===
*{{<code>dts|2000-01-01</code>}} gives "{{dts|2000-01-01}}"
+
;Whole months or years: A whole year or month (and year) is sorted according to its first day.
*{{<code>dts|2000|1|1</code>}} gives "{{dts|2000|1|1}}"
+
;Missing years: If the year is not specified, the date will be sorted as if the year were the current year.
In this case the month can be abbreviated by setting <code>abbr</code> to <code>on<code>.
+
;Blank dates: For no date input at all, the maximum possible sort key is used, so the entry will sort last.
*{{<code>dts|2000-01-01|abbr=on</code>}} gives "{{dts|2000-01-01|abbr=on}}"
 
*{{<code>dts|2000|1|1|abbr=on</code>}} gives "{{dts|2000|1|1|abbr=on}}"
 
  
;Entering a non-numeric month as the second unnamed parameter
+
===Error handling===
The name of the month either in abbreviated form or fully spelt out when input as the second unnamed parameter.  In either case the output form is equivalent to the input form.
+
Entering an invalid date format will (generally)<!--It's not quite perfect.--> produce an error message such as the one below.
*{{<code>dts|2000|January|1</code>}} gives "{{dts|2000|January|1}}"
+
<blockquote>{{dts|35 June 1900}}</blockquote>
*{{<code>dts|2000|Jan|1</code>}} gives "{{dts|2000|Jan|1}}"
 
  
;The whole date as a single parameter with a non-numeric month
+
Errors are tracked in [[:Category:Dts templates with errors]].
The if the whole date is entered as a single parameter with a non-numeric month, the default is to display the date as input.  In this case either abbreviate or fully spelt out he name of the month as desired.
 
*{{<code>dts|1 January 2000</code>}} gives "{{dts|1 January 2000}}"
 
*{{<code>dts|1 Jan 2000</code>}} gives "{{dts|1 Jan 2000}}"
 
Using the <code>format</code> parameter overrides this default behaviour and the month name is spelt out in full by default. In this case the month can be abbreviated by setting <code>abbr</code> to <code>on<code>.
 
*{{<code>dts|1 January 2000</code>|format=my}} gives "{{dts|1 January 2000|format=my}}"
 
*{{<code>dts|1 Jan 2000|format=my</code>}} gives "{{dts|1 Jan 2000|format=my}}"
 
*{{<code>dts|1 January 2000</code>|format=my|abbr=on}} gives "{{dts|1 January 2000|format=my|abbr=on}}"
 
*{{<code>dts|1 Jan 2000|format=my|abbr=on</code>}} gives "{{dts|1 Jan 2000|format=my|abbr=on}}"
 
  
==Error handling==
+
===Calendar choice===
Entering an invalid date format will (generally)<!--It's not quite perfect.--> produce an error message such as the one below.
+
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.
<blockquote>{{dts|35 June 1900}}</blockquote>
+
 
 +
===Linking===
 +
The template formerly linked dates automatically, with <code>link=off</code> used to suppress linking. In accordance with current guidelines linking of dates is no longer supported and instances of <code>link=off</code> should be removed. Transclusions using the {{para|link}} parameter are tracked in [[:Category:Dts templates with deprecated parameters]].
  
 
==See also==
 
==See also==
* {{tl|dtsh}}, hides the template's output
 
* {{tl|TBA}}, allows quarters, and allows sorting of time periods by end date.
 
 
* {{tim|dts}}, since on Meta e.g. 09999 9999 induces numeric sort mode, "&" is prefixed to force string sort mode.
 
* {{tim|dts}}, since on Meta e.g. 09999 9999 induces numeric sort mode, "&" is prefixed to force string sort mode.
 
* {{tl|sort}}, sorting by a specified key (also good for complicated numbers, e.g. scientific notation)
 
* {{tl|sort}}, sorting by a specified key (also good for complicated numbers, e.g. scientific notation)
Line 124: Line 186:
 
* {{tl|tts}}, for sorting times in result tables of athletic events (only needed in certain cases - see template documentation)
 
* {{tl|tts}}, for sorting times in result tables of athletic events (only needed in certain cases - see template documentation)
 
* {{tl|mss}}, for sorting times in tables of eclipses
 
* {{tl|mss}}, for sorting times in tables of eclipses
 +
* {{tl|nts}}, for numbers
  
<includeonly>
+
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- ADD CATEGORIES BELOW THIS LINE -->
+
<!-- Categories below this line, please; interwikis at Wikidata -->
 
[[Category:Sorting templates|Dts]]
 
[[Category:Sorting templates|Dts]]
[[Category:Date mathematics templates|{{PAGENAME}}]]
+
[[Category:Date mathematics templates]]
<!-- ADD INTERWIKIS BELOW THIS LINE -->
+
 
</includeonly>
+
}}</includeonly>

Latest revision as of 12:28, 27 July 2016

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}} 1893
{{dts|-89}} 89 BC
{{dts|-10000}} 10,000 BC
{{dts|month}} {{dts|Oct}} Oct
{{dts|month year}} {{dts|February 1767}} February 1767
{{dts|day month year}} {{dts|12 Aug 1987}} 12 Aug 1987
{{dts|month day, year}} {{dts|July 1, 1867}} July 1, 1867
{{dts|day month}} {{dts|25 October}} 25 October
{{dts|month day}} {{dts|Jan 1}} Jan 1
{{dts|YYYY-MM-DD}} {{dts|2014-12-09}} December 9, 2014
{{dts|year|month}} {{dts|1990|10}} October 1990
{{dts|1980|Dec}} Dec 1980
{{dts|1970|August}} August 1970
{{dts|year|month|day}} {{dts|2024|Jun|12}} Jun 12, 2024
{{dts|-204|11|22}} November 22, 204 BC
{{dts|year|month|day|era}} {{dts|44|3|15|BC}} March 15, 44 BC
{{dts|94|Oct|17|AD}} Oct 17, 94
{{dts||month}} {{dts||May}} May
{{dts||month|day}} {{dts||Sep|12}} 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.

Examples
value function input code hidden sort key visible output
  format depends on the input {{dts|26 Jan 1788}} 26 Jan 1788
{{dts|March 12, 1557}} March 12, 1557
{{dts|1975-02-13}} February 13, 1975
dmy displays the date in day-month-year format {{dts|Sep 13, 1888|format=dmy}} 13 Sep 1888
{{dts|1983-01-03|format=dmy}} 3 January 1983
dm displays only the day and month in day-month format {{dts|Feb 26, 1788|format=dm}} 26 Feb
{{dts|2020-10-15|format=dm}} 15 October
mdy displays the date in month-day-year format {{dts|August 31, 1901|format=mdy}} August 31, 1901
{{dts|2006-11-08|format=mdy}} November 8, 2006
md displays only the day and month in month-day format {{dts|26 Jun 1988|format=md}} Jun 26
{{dts|2002-02-27|format=md}} February 27
my displays only the month and year in month-year format {{dts|16 November 1488|format=my}} November 1488
d displays only the day {{dts|6 July 1666|format=d}} 6
m displays only the month {{dts|1980-02-12|format=m}} February
y displays only the year {{dts|-26|Jan|18|format=y}} 26 BC
hide hides the date {{dts|15 October 1800|format=hide}}

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}} January 1, 2000
{{dts|2000|1|1}} January 1, 2000
{{dts|1 January 2000}} 1 January 2000
{{dts|2000|January|1}} January 1, 2000
abbreviated input {{dts|1 Jan 2000}} 1 Jan 2000
{{dts|2000|Jan|1}} Jan 1, 2000
abbr=on {{dts|1 January 2000|abbr=on}} 1 Jan 2000
{{dts|2000|January|1|abbr=on}} Jan 1, 2000
{{dts|2000-01-01|abbr=on}} Jan 1, 2000
{{dts|2000|1|1|abbr=on}} Jan 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}} October 10, 2010
{{dts|2010-10-09}} October 9, 2010
{{dts|2010-10-10|addkey=1}} October 10, 2010
{{dts|2010-10-10}} October 10, 2010
{{dts|2010-10-10|addkey=4}} October 10, 2010
{{dts|2010-10-11}} October 11, 2010
{{dts|2010-10-10|addkey=2}} October 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.

Error in Template:Dts: days must be an integer between 1 and 31

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