Editing Template:Age nts/doc

{{Documentation subpage}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Lua|Module:Age}}

This acts just like {{tl|Age}} but will sort correctly in sortable tables. It is used in more than 1,000.

The template returns the number of full years between two specified dates. If the second set of parameters is not included, it will return the number of full years between a specified date and today's date.

A hidden sort key is included so values produced by this template will work properly in [[Help:Sortable tables|sortable tables]]. The sort key is calculated from the number of days between the given dates, and is compatible with {{tl|number table sorting}}.

== Usage ==
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''year''|''month''|''day''|''year2''|''month2''|''day2''}}</code>  or 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''year''|''month''|''day''}}</code>

== Examples ==
: For example, the following expression returns the number of full years elapsed between the [[fall of the Western Roman Empire]] on September 4, 476 AD, and the formation of the [[Italian Republic]] on June 2, 1946:
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|476|9|4|1946|6|2}}</code> returns "{{{{BASEPAGENAME}}|476|9|4|1946|6|2}}"
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|476|9|4}}</code> returns "{{{{BASEPAGENAME}}|476|9|4}}"

: When entering dates before the [[Common Era]], use astronomical year numbering: 1 BCE is represented by 0, 2 BCE by -1, 3 BCE by -2 etc. For example, the following expression returns the number of full years elapsed since the [[battle of Cannae]], which took place on August 2, 216 BCE:
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|-215|8|2}}</code> returns "{{{{BASEPAGENAME}}|-215|8|2}}"
: (BCE is exactly the same as BC, so August 2, 216 BCE is also August 2, 216 BC)

== Note ==
: This template does not check for incorrect input:
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|2000|4|22|2015|8|32}}</code> returns "{{{{BASEPAGENAME}}|2000|4|22|2015|8|32}}" (surplus days do not count as extra months)
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|2000|4|22|2015|13|7}}</code> returns "{{{{BASEPAGENAME}}|2000|4|22|2015|13|7}}" (surplus months do not count as extra years)
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1900|2|29}}</code> returns "{{{{BASEPAGENAME}}|1900|2|29}}" (1900 is not a leap year)

== TemplateData ==
{{TemplateData header}}
<templatedata>{
"description": "This template returns the number of full years between two specified dates. If the second set of parameters is not included, it will return the number of full years between a specified date and today's date.",
"params": {
  "1": {
    "label": "Year (\"from\" date)",
    "description": "The year of the \"from\" date",
    "type": "number",
    "required": true
  },
  "2": {
    "label": "Month (\"from\" date)",
    "description": "The month of the \"from\" date, 1 through 12",
    "type": "number",
    "required": true
  },
  "3": {
    "label": "Day (\"from\" date)",
    "description": "The day (of month) of the \"from\" date, 1 through 31",
    "type": "number",
    "required": true
  },
  "4": {
    "label": "Year2 (\"to\" date)",
    "description": "The year of the \"to\" date, if required",
    "type": "number",
    "required": false,
    "default": "{{CURRENTYEAR}}"
  },
  "5": {
    "label": "Month2 (\"to\" date)",
    "description": "The month of the \"to\" date, if required",
    "type": "number",
    "required": false,
    "default": "{{CURRENTMONTH}}"
  },
  "6": {
    "label": "Day2 (\"to\" date)",
    "description": "The day (of month) of the \"to\" date, if required",
    "type": "number",
    "required": false,
    "default": "{{CURRENTDAY}}"
  }
}}
</templatedata>

== See also ==
* {{tl|nts}} - number table sorting
* [[Wikipedia:Age calculation templates]]

{{Birth, death and age templates|age}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Date mathematics templates]]
[[Category:Sorting templates]]

}}</includeonly>