Editing Template:Birth date and age/doc

{{Documentation subpage}}<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
{{Warning|''Do '''NOT''' use this template when the exact date of birth is disputed or unknown; consider {{tlp|Birth year and age}} instead.''}}
{{High-use| 520,000 }}
{{Template shortcut|bda}}
{{Lua|Module:Age}}

'''{{NAMESPACE}}:{{BASEPAGENAME}}''' 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 {{tlp|Birth date}} with {{tlp|Death date and age}}.

{{notice|heading=Is the displayed age incorrect?|1=The age displayed was calculated when the page was last [[Wikipedia:Purge|purged]]. If a particular article is showing the wrong age, edit the whole page and publish the edit without making any change and with no edit summary. That will update the age. The page can also be purged by appending <code>&action=purge</code> to the URL.}}

== Usage ==
; Unnamed parameters for year, month, day
: <code><nowiki>{{</nowiki>Birth date and age|''year of birth''|''month of birth''|''day of birth''|''additional parameters''<nowiki>}}</nowiki></code>
: <code><nowiki>{{</nowiki>bda|''year of birth''|''month of birth''|''day of birth''|''additional parameters''<nowiki>}}</nowiki></code>

; Named parameters for year, month, day
: <code><nowiki>{{</nowiki>Birth date and age|year=''year of birth''|month=''month of birth''|day=''day of birth''|''additional parameters''<nowiki>}}</nowiki></code>
: <code><nowiki>{{</nowiki>bda|year=''year of birth''|month=''month of birth''|day=''day of birth''|''additional parameters''<nowiki>}}</nowiki></code>

