Template:Birth date and age/doc: Difference between revisions
mNo edit summary |
mNo edit summary |
||
(3 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{ | {{Lua|Module:Age|Module:Check for unknown parameters}} | ||
{{tsh|Bda}} | |||
__NOTOC__ | |||
This template will return a living person's date of birth and age. Using this template rather than simply inserting the date into articles allows for the inclusion of hidden [[Wikipedia:metadata|metadata]] about the date. This metadata can be used by web browsers and other software tools to extract the details, and display them using some other website or mapping tool, index, or search them. | |||
This template is intended for use in an article about a living person. For an article about a dead person, use {{tl|Birth date}} with {{tl|Death date and age}}. | This template is intended for use in an article about a living person. For an article about a dead person, use {{tl|Birth date}} with {{tl|Death date and age}}. | ||
Line 8: | Line 10: | ||
== Usage == | == Usage == | ||
; Unnamed parameters for year, month, day | ; Unnamed parameters for year, month, day | ||
: | : {{tji|Birth date and age|''year of birth''|''month of birth''|''day of birth''|''additional parameters''}} | ||
: | : {{tji|bda|''year of birth''|''month of birth''|''day of birth''|''additional parameters''}} | ||
; Named parameters for year, month, day | ; Named parameters for year, month, day | ||
: | : {{tji|Birth date and age|year: ''year of birth''|month: ''month of birth''|day: ''day of birth''|''additional parameters''}} | ||
: | : {{tji|bda|year: ''year of birth''|month: ''month of birth''|day: ''day of birth''|''additional parameters''}} | ||
=== Additional parameters === | === Additional parameters === | ||
The | The {{para|df}} (day first) and {{para|mf}} (month first) parameters indicate the intended date format to display. The appropriate parameter should be set to "y" or "yes" e.g. {{para|df|yes}} or {{para|mf|y}}. | ||
The default output of this template is to display the month before the day. This default may not be appropriate for articles about people from parts of the world where the day precedes the month in a date. In such articles the parameter, | The default output of this template is to display the month before the day. This default may not be appropriate for articles about people from parts of the world where the day precedes the month in a date. In such articles the parameter, {{para|df}}, should be set to display the day before the month. | ||
The parameter | The parameter {{para|mf}}, while not actually used by the template, will indicate that month first format is intended. Using these parameters can assist [[Wikipedia:BOT|bots]] or other automated processing to detect which date format is intended; leaving the format as default may lead an editor or bot to change the format to an unintended value. | ||
Do not specify both | Do not specify both {{para|df}} and {{para|mf}} parameters in the same use of the template, as these formats are mutually exclusive. | ||
=== Error tracking === | === Error tracking === | ||
Some kinds of invalid input are tracked in | Some kinds of invalid input are tracked in {{c|Pages using age template with invalid date}}. | ||
=== hCard microformat === | === hCard microformat === | ||
Line 37: | Line 39: | ||
* '''Do not use with non-Gregorian dates''' because the resulting hCard hidden date will be false. | * '''Do not use with non-Gregorian dates''' because the resulting hCard hidden date will be false. | ||
* The template will appear broken when the parameters are left blank. | * The template will appear broken when the parameters are left blank. | ||
* When only the month | * When only the month and day of a person's birth are known, or if it is desired not to state a person's full dates of birth for privacy reasons, please use the {{tl|Bdy}} template instead. | ||
== Examples == | == Examples == | ||
; Unnamed parameters for year, month, day | ; Unnamed parameters for year, month, day | ||
: | : {{tlc|Birth date and age|1993|2|24}} {{Rarr}} {{Birth date and age|1993|2|24}} | ||
: | : {{tlc|Birth date and age|1993|2|24|df{{=}}yes}} {{Rarr}} {{Birth date and age|1993|2|24|df=yes}} | ||
: | : {{tlc|Birth date and age|1993|2|24|mf{{=}}yes}} {{Rarr}} {{Birth date and age|1993|2|24|mf=yes}} | ||
; Named parameters for year, month, day | ; Named parameters for year, month, day | ||
: | : {{tlc|Birth date and age|year{{=}}1993|month{{=}}2|day{{=}}24}} {{Rarr}} {{Birth date and age|year=1993|month=2|day=24}} | ||
: | : {{tlc|Birth date and age|year{{=}}1993|month{{=}}2|day{{=}}24|df{{=}}yes}} {{Rarr}} {{Birth date and age|year=1993|month=2|day=24|df=yes}} | ||
: | : {{tlc|Birth date and age|year{{=}}1993|month{{=}}2|day{{=}}24|mf{{=}}yes}} {{Rarr}} {{Birth date and age|year=1993|month=2|day=24|mf=yes}} | ||
=== Using month name instead of number === | === Using month name instead of number === | ||
The following examples use a parameter value that will not work in the {{tl|Birth date}} | The following examples use a parameter value that will not work in the {{tl|Birth date}} or {{tl|Death date and age}} templates. | ||
; Unnamed parameters for year, month name, day | ; Unnamed parameters for year, month name, day | ||
: | : {{tlc|Birth date and age|1993|Feb|24}} {{Rarr}} {{Birth date and age|1993|Feb|24}}" | ||
: | : {{tlc|Birth date and age|1993|Feb|24|df{{=}}yes}} {{Rarr}} {{Birth date and age|1993|Feb|24|df=yes}} | ||
: | : {{tlc|Birth date and age|1993|Feb|24|mf{{=}}yes}} {{Rarr}} {{Birth date and age|1993|Feb|24|mf=yes}} | ||
; Named parameters for year, month name, day | ; Named parameters for year, month name, day | ||
: | : {{tlc|Birth date and age|year{{=}}1993|month{{=}}Feb|day{{=}}24}} {{Rarr}} {{Birth date and age|year=1993|month=Feb|day=24}} | ||
: | : {{tlc|Birth date and age|year{{=}}1993|month{{=}}Feb|day{{=}}24|df{{=}}yes}} {{Rarr}} {{Birth date and age|year=1993|month=Feb|day=24|df=yes}} | ||
: | : {{tlc|Birth date and age|year{{=}}1993|month{{=}}Feb|day{{=}}24|mf{{=}}yes}} {{Rarr}} {{Birth date and age|year=1993|month=Feb|day=24|mf=yes}} | ||
=== Using full date in one parameter === | === Using full date in one parameter === | ||
The following examples use a parameter value that will not work in the {{tl|Birth date}} | The following examples use a parameter value that will not work in the {{tl|Birth date}} or {{tl|Death date and age}} templates. | ||
The date format entered does not change the date format displayed, which is MDY by default or DMY if | The date format entered does not change the date format displayed, which is MDY by default or DMY if {{para|df|y}} (to display the date in the same format it was entered, use {{tlf|Birth-date and age}}). | ||
; Unnamed parameter for full date (output in MDY format) | ; Unnamed parameter for full date (output in MDY format) | ||
: | : {{tlc|Birth date and age|1993-2-24}} {{Rarr}} {{Birth date and age|1993-2-24}} | ||
: | : {{tlc|Birth date and age|Feb 24, 1993}} {{Rarr}} {{Birth date and age|Feb 24, 1993}} | ||
: | : {{tlc|Birth date and age|24 Feb 1993}} {{Rarr}} {{Birth date and age|24 Feb 1993}} | ||
; Unnamed parameter for full date (output in DMY format) | ; Unnamed parameter for full date (output in DMY format) | ||
: | : {{tlc|Birth date and age|1993-2-24|df{{=}}y}} {{Rarr}} {{Birth date and age|1993-2-24|df=y}} | ||
: | : {{tlc|Birth date and age|24 Feb 1993|df{{=}}y}} {{Rarr}} {{Birth date and age|24 Feb 1993|df=y}} | ||
: {{tlc|Birth date and age|Feb 24, 1993|df{{=}}y}} {{Rarr}} {{Birth date and age|Feb 24, 1993|df=y}} | |||
: | |||
== TemplateData == | == TemplateData == | ||
Line 137: | Line 133: | ||
</templatedata> | </templatedata> | ||
<includeonly> | <includeonly>{{sandbox other||{{testcases other|| | ||
<!-- Categories below this line, please --> | <!-- Categories below this line, please --> | ||
[[Category: | [[Category:Infobox formatting templates]] | ||
</includeonly> | }}}}</includeonly> |
Latest revision as of 02:16, 20 August 2023
It contains usage information, categories and other content that is not part of the original template page.
|
This template uses Lua: |
This template will return a living person's date of birth and age. Using this template rather than simply inserting the date into articles allows for the inclusion of hidden metadata about the date. This metadata can be used by web browsers and other software tools to extract the details, and display them using some other website or mapping tool, index, or search them.
This template is intended for use in an article about a living person. For an article about a dead person, use {{Birth date}} with {{Death date and age}}.
Usage
- Unnamed parameters for year, month, day
- {{Birth date and age
|year of birth |month of birth |day of birth |additional parameters}} - {{bda
|year of birth |month of birth |day of birth |additional parameters}}
- Named parameters for year, month, day
- {{Birth date and age
|year=year of birth |month=month of birth |day=day of birth |additional parameters}} - {{bda
|year=year of birth |month=month of birth |day=day of birth |additional parameters}}
Additional parameters
The |df=
(day first) and |mf=
(month first) parameters indicate the intended date format to display. The appropriate parameter should be set to "y" or "yes" e.g. |df=yes
or |mf=y
.
The default output of this template is to display the month before the day. This default may not be appropriate for articles about people from parts of the world where the day precedes the month in a date. In such articles the parameter, |df=
, should be set to display the day before the month.
The parameter |mf=
, while not actually used by the template, will indicate that month first format is intended. Using these parameters can assist bots or other automated processing to detect which date format is intended; leaving the format as default may lead an editor or bot to change the format to an unintended value.
Do not specify both |df=
and |mf=
parameters in the same use of the template, as these formats are mutually exclusive.
Error tracking
Some kinds of invalid input are tracked in Pages using age template with invalid date.
hCard microformat
This template also returns the date, hidden by CSS, in the ISO 8601 standard.
For example:
(<span class="bday">1993-02-24</span>)
For further information, visit the microformats project.
Notes
- Do not use with non-Gregorian dates because the resulting hCard hidden date will be false.
- The template will appear broken when the parameters are left blank.
- When only the month and day of a person's birth are known, or if it is desired not to state a person's full dates of birth for privacy reasons, please use the {{Bdy}} template instead.
Examples
- Unnamed parameters for year, month, day
{{Birth date and age|1993|2|24}}
→ February 24, 1993{{Birth date and age|1993|2|24|df=yes}}
→ 24 February 1993{{Birth date and age|1993|2|24|mf=yes}}
→ February 24, 1993
- Named parameters for year, month, day
{{Birth date and age|year=1993|month=2|day=24}}
→ February 24, 1993{{Birth date and age|year=1993|month=2|day=24|df=yes}}
→ 24 February 1993{{Birth date and age|year=1993|month=2|day=24|mf=yes}}
→ February 24, 1993
Using month name instead of number
The following examples use a parameter value that will not work in the {{Birth date}} or {{Death date and age}} templates.
- Unnamed parameters for year, month name, day
{{Birth date and age|1993|Feb|24}}
→ February 24, 1993 "{{Birth date and age|1993|Feb|24|df=yes}}
→ 24 February 1993{{Birth date and age|1993|Feb|24|mf=yes}}
→ February 24, 1993
- Named parameters for year, month name, day
{{Birth date and age|year=1993|month=Feb|day=24}}
→ February 24, 1993{{Birth date and age|year=1993|month=Feb|day=24|df=yes}}
→ 24 February 1993{{Birth date and age|year=1993|month=Feb|day=24|mf=yes}}
→ February 24, 1993
Using full date in one parameter
The following examples use a parameter value that will not work in the {{Birth date}} or {{Death date and age}} templates.
The date format entered does not change the date format displayed, which is MDY by default or DMY if |df=y
(to display the date in the same format it was entered, use {{Birth-date and age}}).
- Unnamed parameter for full date (output in MDY format)
{{Birth date and age|1993-2-24}}
→ February 24, 1993{{Birth date and age|Feb 24, 1993}}
→ February 24, 1993{{Birth date and age|24 Feb 1993}}
→ February 24, 1993
- Unnamed parameter for full date (output in DMY format)
{{Birth date and age|1993-2-24|df=y}}
→ 24 February 1993{{Birth date and age|24 Feb 1993|df=y}}
→ 24 February 1993{{Birth date and age|Feb 24, 1993|df=y}}
→ 24 February 1993
TemplateData
This template will return a living person's date of birth and age. Using this template rather than simply inserting the date into articles allows for the inclusion of hidden metadata about the date. This metadata can be used by web browsers and other software tools to extract the details, and display them using some other website or mapping tool, index, or search them.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Year of birth | 1 year | The year in which the person was born
| Number | required |
Month of birth | 2 month | The month (number) in which the person was born
| Number | required |
Day of birth | 3 day | The day (number) in which the person was born
| Number | required |
Day first | df | When set to 'y' or 'yes', the date of birth is output in a DMY format
| String | optional |
Month first | mf | When set to 'y' or 'yes', stresses that the default MDY date format is intended for the date of birth
| String | optional |