Difference between revisions of "Template:Age/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>CapnZapp
(Undid revision 893895450 by Johnuniq (talk): stealth revert. I don't disagree with your move of the RELTIME link, but don't take a "second stab" at improving the documentation by simply removing the first stab (=the contribution immediately preceding yours). And please write edit summaries that accurately describe the entirety of your edits. Thank you.)
blackwiki>Johnuniq
(Undid revision 893910693 by CapnZapp (talk) see talk; please fix or explain how this helps someone wanting to use {{age}})
Line 10: Line 10:
  
 
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.
 
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.
 
=== Policy ===
 
Please consult relevant Wikipedia policies and Manual of Style sections before using this template in article space.
 
* [[MOS:RELTIME]]
 
 
  
 
; Syntax:
 
; Syntax:
Line 92: Line 87:
 
== 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}}

Revision as of 10:58, 24 April 2019

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
{{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