View source for Template:Death date and age/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->

This template returns a person's date of death and age at that date. The year, month, and day of death are required, as is the birth year. The month and day of birth are optional.

===Syntax===

====To display the death date with age====
: <code><nowiki>{{</nowiki>death date and age</code>
: <code>|''year of death''|''month of death''|''day of death''</code>
: <code>|''year of birth''|''month of birth''|''day of birth''</code>
: <code>|''additional parameters''}}</code>

; Formats:
: <code><nowiki>{{</nowiki>death date and age |yyyy|mm|dd |yyyy|mm|dd |df=yes}}</code>
: <code><nowiki>{{</nowiki>death date and age |yyyy|mm|dd |yyyy|mm|dd |mf=yes}}</code>

====Examples when all parameters are known====
: <code><nowiki>{{death date and age |1993|2|24 |1921|4|12 |df=yes}}</nowiki></code> returns:&nbsp; {{death date and age |1993|2|24 |1921|4|12 |df=yes}}
: <code><nowiki>{{death date and age |1993|2|24 |1921|4|12 |mf=yes}}</nowiki></code> returns:&nbsp; {{death date and age |1993|2|24 |1921|4|12 |mf=yes}}

====Examples when only death-related parameters are known====
: <code><nowiki>{{death date and age |1993|2|24 |1921|4 |df=yes}}</nowiki></code> returns:&nbsp; {{death date and age |1993|2|24 |1921|4 |df=yes}}
: <code><nowiki>{{death date and age |1993|2|24 |1921 |mf=yes}}</nowiki></code> returns:&nbsp; {{death date and age |1993|2|24 |1921 |mf=yes}}

When the exact birth date is unknown, the template will calculate the age at death and provide a range of two possible ages, if necessary.

''The template will generate an error when required parameters are left blank, or when parameters are invalid. Examples of invalid parameters include impossible human ages, months greater than 12 or less than 1, days greater than 31 or less than 1, and parameters in the wrong order.''

==="day first" (df) and "month first" options===
The '''df''' (day first) parameter indicates the intended date format to display. It is switched on by setting it to "y" or "yes" e.g. '''df=yes''' or '''df=y'''.

The default output of this template is the month before the day (American-based style). This default may not be appropriate in articles about people from parts of the world where the day precedes the month in a date (e.g. Europe). In such cases the parameter df should be set.

It is possible to use similar parameter "mf" to stress the month-first format so that relying on the default does not lead an editor or [[WP:bots|bot]] to change the format to an unintended value; however, it is ignored by the template itself. (So, should both parameters be mistakenly used at once, df takes precedence.)

Examples:
: <code><nowiki>{{death date and age |1993|2|24 |1921|4|12 |df=yes}}</nowiki></code> displays&nbsp; "{{death date and age |1993|2|24 |1921|4|12 |df=yes}}"
: <code><nowiki>{{death date and age |1993|2|24 |1921|4|12 |mf=yes}}</nowiki></code> displays&nbsp; "{{death date and age |1993|2|24 |1921|4|12 |mf=yes}}"

===Alternate template when specific birth date is unknown===
When only the year of a person's death is known, or if it is desired not to state a person's full dates of birth and death (e.g. for privacy), use the template {{tl|death year and age}} instead. See below for other templates that perform similar functions. 

===Background===
The idea of using the template, as with {{tl|birth date and age}} etc., is to allow for the inclusion of hidden [[Wikipedia:metadata|metadata]] to be used, indexed or searched by software tools. However, as of October 2008 this template does not include any such metadata and never has since it was founded in December 2006. The apparent reason is that the [[Wikipedia:hCard|hCard]] [[Wikipedia:microformat|mircoformat]], logically enough for an extension of "standard for electronic business cards", contains only "BDAY" field but nothing to do with a death. It is unclear when metadata standard for the dead will be developed and adopted. Until then, the template does nothing but format the input parameters.

Because the hCard specification requires the use of the Gregorian calendar, the template should not be used for dates stated in the Julian calendar.

===TemplateData===
<TemplateData>
{
        "description": "This template returns a person's date of death and age at that date.",
        "params": {
                "1": {
                        "label": "Year of death",
                        "description": "The year in which the person died",
                        "type": "number",
                        "required": true
                },
                "2": {
                        "label": "Month of death",
                        "description": "The month (number) in which the person died",
                        "type": "number",
                        "required": true
                },
                "3": {
                        "label": "Day of death",
                        "description": "The day (number) in which the person died",
                        "type": "number",
                        "required": true
                },
                "4": {
                        "label": "Year of birth",
                        "description": "The year in which the person was born",
                        "type": "number",
                        "required": true
                },
                "5": {
                        "label": "Month of birth",
                        "description": "The month (number) in which the person was born",
                        "type": "number",
                        "required": false
                },
                "6": {
                        "label": "Day of birth",
                        "description": "The day (number) in which the person was born",
                        "type": "number",
                        "required": false
                },
                "df": {
                        "label": "Day first",
                        "description": "When set to 'y' or 'yes', the date of death is output in a DMY format",
                        "type": "string",
                        "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 death",
                        "type": "string",
                        "required": false
                }
        }
}
</TemplateData>

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