View source for Template:Age/doc

{{Documentation subpage}}
{{Lua|Module:Age|Module:Date}}
__NOTOC__

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

Dates are checked for validity. For example, 29 February 2000 is accepted, but 29 February 1900 is not a valid date.

Partial dates such as July 1989 (no day) or 1989 (no month and no day) can be entered using {{code|0}} for missing values. Having no year, or having a day with no month is an error.

Please remember to avoid phrasings such as "17 years ago" or "Jones is 65 years old", even when they use this template. See [[Wikipedia:MOS:RELTIME|MOS:RELTIME]] for more information.

== Syntax ==
: {{tji|age|year|month|day|year2|month2|day2}} {{font color|green|or}}
: {{tji|age|year|month|day}} {{font color|green|or}}
: {{tji|age|date|date2}} {{font color|green|or}}
: {{tji|age|date}}

== Examples ==
: {{tlc|age|1989|7|23|2003|7|14}} {{Rarr}} {{age|1989|7|23|2003|7|14}}
: {{tlc|age|1989|7|0|2003|7|14}} {{Rarr}} {{age|1989|7|0|2003|7|14}}
: {{tlc|age|1989|0|0|2003|7|14}} {{Rarr}} {{age|1989|0|0|2003|7|14}}
: {{tlc|age|1989|7|23}} {{Rarr}} {{age|1989|7|23}}
: {{tlc|age|23 July 1989|14 July 2003}} {{Rarr}} {{age|23 July 1989|14 July 2003}}
: {{tlc|age|July 1989|2003}} {{Rarr}} {{age|July 1989|2003}}

When entering dates before the [[Wikipedia:Common Era|Common Era]], use astronomical year numbering: 1&nbsp;BCE is represented by {{code|0}}, 2&nbsp;BCE by {{code|-1}}, 3&nbsp;BCE by {{code|-2}} etc. For example, the following gives the number of full years since the battle of Cannae, which took place on August 2, 216 BCE:
: {{tlc|age|-215|8|2}} {{Rarr}} {{age|-215|8|2}}
: {{tlc|age|August 2, 216 BCE}} {{Rarr}} {{age|August 2, 216 BCE}}

The options described at [[Module:Age]] can be used, for example:
: {{tlc|age|format{{=}}commas|-215|8|2}} {{Rarr}} {{age|format=commas|-215|8|2}}
: {{tlc|age|format{{=}}cardinal|1970|1|1|1998|2|1}} {{Rarr}} {{age|format=cardinal|1970|1|1|1998|2|1}}
:: {{tlc|age|format{{=}}ordinal|1970|1|1|1998|2|1}} {{Rarr}} {{age|format=ordinal|1970|1|1|1998|2|1}}

When only one date is entered, the current date is used for the other date. The template outputs a span that can be used by a calling infobox to detect if only one date was used. The following shows two examples with the exact wikitext that is produced, as seen at [[Wikipedia:Special:ExpandTemplates|ExpandTemplates]]:
: {{tlc|age|2010}} {{Rarr}} <code>&lt;span class="currentage">&lt;/span>{{age|format=raw|2010}}</code>
: {{tlc|age|format{{=}}raw|2010}} {{Rarr}} <code>{{age|format=raw|2010}}</code>

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

<includeonly>{{sandbox other||{{testcases other||

<!-- Categories below this line, please -->
[[Category:Templates]]
}}}}</includeonly>