Difference between revisions of "Template:Age/doc"

From blackwiki
Jump to navigation Jump to search
(added hr template)
blackwiki>Zyxw
(update usage, misc formatting)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
+
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High-risk|580,000+}}
+
{{High-risk|600,000+}}
 +
 
 +
== 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 will return the number of full years between a specified date and today's date.  
  
;Syntax<nowiki>:</nowiki>
+
; Syntax<nowiki>:</nowiki>
:<nowiki>{{age|year1|month1|day1|year2|month2|day2}}</nowiki>  or  
+
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|year1|month1|day1|year2|month2|day2}}</code>  or  
:<nowiki>{{age|year1|month1|day1}}</nowiki>
+
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|year1|month1|day1}}</code>
  
 
; Examples<nowiki>:</nowiki>
 
; Examples<nowiki>:</nowiki>
: <nowiki>{{age|1989|7|23|2003|7|14}}</nowiki> returns "{{age|1989|7|23|2003|7|14}}"
+
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|1989|7|23|2003|7|14}}</code> returns "{{{{BASEPAGENAME}}|1989|7|23|2003|7|14}}"
: <nowiki>{{age|1989|7|23}}</nowiki> returns "{{age|1989|7|23}}"
+
: <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]]).
 +
:: Example: <code><nowiki>{{subst:</nowiki>{{BASEPAGENAME}}|1989|7|23|2003|7|14}}</code>
  
: 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.
+
: 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:
:: Example: <nowiki>{{subst:age|1989|7|23|2003|7|14}}</nowiki>
+
:: <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)
  
: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:
 
:: <nowiki>{{age|-215|8|2}}</nowiki> returns "{{age|-215|8|2}}"
 
(BCE is exactly the same as BC, so August 2, 216 BCE is also August 2, 216 BC)
 
 
; Note<nowiki>:</nowiki>
 
; Note<nowiki>:</nowiki>
:This template does not check for incorrect input:
+
: This template does not check for incorrect input:
:: <nowiki>{{age|1980|7|14|1993|6|233}}</nowiki> returns "{{age|1980|7|14|1993|6|233}}" (surplus days do not count as extra months)
+
:: <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)
:: <nowiki>{{age|1980|7|14|1993|88|14}}</nowiki> returns "{{age|1980|7|14|1993|88|14}}" (surplus months do not count as extra years)
+
:: <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===
+
==TemplateData==
 
{{TemplateDataHeader}}
 
{{TemplateDataHeader}}
 
<templatedata>{
 
<templatedata>{
Line 73: Line 77:
 
</templatedata>
 
</templatedata>
  
 +
==See also==
 +
{{Birth, death and age templates|age}}
  
{{Birth, death and age templates}}
+
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
+
<!-- Categories below this line, please; interwikis at Wikidata -->
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
 
| <!-- ADD CATEGORIES BELOW THIS LINE, PLEASE: -->
 
 
[[Category:Date mathematics templates]]
 
[[Category:Date mathematics templates]]
 
}}</includeonly>
 
}}</includeonly>

Revision as of 05:35, 27 December 2015

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.

Syntax:
{{Age|year1|month1|day1|year2|month2|day2}} or
{{Age|year1|month1|day1}}
Examples:
{{Age|1989|7|23|2003|7|14}} returns "13"
{{Age|1989|7|23}} returns "36"
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).
Example: {{subst:Age|1989|7|23|2003|7|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 expression returns the number of full years elapsed since the battle of Cannae, which took place on August 2, 216 BCE:
{{Age|-215|8|2}} returns "2240"
(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:
{{Age|1980|7|14|1993|6|233}} returns "Error: Second date should be year, month, day" (surplus days do not count as extra months)
{{Age|1980|7|14|1993|88|14}} returns "Error: Second date should be year, month, day" (surplus months do not count as extra years)

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)year1 1

The year of the (first) date

Numberrequired
Month ('from' date)month1 2

The month of the (first) date

Numberrequired
Day of month ('from' date)day1 3

The day of the month of the (first) date

Numberrequired
Year ('to' date)year2 4

The year of the 'to' date, if required

Numberoptional
Month ('to' date)month2 5

The month of the 'to' date, if required

Numberoptional
Day of month ('to' date)day2 6

The day of the month of the 'to' date, if required

Numberoptional

See also