Difference between revisions of "Template:Age/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Zyxw
(update usage, misc formatting)
blackwiki>Zyxw
(fix TemplateData to remove named parameters since the template only supports unnamed parameters, show default values for 2nd date)
Line 8: Line 8:
  
 
; Syntax<nowiki>:</nowiki>
 
; Syntax<nowiki>:</nowiki>
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|year1|month1|day1|year2|month2|day2}}</code>  or  
+
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''year''|''month''|''day''|''year2''|''month2''|''day2''}}</code>  or  
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|year1|month1|day1}}</code>
+
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|''year''|''month''|''day''}}</code>
  
 
; Examples<nowiki>:</nowiki>
 
; Examples<nowiki>:</nowiki>
Line 32: Line 32:
 
"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.",
 
"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": {
 
"params": {
   "year1": {
+
   "1": {
     "label": "Year ('from' date)",
+
     "label": "Year (\"from\" date)",
     "description": "The year of the (first) date",
+
     "description": "The year of the \"from\" date",
 
     "type": "number",
 
     "type": "number",
     "required": true,
+
     "required": true
    "aliases": ["1"]
 
 
   },
 
   },
   "month1": {
+
   "2": {
     "label": "Month ('from' date)",
+
     "label": "Month (\"from\" date)",
     "description": "The month of the (first) date",
+
     "description": "The month of the \"from\" date, 1 through 12",
 
     "type": "number",
 
     "type": "number",
     "required": true,
+
     "required": true
    "aliases": ["2"]
 
 
   },
 
   },
   "day1": {
+
   "3": {
     "label": "Day of month ('from' date)",
+
     "label": "Day (\"from\" date)",
     "description": "The day of the month of the (first) date",
+
     "description": "The day (of month) of the \"from\" date, 1 through 31",
 
     "type": "number",
 
     "type": "number",
     "required": true,
+
     "required": true
    "aliases": ["3"]
 
 
   },
 
   },
   "year2": {
+
   "4": {
     "label": "Year ('to' date)",
+
     "label": "Year2 (\"to\" date)",
     "description": "The year of the 'to' date, if required",
+
     "description": "The year of the \"to\" date, if required",
 
     "type": "number",
 
     "type": "number",
 
     "required": false,
 
     "required": false,
     "aliases": ["4"]
+
     "default": "{{CURRENTYEAR}}"
 
   },
 
   },
   "month2": {
+
   "5": {
     "label": "Month ('to' date)",
+
     "label": "Month2 (\"to\" date)",
     "description": "The month of the 'to' date, if required",
+
     "description": "The month of the \"to\" date, if required",
 
     "type": "number",
 
     "type": "number",
 
     "required": false,
 
     "required": false,
     "aliases": ["5"]
+
     "default": "{{CURRENTMONTH}}"
 
   },
 
   },
   "day2": {
+
   "6": {
     "label": "Day of month ('to' date)",
+
     "label": "Day2 (\"to\" date)",
     "description": "The day of the month of the 'to' date, if required",
+
     "description": "The day (of month) of the \"to\" date, if required",
 
     "type": "number",
 
     "type": "number",
 
     "required": false,
 
     "required": false,
     "aliases": ["6"]
+
     "default": "{{CURRENTDAY}}"
 
   }
 
   }
 
}}
 
}}

Revision as of 06:00, 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|year|month|day|year2|month2|day2}} or
{{Age|year|month|day}}
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)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