Module:Age/doc: Difference between revisions
Jump to navigation
Jump to search
(Created page with "== Templates supported == Module:Age implements the following templates: {| class="wikitable" ! Template !! Required wikitext |- | {{tl|...") |
mNo edit summary |
||
| Line 99: | Line 99: | ||
| <code>duration=on</code> || The finishing date is included in the result; that adds one day to the age. | | <code>duration=on</code> || The finishing date is included in the result; that adds one day to the age. | ||
|- | |- | ||
| <code>fix=on</code> || Adjust invalid time units. See [[Template:Extract#Fix]]. | | <code>fix=on</code> || Adjust invalid time units. See [[Wikipedia:Template:Extract#Fix|Template:Extract#Fix]]. | ||
|- | |- | ||
| <code>format=commas</code> || A value of 1,000 or more is displayed with commas. | | <code>format=commas</code> || A value of 1,000 or more is displayed with commas. | ||
| Line 111: | Line 111: | ||
| <code>prefix=''text''</code> || Insert the given ''text'' before the result but after any sort key. For example, <code><nowiki>{{age|23 July 1910|14 July 1976|prefix=about|sortable=on}}</nowiki></code> outputs a hidden sort key followed by "about 65". | | <code>prefix=''text''</code> || Insert the given ''text'' before the result but after any sort key. For example, <code><nowiki>{{age|23 July 1910|14 July 1976|prefix=about|sortable=on}}</nowiki></code> outputs a hidden sort key followed by "about 65". | ||
|- | |- | ||
| <code>range=dash</code> || Accept a year only, or a year and month only, and show a range of ages with an [[Dash#En dash|en dash]] (–). | | <code>range=dash</code> || Accept a year only, or a year and month only, and show a range of ages with an [[Wikipedia:Dash#En dash|en dash]] (–). | ||
|- | |- | ||
| <code>range=yes</code> || Accept a year or year/month, and show the range with "or". | | <code>range=yes</code> || Accept a year or year/month, and show the range with "or". | ||
| Line 119: | Line 119: | ||
| <code>round=on</code> || The age is rounded to the nearest least-significant time unit. | | <code>round=on</code> || The age is rounded to the nearest least-significant time unit. | ||
|- | |- | ||
| <code>sc=on</code> || A [[serial comma]] is used (only useful when three or more values are displayed). | | <code>sc=on</code> || A [[Wikipedia:serial comma|serial comma]] is used (only useful when three or more values are displayed). | ||
|- | |- | ||
| <code>sc=yes</code> || Same as <code>sc=on</code>. | | <code>sc=yes</code> || Same as <code>sc=on</code>. | ||
| Line 125: | Line 125: | ||
| <code>show=hide</code> || The age is not displayed; may be useful with <code>sortable=on</code>. | | <code>show=hide</code> || The age is not displayed; may be useful with <code>sortable=on</code>. | ||
|- | |- | ||
| <code>sortable=on</code> || Insert a hidden sort key before the result (for use in [[ | | <code>sortable=on</code> || Insert a hidden sort key before the result (for use in [[Wikipedia:SORT|sortable tables]]). | ||
|- | |- | ||
| <code>sortable=table</code> || Insert a sort key using table syntax <code>data-sort-value="''value''"|</code>. | | <code>sortable=table</code> || Insert a sort key using table syntax <code>data-sort-value="''value''"|</code>. | ||
| Line 139: | Line 139: | ||
*<code><nowiki>{{age in years and months|Jan 2001|Feb 2012|range=yes}}</nowiki></code> → {{age in years and months|Jan 2001|Feb 2012|range=yes}} | *<code><nowiki>{{age in years and months|Jan 2001|Feb 2012|range=yes}}</nowiki></code> → {{age in years and months|Jan 2001|Feb 2012|range=yes}} | ||
*<code><nowiki>{{age in years and months|Jan 2001|Feb 2012|range=dash}}</nowiki></code> → {{age in years and months|Jan 2001|Feb 2012|range=dash}} | *<code><nowiki>{{age in years and months|Jan 2001|Feb 2012|range=dash}}</nowiki></code> → {{age in years and months|Jan 2001|Feb 2012|range=dash}} | ||
*<code><nowiki>{{age in years and months|Jan 2001|Feb 2012|range=no}}</nowiki></code> → {{age in years and months|Jan 2001|Feb 2012|range=no}} {{green| | *<code><nowiki>{{age in years and months|Jan 2001|Feb 2012|range=no}}</nowiki></code> → {{age in years and months|Jan 2001|Feb 2012|range=no}} {{font color|green|assume 1 Jan 2001 to 1 Feb 2012}} | ||
*<code><nowiki>{{age in years and months|12 Jan 2001|Feb 2012|range=no}}</nowiki></code> → {{age in years and months|12 Jan 2001|Feb 2012|range=no}} {{green| | *<code><nowiki>{{age in years and months|12 Jan 2001|Feb 2012|range=no}}</nowiki></code> → {{age in years and months|12 Jan 2001|Feb 2012|range=no}} {{font color|green|assume 12 Jan 2001 to 12 Feb 2012}} | ||
*<code><nowiki>{{age in years and months|2001|2012|range=no}}</nowiki></code> → {{age in years and months|2001|2012|range=no}} {{green| | *<code><nowiki>{{age in years and months|2001|2012|range=no}}</nowiki></code> → {{age in years and months|2001|2012|range=no}} {{font color|green|assume 1 Jan 2001 to 1 Jan 2012}} | ||
*<code><nowiki>{{age in years and months|2001|23 Feb 2012|range=no}}</nowiki></code> → {{age in years and months|2001|23 Feb 2012|range=no}} {{green| | *<code><nowiki>{{age in years and months|2001|23 Feb 2012|range=no}}</nowiki></code> → {{age in years and months|2001|23 Feb 2012|range=no}} {{font color|green|assume 23 Feb 2001 to 23 Feb 2012}} | ||
The sort key is based on the age in days, and fractions of a day if a time is specified. | The sort key is based on the age in days, and fractions of a day if a time is specified. | ||
| Line 150: | Line 150: | ||
An extra day is added for a duration. | An extra day is added for a duration. | ||
*<code><nowiki>{{age in years and months|20 Jan 2001|19 Feb 2012}}</nowiki></code> → {{age in years and months|20 Jan 2001|19 Feb 2012}} {{green| | *<code><nowiki>{{age in years and months|20 Jan 2001|19 Feb 2012}}</nowiki></code> → {{age in years and months|20 Jan 2001|19 Feb 2012}} {{font color|green|one day short of 11 years, 1 month}} | ||
*<code><nowiki>{{age in years and months|20 Jan 2001|19 Feb 2012|duration=on}}</nowiki></code> → {{age in years and months|20 Jan 2001|19 Feb 2012|duration=on}} | *<code><nowiki>{{age in years and months|20 Jan 2001|19 Feb 2012|duration=on}}</nowiki></code> → {{age in years and months|20 Jan 2001|19 Feb 2012|duration=on}} | ||
The least-significant time unit can be rounded. | The least-significant time unit can be rounded. | ||
*<code><nowiki>{{age in years and months|20 Jan 2001|10 Feb 2012}}</nowiki></code> → {{age in years and months|20 Jan 2001|10 Feb 2012}} | *<code><nowiki>{{age in years and months|20 Jan 2001|10 Feb 2012}}</nowiki></code> → {{age in years and months|20 Jan 2001|10 Feb 2012}} | ||
*<code><nowiki>{{age in years and months|20 Jan 2001|10 Feb 2012|round=on}}</nowiki></code> → {{age in years and months|20 Jan 2001|10 Feb 2012|round=on}} {{green| | *<code><nowiki>{{age in years and months|20 Jan 2001|10 Feb 2012|round=on}}</nowiki></code> → {{age in years and months|20 Jan 2001|10 Feb 2012|round=on}} {{font color|green|round to nearest month}} | ||
Large numbers can be formatted with commas. | Large numbers can be formatted with commas. | ||
| Line 162: | Line 162: | ||
== Spelling numbers == | == Spelling numbers == | ||
The templates that use <code>age_generic</code> can display numbers in words rather than using numerals. The result can be a [[Cardinal number (linguistics)|cardinal number]] (such as "five") or an [[Ordinal number (linguistics)|ordinal number]] (such as "fifth"). The first letter can be in uppercase, and US spelling of numbers can be used. Examples: | The templates that use <code>age_generic</code> can display numbers in words rather than using numerals. The result can be a [[Wikipedia:Cardinal number (linguistics)|cardinal number]] (such as "five") or an [[Wikipedia:Ordinal number (linguistics)|ordinal number]] (such as "fifth"). The first letter can be in uppercase, and US spelling of numbers can be used. Examples: | ||
*<code><nowiki>{{age|1898|01|01|2018|02|01|format=cardinal}}</nowiki></code> → {{age|1898|01|01|2018|02|01|format=cardinal}} | *<code><nowiki>{{age|1898|01|01|2018|02|01|format=cardinal}}</nowiki></code> → {{age|1898|01|01|2018|02|01|format=cardinal}} | ||
*<code><nowiki>{{age|1898|01|01|2018|02|01|format=cardinal_us}}</nowiki></code> → {{age|1898|01|01|2018|02|01|format=cardinal_us}} | *<code><nowiki>{{age|1898|01|01|2018|02|01|format=cardinal_us}}</nowiki></code> → {{age|1898|01|01|2018|02|01|format=cardinal_us}} | ||
Revision as of 10:03, 3 September 2020
Templates supported
Module:Age implements the following templates:
| Template | Required wikitext |
|---|---|
| {{extract}} | {{#invoke:age|extract}}
|
| {{gregorian serial date}} | {{#invoke:age|gsd}}
|
| {{time interval}} | {{#invoke:age|time_interval}}
|
| {{age in days}} | {{#invoke:age|age_generic|template=age_days}}
|
| {{age in days nts}} | {{#invoke:age|age_generic|template=age_days_nts}}
|
| {{duration in days}} | {{#invoke:age|age_generic|template=duration_days}}
|
| {{duration in days nts}} | {{#invoke:age|age_generic|template=duration_days_nts}}
|
| {{age}} | {{#invoke:age|age_generic|template=age_full_years}}
|
| {{age nts}} | {{#invoke:age|age_generic|template=age_full_years_nts}}
|
| {{age in years}} | {{#invoke:age|age_generic|template=age_in_years}}
|
| {{age in years nts}} | {{#invoke:age|age_generic|template=age_in_years_nts}}
|
| {{age for infant}} | {{#invoke:age|age_generic|template=age_infant}}
|
| {{age in months}} | {{#invoke:age|age_generic|template=age_m}}
|
| {{age in weeks}} | {{#invoke:age|age_generic|template=age_w}}
|
| {{age in weeks and days}} | {{#invoke:age|age_generic|template=age_wd}}
|
| {{age in years and days}} | {{#invoke:age|age_generic|template=age_yd}}
|
| {{age in years and days nts}} | {{#invoke:age|age_generic|template=age_yd_nts}}
|
| {{age in years and months}} | {{#invoke:age|age_generic|template=age_ym}}
|
| {{age in years, months and days}} | {{#invoke:age|age_generic|template=age_ymd}}
|
| {{age in years, months, weeks and days}} | {{#invoke:age|age_generic|template=age_ymwd}}
|
| {{birth date and age}} | {{#invoke:age|birth_date_and_age}}
|
| {{death date and age}} | {{#invoke:age|death_date_and_age}}
|
Redirects
| Template | Redirects to |
|---|---|
| {{ayd}} | {{age in years and days nts}} |
| {{hla}} | {{age in years, months and days}} |
| {{age in months, weeks and days}} | {{age in years, months, weeks and days}} |
| {{bda}} | {{birth date and age}} |
| {{dda}} | {{death date and age}} |
| {{gsd}} | {{gregorian serial date}} |
The age templates expect the older date to be first. The implementations of age_in_years and age_in_years_nts display an error message if that is not the case. If similar checking is wanted for other templates, negative=error can be added to the invoke. For example, {{age}} might use:
{{#invoke:age|age_generic|template=age_full_years|negative=error}}
If negative=error does not apply, a negative difference is indicated with a minus sign (−).
Date formats
Dates can use numbered or named parameters to specify year/month/day. Alternatively, a full date can be entered in a variety of formats. For example:
{{age in years and months|year1=2001|month1=1|day1=10|year2=2012|month2=2|day2=20}}→ 11 years, 1 month{{age in years and months|year=2001|month=1|day=10|year2=2012|month2=2|day2=20}}→ 11 years, 1 month{{age in years and months|2001|1|10|2012|2|20}}→ 11 years, 1 month{{age in years and months|2001-1-10|2012-2-20}}→ 11 years, 1 month{{age in years and months|10 Jan 2001|20 Feb 2012}}→ 11 years, 1 month{{age in years and months|January 10, 2001|Feb 20, 2012}}→ 11 years, 1 month
If the first or second date is omitted, the current date is used. For example:
{{age in years and months|year2=2012|month2=2|day2=20}}→ −12 years, 9 months{{age in years and months||||2012|2|20}}→ −12 years, 9 months{{age in years and months||2012-2-20}}→ −12 years, 9 months{{age in years and months||20 Feb 2012}}→ −12 years, 9 months{{age in years and months||Feb 20, 2012}}→ −12 years, 9 months{{age in years and months|year1=2001|month1=1|day1=10}}→ 23 years, 10 months{{age in years and months|year=2001|month=1|day=10}}→ 23 years, 10 months{{age in years and months|2001|1|10}}→ 23 years, 10 months{{age in years and months|2001-1-10}}→ 23 years, 10 months{{age in years and months|10 Jan 2001}}→ 23 years, 10 months{{age in years and months|January 10, 2001}}→ 23 years, 10 months
Parameters
The following options are available:
| Parameter | Description |
|---|---|
duration=on |
The finishing date is included in the result; that adds one day to the age. |
fix=on |
Adjust invalid time units. See Template:Extract#Fix. |
format=commas |
A value of 1,000 or more is displayed with commas. |
format=raw |
Numbers are displayed without commas and negative numbers are displayed with a hyphen for {{#expr}}. In addition, {{age}} outputs a plain number and will not include a span to indicate if the result relies on the current date.
|
format=cardinal |
Display the resulting number using words such as "five" instead of 5. See below. |
format=ordinal |
Display the resulting number using words such as "fifth" instead of 5. See below. |
prefix=text |
Insert the given text before the result but after any sort key. For example, {{age|23 July 1910|14 July 1976|prefix=about|sortable=on}} outputs a hidden sort key followed by "about 65".
|
range=dash |
Accept a year only, or a year and month only, and show a range of ages with an en dash (–). |
range=yes |
Accept a year or year/month, and show the range with "or". |
range=no |
Accept a year only, or year/month, but show only a single age as if full dates had been entered. |
round=on |
The age is rounded to the nearest least-significant time unit. |
sc=on |
A serial comma is used (only useful when three or more values are displayed). |
sc=yes |
Same as sc=on.
|
show=hide |
The age is not displayed; may be useful with sortable=on.
|
sortable=on |
Insert a hidden sort key before the result (for use in sortable tables). |
sortable=table |
Insert a sort key using table syntax data-sort-value="value"|.
|
sortable=debug |
Same as sortable=on but the sort key is displayed for testing.
|
sortable=off |
No sort key (can override the default for a template like {{age nts}}). |
Examples using the range parameter follow.
{{age in years and months|year=2001|month=1|year2=2012|month2=2|range=yes}}→ 11 years, 0 or 1 month{{age in years and months|2001|1||2012|2|range=yes}}→ 11 years, 0 or 1 month{{age in years and months|Jan 2001|Feb 2012|range=yes}}→ 11 years, 0 or 1 month{{age in years and months|Jan 2001|Feb 2012|range=dash}}→ 11 years, 0–1 month{{age in years and months|Jan 2001|Feb 2012|range=no}}→ 11 years, 1 month assume 1 Jan 2001 to 1 Feb 2012{{age in years and months|12 Jan 2001|Feb 2012|range=no}}→ 11 years, 1 month assume 12 Jan 2001 to 12 Feb 2012{{age in years and months|2001|2012|range=no}}→ 11 years assume 1 Jan 2001 to 1 Jan 2012{{age in years and months|2001|23 Feb 2012|range=no}}→ 11 years assume 23 Feb 2001 to 23 Feb 2012
The sort key is based on the age in days, and fractions of a day if a time is specified.
{{age in years and months|10 Jan 2001|20 Feb 2012|sortable=debug}}→ 7003405800000000000♠11 years, 1 month{{age in years and months|10 Jan 2001|6:00 am 20 Feb 2012|sortable=debug}}→ 7003405825000000000♠11 years, 1 month{{age in years and months|10 Jan 2001|6:00 am 20 Feb 2012|sortable=debug|show=hide}}→ 7003405825000000000♠
An extra day is added for a duration.
{{age in years and months|20 Jan 2001|19 Feb 2012}}→ 11 years one day short of 11 years, 1 month{{age in years and months|20 Jan 2001|19 Feb 2012|duration=on}}→ 11 years, 1 month
The least-significant time unit can be rounded.
{{age in years and months|20 Jan 2001|10 Feb 2012}}→ 11 years{{age in years and months|20 Jan 2001|10 Feb 2012|round=on}}→ 11 years, 1 month round to nearest month
Large numbers can be formatted with commas.
{{age in years and months|120|2012|format=commas|range=yes}}→ 1,891 or 1,892 years{{age in years and months|120|2012|format=commas|range=dash}}→ 1,891–1,892 years
Spelling numbers
The templates that use age_generic can display numbers in words rather than using numerals. The result can be a cardinal number (such as "five") or an ordinal number (such as "fifth"). The first letter can be in uppercase, and US spelling of numbers can be used. Examples:
{{age|1898|01|01|2018|02|01|format=cardinal}}→ one hundred and twenty{{age|1898|01|01|2018|02|01|format=cardinal_us}}→ one hundred twenty{{age|1898|01|01|2018|02|01|format=Cardinal}}→ One hundred and twenty{{age|1898|01|01|2018|02|01|format=Cardinal_us}}→ One hundred twenty{{age|1898|01|01|2018|02|01|format=Ordinal}}→ One hundred and twentieth{{age|1898|01|01|2018|02|01|format=Ordinal_us}}→ One hundred twentieth{{age|1898|01|01|2018|02|01|format=ordinal}}→ one hundred and twentieth{{age|1898|01|01|2018|02|01|format=ordinal_us}}→ one hundred twentieth{{age|1980|1990|range=yes|format=Cardinal}}→ Nine or ten{{age in years, months and days|April 1980|1995|format=Cardinal|range=yes}}→ Template:Age in years, months and days