=== 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 [[WP: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.

=== Error tracking ===
Some kinds of invalid input are tracked in [[:Category:Pages using age template with invalid date]].

=== hCard microformat ===
This template also returns the date, hidden by CSS, in the [[WP:ISO 8601|ISO 8601]] standard.<ref>{{cite web | date = April 7, 2013 | url = http://microformats.org/wiki/date-pattern | title = Date Design Pattern | website = Microformats Wiki}}</ref>
<ref>{{cite web | date = August 28, 2009 | url = http://microformats.org/wiki/hcalendar-issues-closed | title = hCalendar closed issues | website = Microformats Wiki}} Specifically rejects supporting the Julian calendar.</ref> For example:
: <code><nowiki>(<span class="bday">1993-02-24</span>)</nowiki></code>
Note: For the "foundation", "built" and similar set-up dates of companies, buildings etc., use {{tl|start date}} (this will work for year-only or month-year dates). 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 [[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.
* When only the month or year of a person's birth and/or death are known, or if it is desired not to state a person's full dates of birth for privacy reasons, consider using the templates {{tlp|Birth year}} or {{tl|Birth year and age}} instead.

== Examples ==
; Unnamed parameters for year, month, day
: <code><nowiki>{{Birth date and age|1993|2|24}}</nowiki></code> returns "{{Birth date and age|1993|2|24}}"
: <code><nowiki>{{Birth date and age|1993|2|24|df=yes}}</nowiki></code> returns "{{Birth date and age|1993|2|24|df=yes}}"
: <code><nowiki>{{Birth date and age|1993|2|24|mf=yes}}</nowiki></code> returns "{{Birth date and age|1993|2|24|mf=yes}}"

; Named parameters for year, month, day
: <code><nowiki>{{Birth date and age|year=1993|month=2|day=24}}</nowiki></code> returns "{{Birth date and age|year=1993|month=2|day=24}}"
: <code><nowiki>{{Birth date and age|year=1993|month=2|day=24|df=yes}}</nowiki></code> returns "{{Birth date and age|year=1993|month=2|day=24|df=yes}}"
: <code><nowiki>{{Birth date and age|year=1993|month=2|day=24|mf=yes}}</nowiki></code> returns "{{Birth date and age|year=1993|month=2|day=24|mf=yes}}"

=== Using month name instead of number ===
The following examples use a parameter value that will not work in the {{tlp|Birth date}}, {{tlp|Death date}}, or {{tlp|Death date and age}} templates.

; Unnamed parameters for year, month name, day
: <code><nowiki>{{Birth date and age|1993|Feb|24}}</nowiki></code> returns "{{Birth date and age|1993|Feb|24}}"
: <code><nowiki>{{Birth date and age|1993|Feb|24|df=yes}}</nowiki></code> returns "{{Birth date and age|1993|Feb|24|df=yes}}"
: <code><nowiki>{{Birth date and age|1993|Feb|24|mf=yes}}</nowiki></code> returns "{{Birth date and age|1993|Feb|24|mf=yes}}"

; Named parameters for year, month name, day
: <code><nowiki>{{Birth date and age|year=1993|month=Feb|day=24}}</nowiki></code> returns "{{Birth date and age|year=1993|month=Feb|day=24}}"
: <code><nowiki>{{Birth date and age|year=1993|month=Feb|day=24|df=yes}}</nowiki></code> returns "{{Birth date and age|year=1993|month=Feb|day=24|df=yes}}"
: <code><nowiki>{{Birth date and age|year=1993|month=Feb|day=24|mf=yes}}</nowiki></code> returns "{{Birth date and age|year=1993|month=Feb|day=24|mf=yes}}"

=== Using full date in one parameter ===
The following examples use a parameter value that will not work in the {{tlp|Birth date}}, {{tlp|Death date}}, or {{tlp|Death date and age}} templates.

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 {{tlp|Birth-date and age}}).

; Unnamed parameter for full date (output in MDY format)
: <code><nowiki>{{Birth date and age|1993-2-24}}</nowiki></code> returns "{{Birth date and age|1993-2-24}}"
: <code><nowiki>{{Birth date and age|Feb 24, 1993}}</nowiki></code> returns "{{Birth date and age|Feb 24, 1993}}"
: <code><nowiki>{{Birth date and age|24 Feb 1993}}</nowiki></code> returns "{{Birth date and age|24 Feb 1993}}"

; Unnamed parameter for full date (output in DMY format)
: <code><nowiki>{{Birth date and age|1993-2-24|df=y}}</nowiki></code> returns "{{Birth date and age|1993-2-24|df=y}}"
: <code><nowiki>{{Birth date and age|24 Feb 1993|df=y}}</nowiki></code> returns "{{Birth date and age|24 Feb 1993|df=y}}"
: <code><nowiki>{{Birth date and age|Feb 24, 1993|df=y}}</nowiki></code> returns "{{Birth date and age|Feb 24, 1993|df=y}}"

; Output as compared to {{tlp|Birth-date and age}}
: <code><nowiki>{{Birth date and age|24 February 1993}}</nowiki></code> returns "{{Birth date and age|24 February 1993}}"
: <code><nowiki>{{Birth-date and age|24 February 1993}}</nowiki></code> returns "{{Birth-date and age|24 February 1993}}"
: <code><nowiki>{{Birth date and age|Feb. 24, 1993}}</nowiki></code> returns "{{Birth date and age|Feb. 24, 1993}}"
: <code><nowiki>{{Birth-date and age|Feb. 24, 1993}}</nowiki></code> returns "{{Birth-date and age|Feb. 24, 1993}}"

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>
{
	"description": "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.",
	"params": {
		"1": {
			"label": "Year of birth",
			"description": "The year in which the person was born",
			"type": "number",
			"example": "1993",
			"required": true,
			"aliases": [
				"year"
			]
		},
		"2": {
			"label": "Month of birth",
			"description": "The month (number) in which the person was born",
			"type": "number",
			"example": "2",
			"required": true,
			"aliases": [
				"month"
			]
		},
		"3": {
			"label": "Day of birth",
			"description": "The day (number) in which the person was born",
			"type": "number",
			"example": "24",
			"required": true,
			"aliases": [
				"day"
			]
		},
		"df": {
			"label": "Day first",
			"description": "When set to 'y' or 'yes', the date of birth is output in a DMY format",
			"type": "string",
			"example": "y",
			"required": false
		},
		"mf": {
			"label": "Month first",
			"description": "When set to 'y' or 'yes', stresses that the default MDY date format is intended for the date of birth",
			"type": "string",
			"example": "y",
			"required": false
		}
	}
}
</templatedata>

== References ==
{{reflist}}

== See also ==
* {{tl|Birth year and age}} for year of birth, with optional parameter for month
* {{tl|Birth-date and age}} which accepts formats like "1 April 1990" or "April 1, 1990"
* {{tl|Birth date}} or {{tl|Birth-date}} for a deceased person
* {{tl|Recent birth}}

{{Birth, death and age templates}}

<includeonly>{{sandbox other||
<!----- CATEGORIES BELOW THIS LINE, PLEASE: ----->
[[Category:Date mathematics templates]]
[[Category:Templates generating microformat date and age]]
}}</includeonly>