Difference between revisions of "Template:Age/doc"

From blackwiki
Jump to navigation Jump to search
m (149 revisions imported)
 
(12 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
+
{{High-risk|253,000+}}
{{High-risk|642,000+}}
+
{{Lua|Module:Age|Module:Date}}
  
 
== Usage ==
 
== Usage ==
  
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.  
+
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.
  
; Syntax<nowiki>:</nowiki>
+
Dates are checked for validity. For example, 29 February 2000 is accepted, but 29 February 1900 is not a valid date.
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''year''|''month''|''day''|''year2''|''month2''|''day2''}}</code>  or
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''year''|''month''|''day''}}</code>
 
  
; Examples<nowiki>:</nowiki>
+
Partial dates such as July 1989 (no day) or 1989 (no month and no day) can be entered using <code>0</code> for missing values. Having no year, or having a day with no month is an error.
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1989|7|23|2003|7|14}}</code> returns "{{{{BASEPAGENAME}}|1989|7|23|2003|7|14}}"
 
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1989|7|23}}</code> returns "{{{{BASEPAGENAME}}|1989|7|23}}"
 
  
: When using this template to calculate a person's age at death or a person's age on a specified date (rather than the person's current age), please substitute it into the page (see [[Help:Substitution]]).
+
Please remember to avoid phrasings such as "17 years ago" or "Jones is 65 years old", even when they use this template. See [[MOS:RELTIME]] for more information.
:: Example: <code><nowiki>{{subst:</nowiki>{{BASEPAGENAME}}|1989|7|23|2003|7|14}}</code>
 
  
: 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:
+
; Syntax:
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|-215|8|2}}</code> returns "{{{{BASEPAGENAME}}|-215|8|2}}"
+
: <code><nowiki>{{</nowiki>age|''year''|''month''|''day''|''year2''|''month2''|''day2''}}</code> {{green|or}}
: (BCE is exactly the same as BC, so August 2, 216 BCE is also August 2, 216 BC)
+
: <code><nowiki>{{</nowiki>age|''year''|''month''|''day''}}</code> {{green|or}}
 +
: <code><nowiki>{{</nowiki>age|''date''|''date2''}}</code> {{green|or}}
 +
: <code><nowiki>{{</nowiki>age|''date''}}</code>
  
; Note<nowiki>:</nowiki>
+
; Examples:
: This template does not check for incorrect input:
+
: <code><nowiki>{{</nowiki>age|1989|7|23|2003|7|14}}</code> → {{age|1989|7|23|2003|7|14}}
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1980|7|14|1993|6|233}}</code> returns "{{{{BASEPAGENAME}}|1980|7|14|1993|6|233}}" (surplus days do not count as extra months)
+
: <code><nowiki>{{</nowiki>age|1989|7|0|2003|7|14}}</code> {{age|1989|7|0|2003|7|14}}
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1980|7|14|1993|88|14}}</code> returns "{{{{BASEPAGENAME}}|1980|7|14|1993|88|14}}" (surplus months do not count as extra years)
+
: <code><nowiki>{{</nowiki>age|1989|0|0|2003|7|14}}</code> → {{age|1989|0|0|2003|7|14}}
 +
: <code><nowiki>{{</nowiki>age|1989|7|23}}</code> {{age|1989|7|23}}
 +
: <code><nowiki>{{</nowiki>age|23 July 1989|14 July 2003}}</code> → {{age|23 July 1989|14 July 2003}}
 +
: <code><nowiki>{{</nowiki>age|July 1989|2003}}</code> → {{age|July 1989|2003}}
  
==TemplateData==
+
: When entering dates before the [[Common Era]], use astronomical year numbering: 1&nbsp;BCE is represented by <code>0</code>, 2&nbsp;BCE by <code>-1</code>, 3&nbsp;BCE by <code>-2</code> etc. For example, the following gives the number of full years since the battle of Cannae, which took place on August 2, 216 BCE:
 +
