Difference between revisions of "Template:Age/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>TheSandDoctor
m (update num count)
blackwiki>Johnuniq
(update)
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|730,000+}}
+
{{Lua|Module:Age|Module:Date}}
{{substitution|sometimes}}
+
 
 
== 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]]).
+
; Syntax:
:: Example: <code><nowiki>{{subst:</nowiki>{{BASEPAGENAME}}|1989|7|23|2003|7|14}}</code>
+
: <code><nowiki>{{</nowiki>age|''year''|''month''|''day''|''year2''|''month2''|''day2''}}</code> {{green|or}}
 +
: <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>
  
: 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:
+
; Examples:
:: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|-215|8|2}}</code> returns "{{{{BASEPAGENAME}}|-215|8|2}}"
+
: <code><nowiki>{{</nowiki>age|1989|7|23|2003|7|14}}</code> → {{age|1989|7|23|2003|7|14}}
: (BCE is exactly the same as BC, so August 2, 216 BCE is also August 2, 216 BC)
+
: <code><nowiki>{{</nowiki>age|1989|7|0|2003|7|14}}</code> → {{age|1989|7|0|2003|7|14}}
 +
: <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}}
  
; Note<nowiki>:</nowiki>
+
: 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:
: This template does not check for incorrect input:
+
:: <code><nowiki>{{</nowiki>age|-215|8|2}}</code> {{age|-215|8|2}}
:: <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|August 2, 216 BCE}}</code> {{age|August 2, 216 BCE}}
:: <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)
 
  
==TemplateData==
+
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}}
 +
 
 +
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 wikitext that is produced if the current date is in 2018.
 +
<pre>
 +
{{age|2010}} → <span class="currentage"></span>8
 +
{{age|format=raw|2010}} → 8
 +
</pre>
 +
 
 +
== TemplateData ==
 
{{TemplateDataHeader}}
 
{{TemplateDataHeader}}
 
<templatedata>{
 
<templatedata>{
Line 84: Line 95:
 
[[Category:Date mathematics templates]]
 
[[Category:Date mathematics templates]]
 
}}</includeonly>
 
}}</includeonly>
 
[[Category:Date mathematics templates]]
 

Revision as of 10:02, 7 May 2018

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.

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

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 wikitext that is produced if the current date is in 2018.

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

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