Template:Birth date/doc: Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{ | {{Lua|Module:String}} | ||
{{Support|Template:MONTHNAME|Template:MONTHNUMBER|Template:Main other}} | |||
{{tlb|Birth date}} will return a person's date of birth. 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. | |||
For an article about a living person, consider using {{tl|Birth date and age}} instead. | For an article about a living person, consider using {{tl|Birth date and age}} instead. | ||
Line 8: | Line 9: | ||
== Usage == | == Usage == | ||
; Unnamed parameters for year, month, day | ; Unnamed parameters for year, month, day | ||
: | : {{tji|Birth date|''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|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|y}} or {{para||df|yes}}. | ||
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. | ||
=== hCard microformat === | === hCard microformat === | ||
Line 35: | Line 36: | ||
== Examples == | == Examples == | ||
Unnamed parameters for year, month, day: | Unnamed parameters for year, month, day: | ||
: | : {{tlc|Birth date|1993|2|24}} → "{{Birth date|1993|2|24}}" | ||
: | : {{tlc|Birth date|1993|2|24|df{{=}}yes}} → "{{Birth date|1993|2|24|df=yes}}" | ||
: | : {{tlc|Birth date|1993|2|24|mf{{=}}yes}} → "{{Birth date|1993|2|24|mf=yes}}" | ||
Named parameters for year, month, day: | Named parameters for year, month, day: | ||
: | : {{tlc|Birth date|year{{=}}1993|month{{=}}2|day{{=}}24}} → "{{Birth date|year=1993|month=2|day=24}} | ||
: | : {{tlc|Birth date|year{{=}}1993|month{{=}}2|day{{=}}24|df{{=}}yes}} → "{{Birth date|year=1993|month=2|day=24|df=yes}} | ||
: | : {{tlc|Birth date|year{{=}}1993|month{{=}}2|day{{=}}24|mf{{=}}yes}} → "{{Birth date|year=1993|month=2|day=24|mf=yes}} | ||
== TemplateData == | == TemplateData == | ||
Line 98: | Line 99: | ||
== See also == | == See also == | ||
* {{tl|Birth date and age}} | * {{tl|Birth date and age}} | ||
* {{tl|Birth date and no year}} | |||
<includeonly>{{sandbox other||{{testcases other|| | |||
<!-- Categories below this line, please --> | <!-- Categories below this line, please --> | ||
[[Category:Templates]] | [[Category:Templates]] | ||
</includeonly> | [[Category:General Use Templates]] | ||
}}}}</includeonly> |
Revision as of 03:07, 13 June 2023
It contains usage information, categories and other content that is not part of the original template page.
|
This template uses Lua: |
Supporting Templates |
{{Birth date}} will return a person's date of birth. 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.
For an article about a living person, consider using {{Birth date and age}} instead.
Usage
- Unnamed parameters for year, month, day
- {{Birth date
|year of birth |month of birth |day of birth |additional parameters}}
- Named parameters for year, month, day
- {{Birth date
|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
or |df
.
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.
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>)
Because the ISO 8601 standard requires the Gregorian calendar, this template should not be used if the date is given in the Julian calendar.
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.
Examples
Unnamed parameters for year, month, day:
{{Birth date|1993|2|24}}
→ "February 24, 1993"{{Birth date|1993|2|24|df=yes}}
→ "24 February, 1993"{{Birth date|1993|2|24|mf=yes}}
→ "February 24, 1993"
Named parameters for year, month, day:
{{Birth date|year=1993|month=2|day=24}}
→ "February 24, 1993{{Birth date|year=1993|month=2|day=24|df=yes}}
→ "24 February, 1993{{Birth date|year=1993|month=2|day=24|mf=yes}}
→ "February 24, 1993
TemplateData
This template will return a person's date of birth. 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 |
See also