:: <code><nowiki>{{</nowiki>age|-215|8|2}}</code> → {{age|-215|8|2}}
 +
:: <code><nowiki>{{</nowiki>age|August 2, 216 BCE}}</code> → {{age|August 2, 216 BCE}}
 +
 
 +
The options described at [[Module:Age]] can be used, for example:
 +
:: <code><nowiki>{{</nowiki>age|format=commas|-215|8|2}}</code> → {{age|format=commas|-215|8|2}}
 +
:: <code><nowiki>{{</nowiki>age|format=cardinal|1970|1|1|1998|2|1}}</code> → {{age|format=cardinal|1970|1|1|1998|2|1}}
 +
:: <code><nowiki>{{</nowiki>age|format=ordinal|1970|1|1|1998|2|1}}</code> → {{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 [[Special:ExpandTemplates]]:
 +
:: <code><nowiki>{{</nowiki>age|2010}}</code> → <code>&lt;span class="currentage">&lt;/span>{{age|format=raw|2010}}</code>
 +
:: <code><nowiki>{{</nowiki>age|format=raw|2010}}</code> → <code>{{age|format=raw|2010}}</code>
 +
 
 +
== TemplateData ==
 
{{TemplateDataHeader}}
 
{{TemplateDataHeader}}
 
<templatedata>{
 
<templatedata>{
Line 76: Line 89:
 
== See also ==
 
== See also ==
  
* [[Template:Years ago]] {{ndash}} Number of years in the past
+
* [[Template:Years ago]] – number of years in the past
 +
* [[MOS:RELTIME]] – guideline on relative time references
  
 
{{Birth, death and age templates|age}}
 
{{Birth, death and age templates|age}}
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+
<includeonly>{{Sandbox other||
 
<!-- Categories below this line, please; interwikis at Wikidata -->
 
<!-- Categories below this line, please; interwikis at Wikidata -->
 
[[Category:Date mathematics templates]]
 
[[Category:Date mathematics templates]]
 
}}</includeonly>
 
}}</includeonly>
 
[[Category:Date mathematics templates]]
 

Latest revision as of 12:34, 18 October 2020

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 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 MOS:RELTIME for more information.

Syntax
{{age|year|month|day|year2|month2|day2}} or
{{age|year|month|day}} or
{{age|date|date2}} or
{{age|date}}
Examples
{{age|1989|7|23|2003|7|14}} → 13
{{age|1989|7|0|2003|7|14}} → 14
{{age|1989|0|0|2003|7|14}} → 14
{{age|1989|7|23}}36
{{age|23 July 1989|14 July 2003}} → 13
{{age|July 1989|2003}} → 14
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 gives the number of full years since the battle of Cannae, which took place on August 2, 216 BCE:
{{age|-215|8|2}}2240
{{age|August 2, 216 BCE}}2240

The options described at Module:Age can be used, for example:

{{age|format=commas|-215|8|2}}2,240
{{age|format=cardinal|1970|1|1|1998|2|1}} → twenty-eight
{{age|format=ordinal|1970|1|1|1998|2|1}} → twenty-eighth

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 Special:ExpandTemplates:

{{age|2010}}<span class="currentage"></span>15
{{age|format=raw|2010}}15

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Age

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.

Template parameters

ParameterDescriptionTypeStatus
Year ("from" date)1

The year of the "from" date

Numberrequired
Month ("from" date)2

The month of the "from" date, 1 through 12

Numberrequired
Day ("from" date)3

The day (of month) of the "from" date, 1 through 31

Numberrequired
Year2 ("to" date)4

The year of the "to" date, if required

Default
{{CURRENTYEAR}}
Numberoptional
Month2 ("to" date)5

The month of the "to" date, if required

Default
{{CURRENTMONTH}}
Numberoptional
Day2 ("to" date)6

The day (of month) of the "to" date, if required

Default
{{CURRENTDAY}}
Numberoptional

See also