Template:Age/doc: Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{ | {{Lua|Module:Age|Module:Date}} | ||
__NOTOC__ | |||
== Usage == | == 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. | 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. | 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 | Partial dates such as July 1989 (no day) or 1989 (no month and no day) can be entered using {{code|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 [[Wikipedia:MOS:RELTIME|MOS:RELTIME]] for more information. | Please remember to avoid phrasings such as "17 years ago" or "Jones is 65 years old", even when they use this template. See [[Wikipedia:MOS:RELTIME|MOS:RELTIME]] for more information. | ||
== Syntax == | |||
: | : {{tlc|age|''year''|''month''|''day''|''year2''|''month2''|''day2''}} {{font color|green|or}} | ||
: | : {{tlc|age|''year''|''month''|''day''}} {{font color|green|or}} | ||
: | : {{tlc|age|''date''|''date2''}} {{font color|green|or}} | ||
: | : {{tlc|age|''date''}} | ||
== Examples == | |||
: | : {{tlc|age|1989|7|23|2003|7|14}} → {{age|1989|7|23|2003|7|14}} | ||
: | : {{tlc|age|1989|7|0|2003|7|14}} → {{age|1989|7|0|2003|7|14}} | ||
: | : {{tlc|age|1989|0|0|2003|7|14}} → {{age|1989|0|0|2003|7|14}} | ||
: | : {{tlc|age|1989|7|23}} → {{age|1989|7|23}} | ||
: | : {{tlc|age|23 July 1989|14 July 2003}} → {{age|23 July 1989|14 July 2003}} | ||
: | : {{tlc|age|July 1989|2003}} → {{age|July 1989|2003}} | ||
When entering dates before the [[Wikipedia:Common Era|Common Era]], use astronomical year numbering: 1 BCE is represented by {{code|0}}, 2 BCE by {{code|-1}}, 3 BCE by {{code|-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: | |||
: | : {{tlc|age|-215|8|2}} → {{age|-215|8|2}} | ||
: | : {{tlc|age|August 2, 216 BCE}} → {{age|August 2, 216 BCE}} | ||
The options described at [[Module:Age]] can be used, for example: | The options described at [[Module:Age]] can be used, for example: | ||
: | : {{tlc|age|format=commas|-215|8|2}} → {{age|format=commas|-215|8|2}} | ||
: | : {{tlc|age|format=cardinal|1970|1|1|1998|2|1}} → {{age|format=cardinal|1970|1|1|1998|2|1}} | ||
:: | :: {{tlc|age|format=ordinal|1970|1|1|1998|2|1}} → {{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 [[Wikipedia:Special:ExpandTemplates|ExpandTemplates]]: | 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 [[Wikipedia:Special:ExpandTemplates|ExpandTemplates]]: | ||
: | : {{tlc|age|2010}} → <code><span class="currentage"></span>{{age|format=raw|2010}}</code> | ||
: | : {{tlc|age|format=raw|2010}} → <code>{{age|format=raw|2010}}</code> | ||
== TemplateData == | == TemplateData == | ||
Line 85: | Line 85: | ||
</templatedata> | </templatedata> | ||
<includeonly> | <includeonly>{{sandbox other||{{testcases other|| | ||
<!-- Categories below this line, please --> | <!-- Categories below this line, please --> | ||
[[Category:Templates]] | [[Category:Templates]] | ||
</includeonly> | }}}}</includeonly> |
Revision as of 16:14, 12 June 2023
It contains usage information, categories and other content that is not part of the original template page.
|
This template uses Lua: |
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}}
→ 35{{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}}
→ 2239{{age|August 2, 216 BCE}}
→ 2239
The options described at Module:Age can be used, for example:
{{age|-215|8|2}}
→ 2,239{{age|1970|1|1|1998|2|1}}
→ twenty-eight{{age|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 ExpandTemplates:
{{age|2010}}
→<span class="currentage"></span>14
{{age|2010}}
→14
TemplateData
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Year ("from" date) | 1 | The year of the "from" date | Number | required |
Month ("from" date) | 2 | The month of the "from" date, 1 through 12 | Number | required |
Day ("from" date) | 3 | The day (of month) of the "from" date, 1 through 31 | Number | required |
Year2 ("to" date) | 4 | The year of the "to" date, if required
| Number | optional |
Month2 ("to" date) | 5 | The month of the "to" date, if required
| Number | optional |
Day2 ("to" date) | 6 | The day (of month) of the "to" date, if required
| Number | optional |