Template:Dts

From Wikibooks, open books for an open world
Jump to: navigation, search
[edit] [history] [purge] Template documentation

Dts stands for Date Table Sorting and is used to correctly sort and display dates in a sortable table (see Help:Tables#Sortable_tables).

What it solves

Normally, for proper sorting, dates must be entered in YYYY-MM-DD format. However, that format does not conform to the many books' manuals of style for date display. This template automatically creates the hidden <span style="display:none">1776-07-04</span> for sorting purposes and then displays the date like this: July 4, 1776. To hide the output, use the {{dtsh}} template instead.

Parameters

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)
    • 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
  • 2nd parameter – Month (optional if the day is not given either)
    • Full month name – February or february
    • Abbreviated month name – Feb or feb
    • Month number – 2 or 02
  • 3rd parameter – Day (optional)
    • Day number – 7 or 07
  • 4th parameter – optional with value BC or bc
    • Used with a positive year number

Thus e.g. for the year 5 BC we can use "5|bc" or "-4".

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
    • It uses {{#time:}} and so is limited to what the parser function can handle (e.g. it won't go beyond 100 AD).
    • International format is left as it is. YYYY-MM-DD format defaults to US format.
    • Abbreviated months are accepted.
    • Capitalisation and comma mistakes are corrected.

Input

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

  • {{dts|1776|July|4}}

{{dts|date}}

  • {{dts|1776-07-04}}
  • {{dts|July 4, 1776}}
  • {{dts|4 July 1776}}

When supplying a single parameter for the date, it is accepted and interpreted according to the 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 #time the maximum number of calls of this template on a page is 1200.

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

Also see the examples below.

Output

Output sent to table

  • <span style="display:none">01776-07-04</span> July 4, 1776 or
  • <span style="display:none">01776-07-04</span> 4 July 1776

Output displayed to user

  • July 4, 1776 or
  • 4 July 1776

Linking

The template formerly linked dates automatically. To turn linking off the parameter link=off was used. In accordance with current guidelines linking is no longer supported. Please do not use this parameter. Please remove it from existing transclusions.

Examples

Normal function of the template. The template with debug=yes, which causes hidden parts to appear:
Template syntax Date rendered
{{dts|2001}} 02001-01-012001
{{dts||1|1}} 02014-01-01January 1
{{dts|-50|July}} -9950-07-01July 50 BC
{{dts|-1000|July|4}} -9000-07-04July 4, 1000 BC
{{dts|5|July|4|BC}} -9995-07-04July 4, 5 BC
{{dts|40|July|4|BC}} -9960-07-04July 4, 40 BC
{{dts|1|July|4|BC}} -9999-07-04July 4, 1 BC
{{dts|88|July|4}} 00088-07-04July 4, 88
{{dts|2007|7|11}} 02007-07-11July 11, 2007
{{dts|2001|sep|11}} 02001-09-11Sep 11, 2001
{{dts|format=dmy|2001}} 02001-01-012001
{{dts|format=dmy||1|1}} 02014-01-011 January
{{dts|format=dmy|-50|July}} -9950-07-01 July 50 BC
{{dts|format=dmy|July}} 02014-07-01July
{{dts|format=dmy||July}} 02014-07-01 July
{{dts|format=dmy|-1000|July|4}} -9000-07-044 July 1000 BC
{{dts|format=dmy|5|July|4|BC}} -9995-07-044 July 5 BC
{{dts|format=dmy|40|July|4|BC}} -9960-07-044 July 40 BC
{{dts|format=dmy|1|July|4|BC}} -9999-07-044 July 1 BC
{{dts|format=dmy|88|July|4}} 00088-07-044 July 88
{{dts|format=dmy|2007|7|11}} 02007-07-1111 July 2007
{{dts|format=dmy|2001|sep|11}} 02001-09-1111 Sep 2001
{{dts|2001}} 02001-01-012001
{{dts|1 January}} 02014-01-011 January
{{dts|July 19}} 02014-07-19July 19
{{dts|July 1923}} 01923-07-01July 1923
{{dts|10 July 1994}} 01994-07-1010 July 1994
{{dts|July 4, 1555}} 01555-07-04July 4, 1555
{{dts|24 Sep 2004}} 02004-09-2424 Sep 2004
{{dts|format=mdy|1 July 1893}} 01893-07-01July 1, 1893
{{dts|format=dmy|July 4, 1688}} 01688-07-04July 1688
{{dts|format=dmy|2007-7-11}} 02007-07-1111 July 2007
{{dts|2001-11-11}} 02001-11-11November 11, 2001
Template syntax Date rendered
{{dts|debug=yes|2001}} 02001-01-012001
{{dts|debug=yes||1|1}} 02014-01-01January 1
{{dts|debug=yes|-50|July}} -9950-07-01July 50 BC
{{dts|debug=yes|-1000|July|4}} -9000-07-04July 4, 1000 BC
{{dts|debug=yes|5|July|4|BC}} -9995-07-04July 4, 5 BC
{{dts|debug=yes|40|July|4|BC}} -9960-07-04July 4, 40 BC
{{dts|debug=yes|1|July|4|BC}} -9999-07-04July 4, 1 BC
{{dts|debug=yes|88|July|4}} 00088-07-04July 4, 88
{{dts|debug=yes|2007|7|11}} 02007-07-11July 11, 2007
{{dts|debug=yes|2001|sep|11}} 02001-09-11Sep 11, 2001
{{dts|format=dmy|debug=yes|2001}} 02001-01-012001
{{dts|format=dmy|debug=yes||1|1}} 02014-01-011 January
{{dts|format=dmy|debug=yes|-50|July}} -9950-07-01 July 50 BC
{{dts|format=dmy|debug=yes|July}} 02014-07-01July
{{dts|format=dmy|debug=yes||July}} 02014-07-01 July
{{dts|format=dmy|debug=yes|-1000|July|4}} -9000-07-044 July 1000 BC
{{dts|format=dmy|debug=yes|5|July|4|BC}} -9995-07-044 July 5 BC
{{dts|format=dmy|debug=yes|40|July|4|BC}} -9960-07-044 July 40 BC
{{dts|format=dmy|debug=yes|1|July|4|BC}} -9999-07-044 July 1 BC
{{dts|format=dmy|debug=yes|88|July|4}} 00088-07-044 July 88
{{dts|format=dmy|debug=yes|2007|7|11}} 02007-07-1111 July 2007
{{dts|format=dmy|debug=yes|2001|sep|11}} 02001-09-1111 Sep 2001
{{dts|debug=yes|2001}} 02001-01-012001
{{dts|debug=yes|1 January}} 02014-01-011 January
{{dts|debug=yes|July 19}} 02014-07-19July 19
{{dts|debug=yes|July 1923}} 01923-07-01July 1923
{{dts|debug=yes|10 July 1994}} 01994-07-1010 July 1994
{{dts|debug=yes|July 4, 1555}} 01555-07-04July 4, 1555
{{dts|debug=yes|24 Sep 2004}} 02004-09-2424 Sep 2004
{{dts|format=mdy|debug=yes|1 July 1893}} 01893-07-01July 1, 1893
{{dts|format=dmy|debug=yes|July 4, 1688}} 01688-07-04July 1688
{{dts|format=dmy|debug=yes|2007-7-11}} 02007-07-1111 July 2007
{{dts|debug=yes|2001-11-11}} 02001-11-11November 11, 2001

Abbreviating the month name

The template displays the name of the month either in abbreviated form or fully spelled out. There are two ways of controlling which is used.

  1. Directly input the desired format.
  2. Use the abbr 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

If the month is input as a number, the default is to spell it out in full.

  • {{dts|2000-01-01}} gives "02000-01-01January 1, 2000"
  • {{dts|2000|1|1}} gives "02000-01-01January 1, 2000"

In this case the month can be abbreviated by setting abbr to on.

  • {{dts|2000-01-01|abbr=on}} gives "02000-01-01Jan 1, 2000"
  • {{dts|2000|1|1|abbr=on}} gives "02000-01-01Jan 1, 2000"
Entering a non-numeric month as the second unnamed parameter

The name of the month either in abbreviated form or fully spelled out when input as the second unnamed parameter. In either case the output form is equivalent to the input form.

  • {{dts|2000|January|1}} gives "02000-01-01January 1, 2000"
  • {{dts|2000|Jan|1}} gives "02000-01-01Jan 1, 2000"
The whole date as a single parameter with a non-numeric month

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 spelled out the name of the month as desired.

  • {{dts|1 January 2000}} gives "02000-01-011 January 2000"
  • {{dts|1 Jan 2000}} gives "02000-01-011 Jan 2000"

Using the format parameter overrides this default behavior and the month name is spelled out in full by default. In this case the month can be abbreviated by setting abbr to on.

  • {{dts|1 January 2000|format=my}} gives "02000-01-01January 2000"
  • {{dts|1 Jan 2000|format=my}} gives "02000-01-01January 2000"
  • {{dts|1 January 2000|format=my|abbr=on}} gives "02000-01-01Jan 2000"
  • {{dts|1 Jan 2000|format=my|abbr=on}} gives "02000-01-01Jan 2000"

Error handling

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

02014-01-01 Error: 35 June 1900 This is not an acceptable date format. Please check the spelling, check the numbers and/or read the documentation at template {{dts}} for correct date input.

See also

  • {{Dtsh}} – same as Dts, but hides the output
  • {{Nts}} – used to generate hidden sort keys for numbers
  • {{Ntss}} – same as Nts, but allows for the number to be scaled
  • {{Ntsh}} – used to generate hidden sort keys for numbers (does not display the number)
  • {{Ntsc}} – for converted units, sorts by the first number
  • {{Convert}} – has a sortable option
  • {{Sms}} – used to generate any hidden sort key