View source for Template:Dts/doc | Apple Wiki

{{Documentation subpage}}
<!-- 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]]).

==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.

==Parameters==
{{notice|1=Date display can be modified using two named parameters. 
*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
|-
|+The year, month and day can either be entered separately or as a single date.
|-
!width=50%|{{tlf|dts|''year''|''month''|''day''|''BC''}}
!width=50%|{{tlf|dts|''date''}}
|-valign=top
|
*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 {{[[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).
**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===
{{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>}}

If one of the latter formats is used there is a limit to the number of occurrences in a page, due to the use of the function #time.

Also see the [[#Examples|examples]] below.

===Output===
Output sent to table
*<code><nowiki><span style="display:none">01776-07-04</span> July 4, 1776</nowiki></code> or
*<code><nowiki><span style="display:none">01776-07-04</span> 4 July 1776</nowiki></code>

Output displayed to user<br>
*July 4, 1776 or
*4 July 1776

===Linking===
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.

==Examples==
{|class=wikitable
|-
!Normal function of the template.
!The template with <code>debug=yes</code>, which causes hidden parts to appear:
|-valign=top
|
{{dts/examples}}
|
{{dts/examples|debug=yes}}
|}

==Error handling==
During early 2009, Template:Dts generated month names for invalid month numbers, such as number 23 displaying "November". No warning is displayed, for the formatted page, that such invalid dates are being used on the page.

==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.
* {{tl|dts1}}
* {{tl|dts vgr}}, for video game release dates.
* {{tl|sort}}, sorting by a specified key
* {{tl|sortname}}, full name sorting.

<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Sorting templates|Dts]]
[[Category:Date mathematics templates|{{PAGENAME}}]]
<!-- ADD INTERWIKIS BELOW THIS LINE -->
<!--[[ar:قالب:Dts]]
[[da:Skabelon:Dts]]
[[de:Vorlage:Dts]]
[[id:Templat:Dts]]
[[it:Template:Dts]]
[[pl:Szablon:Dts]]
[[pt:Predefinição:Dts]]
[[th:แม่แบบ:Dts]]
[[uk:Шаблон:Dts]]
[[zh:Template:Dts]]
[[fa:الگو:Dts]]-->
</includeonly>