Template:Dts/doc

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

What it solves
Normally, for proper sorting, dates must be entered in YYYY-MM-DD format. However, that format does not conform to the Manual of Style for date display. This template automatically creates the hidden key for sorting purposes whilst displaying the date in an alternative format (e.g. day-month-year).

Formatting
Using  produces a format that depends on, but is not necessarily equal to the format of the supplied date. This requires multiple calls of function, reducing the maximum number of calls of this template on a page in the worst case to 88, see below. The  parameter can take nine values.

Abbreviation
There are two ways of abbreviating the month name.
 * 1) Directly input an abbreviated month name.
 * 2) Use the   parameter.

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

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

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.

Error handling
Entering an invalid date format will (generally) produce an error message such as the one below. "35 June 1900"

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. To turn linking off the parameter  was used. In accordance with current guidelines linking is no longer supported. Please do not use this parameter. Please remove it from existing transclusions.