Template:Birth date and age/doc: Difference between revisions

Revision as of 07:27, 11 July 2018

This is a documentation subpage for Template:Birth date and age.
It contains usage information, categories and other content that is not part of the original page.

Shortcut

{{bda}}

This template uses Lua:

Module:Age

Template:Birth date and age 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 Category:Pages using age template with invalid date.

hCard microformat

This template also returns the date, hidden by CSS, in the ISO 8601 standard.^[1] ^[2] For example:

(<span class="bday">1993-02-24</span>)

Note: For the "foundation", "built" and similar set-up dates of companies, buildings etc., use {{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 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 {{Birth year}} or {{Birth year and age}} instead.

Examples

Unnamed parameters for year, month, day: {{Birth date and age|1993|2|4|df=yes}} returns " (1993-02-04) 4 February 1993 (age 31)"; {{Birth date and age|1993|2|4|mf=yes}} returns " (1993-02-04) February 4, 1993 (age 31)"; {{Birth date and age|1993|2|4}} returns " (1993-02-04) February 4, 1993 (age 31)"

Named parameters for year, month, day: {{Birth date and age|year=1993|month=2|day=4|df=yes}} returns " (1993-02-04) 4 February 1993 (age 31)"; {{Birth date and age|year=1993|month=2|day=4|mf=yes}} returns " (1993-02-04) February 4, 1993 (age 31)"; {{Birth date and age|year=1993|month=2|day=4}} returns " (1993-02-04) February 4, 1993 (age 31)"

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Birth date and age

This template returns a living person's date of birth and current age (or age at a certain date).

Template parameters
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
Age at year	`4`	Optional date to calculate age	Unknown	optional
Age at month	`5`	Optional date to calculate age	Unknown	optional
Age at day	`6`	Optional date to calculate age	Unknown	optional
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

References

↑ "Date Design Pattern". Microformats Wiki. April 7, 2013.
↑ "hCalendar closed issues". Microformats Wiki. August 28, 2009. Specifically rejects supporting the Julian calendar.

@@ Line 1: / Line 1: @@
-{{Documentation subpage}}
+{{Documentation subpage}}<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
-<!-- 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.''}}<includeonly>
-{{Warning|''Do '''NOT''' use this template when the person's exact date of birth is disputed or unknown; consider {{tlp|birth year}} or {{tlp|birth year and age}} instead.''}}
+{{High-risk|520,000+}}</includeonly>
-<includeonly>{{#ifeq:{{#titleparts:{{PAGENAME}}|1}}|Birth date and age
+{{Template shortcut|bda}}
- |<!--Birth date and age--> {{High-risk|520,000+}} {{Lua|Module:Age}}
+{{Lua|Module:Age}}
- |<!--Birth date--> {{High-risk|230,000+}}
-}}</includeonly>
-The '''{{tl|Birth date}}''' and '''{{tl|Birth date and age}}''' templates will return a person’s date of birth and optionally his/her age. They have the shortcuts '''{{tl|dob}}''' and '''{{tl|bda}}''', respectively.
+'''{{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.
-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}}.
-===Syntax===
+== Usage ==
-====To display the birth date only====
+; Unnamed parameters for year, month, day
-: <code><nowiki>{{Birth date|year of birth|month of birth|day of birth|additional parameters}}</nowiki></code>
+: <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>
-'''Do not use with non-Gregorian dates''' because the resulting hCard hidden date will be false.
+; 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>
-===={{tl|dob}} is a redirect to {{tl|Birth date}}====
+=== Additional parameters ===
-: <code><nowiki>{{dob|year of birth|month of birth|day of birth|additional parameters}}</nowiki></code>
-====To display a birth date with calculated age====
-: <code><nowiki>{{Birth date and age|year of birth|month of birth|day of birth|additional parameters}}</nowiki></code>
-'''This form is only intended for living persons.''' For dead persons, use {{tl|birth date}}. In the rare case that a living person's birth date is given in a non-Gregorian calendar this template should not be used. The parameter names 'year', 'month', and 'day' can be used instead of the first, second, and third parameters for 'Birth date and age' only. These parameter names are not available for the 'Birth date' template.
-However, as per [[WP:DOB]], a full birth date for a living person should '''only''' be displayed when it can be cited as being '''widely''' published, or published with the clear approval of the person involved. Otherwise, use {{tl|birth year and age}} instead.
-===={{tl|Bda}} is a redirect to {{tl|Birth date and age}}====
-: <code><nowiki>{{Bda|year of birth|month of birth|day of birth|additional parameters}}</nowiki></code>
-Examples
-: <code><nowiki>{{Birth date|1993|2|4|df=yes}}</nowiki></code> returns "{{Birth date|1993|2|4|df=yes}}"
-: <code><nowiki>{{Birth date|1993|2|4|mf=yes}}</nowiki></code> returns "{{Birth date|1993|2|4|mf=yes}}"
-: <code><nowiki>{{Birth date|1993|2|4}}</nowiki></code> returns "{{Birth date|1993|2|4}}"
-: <code><nowiki>{{Birth date|1993|2|24|df=yes}}</nowiki></code> returns "{{Birth date|1993|2|24|df=yes}}"
-: <code><nowiki>{{Birth date|1993|2|24|mf=yes}}</nowiki></code> returns "{{Birth date|1993|2|24|mf=yes}}"
-: <code><nowiki>{{Birth date|1993|2|24}}</nowiki></code> returns "{{Birth date|1993|2|24}}"
-: <code><nowiki>{{Birth date and age|1993|2|4|df=yes}}</nowiki></code> returns {{Birth date and age|1993|2|4|df=yes}}
-: <code><nowiki>{{Birth date and age|1993|2|4|mf=yes}}</nowiki></code> returns {{Birth date and age|1993|2|4|mf=yes}}
-: <code><nowiki>{{Birth date and age|1993|2|4}}</nowiki></code> returns {{Birth date and age|1993|2|4}}
-: <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}}
-: <code><nowiki>{{Birth date and age|1993|2|24}}</nowiki></code> returns {{Birth date and age|1993|2|24}}
-===="month first" (mf) and "day first" (df) options====
 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'''.
@@ Line 53: / Line 27: @@
 Do not specify both "df" and "mf" parameters in the same use of the template, as these formats are mutually exclusive.
-Examples
+=== Error tracking ===
-: <code><nowiki>{{Birth date|1993|2|24|df=yes}}</nowiki></code> displays "{{Birth date|1993|2|24|df=yes}}".
+Some kinds of invalid input are tracked in [[:Category:Pages using age template with invalid date]].
-: <code><nowiki>{{Birth date and age|1993|2|24|df=yes}}</nowiki></code> displays "{{Birth date and age|1993|2|24|df=yes}}".
-: <code><nowiki>{{Birth date|1993|2|24|mf=yes}}</nowiki></code> displays "{{Birth date|1993|2|24|mf=yes}}".
-: <code><nowiki>{{Birth date and age|1993|2|24|mf=yes}}</nowiki></code> displays "{{Birth date and age|1993|2|24|mf=yes}}".
-===hCard microformat===
+=== hCard microformat ===
-The templates 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>
+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.
+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===
+=== Notes ===
-* The template will appear broken when the parameters are left blank (as seen above).
+* '''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 and death for privacy reasons, use the templates {{tl|Birth year and age}} and {{tl|Death year and age}} instead.
+* 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.
-===Error tracking===
-Some kinds of invalid input are tracked in [[:Category:Pages using age template with invalid date]].
-==See also==
+== Examples ==
-*{{tl|Birth date}}
+; Unnamed parameters for year, month, day
-*{{tl|Recent birth}}
+: <code><nowiki>{{Birth date and age|1993|2|4|df=yes}}</nowiki></code> returns "{{Birth date and age|1993|2|4|df=yes}}"
-* {{tl|Birth-date and age}} which also accepts formats like "1 April 1990"
+: <code><nowiki>{{Birth date and age|1993|2|4|mf=yes}}</nowiki></code> returns "{{Birth date and age|1993|2|4|mf=yes}}"
+: <code><nowiki>{{Birth date and age|1993|2|4}}</nowiki></code> returns "{{Birth date and age|1993|2|4}}"
-===References===
+; Named parameters for year, month, day
-{{reflist}}
+: <code><nowiki>{{Birth date and age|year=1993|month=2|day=4|df=yes}}</nowiki></code> returns "{{Birth date and age|year=1993|month=2|day=4|df=yes}}"
+: <code><nowiki>{{Birth date and age|year=1993|month=2|day=4|mf=yes}}</nowiki></code> returns "{{Birth date and age|year=1993|month=2|day=4|mf=yes}}"
+: <code><nowiki>{{Birth date and age|year=1993|month=2|day=4}}</nowiki></code> returns "{{Birth date and age|year=1993|month=2|day=4}}"
 ===TemplateData===
@@ Line 144: / Line 115: @@
 </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>{{#ifeq:{{SUBPAGENAME}}|sandbox |
+<includeonly>{{sandbox other||
-| {{#switch:{{BASEPAGENAME}}
-   |Birth date |Death date = [[Category:Templates generating microformat dates]]
-   | [[Category:Templates generating microformat date and age]]
-  }}
 <!----- CATEGORIES BELOW THIS LINE, PLEASE: ----->
 [[Category:Date mathematics templates]]
+[[Category:Templates generating microformat date and age]]
-[[el:Πρότυπο:Ημερομηνία γέννησης και ηλικία]]
-[[my:Template:Birth date and age]]
 }}</includeonly>