Template:Birth date/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
(Created page with "{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> '''{{NAMESPACE}}:{{BASEPAGENAME}}''' will return a person's date of birth....")
 
mNo edit summary
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
{{Lua|Module:String}}
{{Support|Template:MONTHNAME|Template:MONTHNUMBER|Template:Main other}}
__NOTOC__


'''{{NAMESPACE}}:{{BASEPAGENAME}}''' 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.
{{tlb|Birth date}} will return a person's date of birth. Using this template rather than simply inserting the date into articles is mostly for ease and formatting.


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 10:
== Usage ==
== Usage ==
; Unnamed parameters for year, month, day
; Unnamed parameters for year, month, day
: <code><nowiki>{{</nowiki>Birth date|''year of birth''|''month of birth''|''day of birth''|''additional parameters''<nowiki>}}</nowiki></code>
: {{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
: <code><nowiki>{{</nowiki>Birth date|year=''year of birth''|month=''month of birth''|day=''day of birth''|''additional parameters''<nowiki>}}</nowiki></code>
: {{tji|Birth date|year:year of birth|month:month of birth|day:day of birth|additional parameters}}


=== 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. <code>|df|y</code> or <code>|df|yes</code>.
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, "df", should be set to display the day before the month.
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 "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.
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 "df" and "mf" parameters in the same use of the template, as these formats are mutually exclusive.
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 ===
This template also returns the date, hidden by CSS, in the [[WP:ISO 8601|ISO 8601]] standard. For example:
: <code><nowiki>(<span class="bday">1993-02-24</span>)</nowiki></code>
Because the ISO 8601 standard requires the [[Wikipedia:Gregorian calendar|Gregorian calendar]], this template should not be used if the date is given in the [[Wikipedia:Julian calendar|Julian calendar]].
 
For further information, visit [[Wikipedia:WikiProject Microformats|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 ==
== Examples ==
Unnamed parameters for year, month, day:
Unnamed parameters for year, month, day:
:<code><nowiki>{{</nowiki>Birth date|1993|2|24<nowiki>}}</nowiki></code> returns "{{Birth date|1993|2|24}}"
: {{tlc|Birth date|1993|2|24}} {{Rarr}} {{Birth date|1993|2|24}}
:<code><nowiki>{{</nowiki>Birth date|1993|2|24|df=yes<nowiki>}}</nowiki></code> returns "{{Birth date|1993|2|24|df=yes}}"
: {{tlc|Birth date|1993|2|24|df{{=}}yes}} {{Rarr}} {{Birth date|1993|2|24|df=yes}}
:<code><nowiki>{{</nowiki>Birth date|1993|2|24|mf=yes<nowiki>}}</nowiki></code> returns "{{Birth date|1993|2|24|mf=yes}}"
: {{tlc|Birth date|1993|2|24|mf{{=}}yes}} {{Rarr}} {{Birth date|1993|2|24|mf=yes}}


Named parameters for year, month, day:
Named parameters for year, month, day:
: <code><nowiki>{{</nowiki>Birth date|year=1993|month=2|day=24<nowiki>}}</nowiki></code> returns "{{Birth date|year=1993|month=2|day=24}}
: {{tlc|Birth date|year{{=}}1993|month{{=}}2|day{{=}}24}} {{Rarr}} {{Birth date|year=1993|month=2|day=24}}
: <code><nowiki>{{</nowiki>Birth date|year=1993|month=2|day=24|df=yes<nowiki>}}</nowiki></code> returns "{{Birth date|year=1993|month=2|day=24|df=yes}}
: {{tlc|Birth date|year{{=}}1993|month{{=}}2|day{{=}}24|df{{=}}yes}} {{Rarr}} {{Birth date|year=1993|month=2|day=24|df=yes}}
: <code><nowiki>{{</nowiki>Birth date|year=1993|month=2|day=24|mf=yes<nowiki>}}</nowiki></code> returns "{{Birth date|year=1993|month=2|day=24|mf=yes}}
: {{tlc|Birth date|year{{=}}1993|month{{=}}2|day{{=}}24|mf{{=}}yes}} {{Rarr}} {{Birth date|year=1993|month=2|day=24|mf=yes}}
 
== See also ==
* {{tl|Birth date and age}}
* {{tl|Birth date no year}}


== TemplateData ==
== TemplateData ==
<templatedata>
<templatedata>
{
{
"description": "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.",
"description": "This template will return a person's date of birth. Using this template rather than simply inserting the date into articles is mostly for ease and formatting.",
"params": {
"params": {
"1": {
"1": {
Line 97: Line 92:
</templatedata>
</templatedata>


== See also ==
* {{tl|Birth date and age}} for living people


<includeonly>{{sandbox other||
<includeonly>{{sandbox other||{{testcases other||
<!----- CATEGORIES BELOW THIS LINE, PLEASE: ----->


[[Category:Date mathematics templates]]
<!-- Categories below this line, please -->
}}</includeonly>
[[Category:Infobox formatting templates]]
}}}}</includeonly>

Latest revision as of 03:16, 20 August 2023

Light bulb.png }}
It contains usage information, categories and other content that is not part of the original template page.


{{Birth date}} will return a person's date of birth. Using this template rather than simply inserting the date into articles is mostly for ease and formatting.

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.

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

See also

TemplateData

This template will return a person's date of birth. Using this template rather than simply inserting the date into articles is mostly for ease and formatting.

Template parameters

ParameterDescriptionTypeStatus
Year of birth1 year

The year in which the person was born.

Example
1993
Numberrequired
Month of birth2 month

The month (number) in which the person was born.

Example
2
Numberrequired
Day of birth3 day

The day (number) in which the person was born.

Example
24
Numberrequired
Day firstdf

When set to 'y' or 'yes', the date of birth is output in a DMY format.

Example
y
Stringoptional
Month firstmf

When set to 'y' or 'yes', stresses that the default MDY date format is intended for the date of birth.

Example
y
Stringoptional