Editing Template:Death date/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
{{High-use}}
{{Tracks Wikidata|P570}}
{{Lua|Module:String|Module:Wd}}

'''{{NAMESPACE}}:{{BASEPAGENAME}}''' will return a person's date of death. 

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.

== Usage ==
: <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|<var>year of death</var>|<var>month of death</var>|<var>day of death</var>|<var>additional parameters</var><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. {{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 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.

=== Range, Calendar ===
Since the data is emitted in the [[ISO 8601]] format, the calendar must be the Gregorian calendar; the first acceptable year is 1583, the last acceptable year is 9999 (which would only be a concern for fictitious characters).

== Examples ==
{{nowiki template demo|format=inline|code=<nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|1993|2|24}}</nowiki>}}
{{nowiki template demo|format=inline|code=<nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|1993|2|24|df=yes}}</nowiki>}}
{{nowiki template demo|format=inline|code=<nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>|1993|2|24|mf=yes}}</nowiki>}}

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"description": "This template will return a person's date of death. 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 death",
			"description": "The year in which the person died.",
			"type": "number",
			"example": "1993",
			"required": true
		},
		"2": {
			"label": "Month of death",
			"description": "The month (number) in which the person died.",
			"type": "number",
			"example": "2",
			"required": true
		},
		"3": {
			"label": "Day of death",
			"description": "The day (number) in which the person died.",
			"type": "number",
			"example": "24",
			"required": true
		},
		"df": {
			"label": "Day first",
			"description": "When set to 'y' or 'yes', the date of death 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 death.",
			"type": "string",
			"example": "y",
			"required": false
		}
	}
}
</templatedata>

== Tracking categories ==
* {{clc|Pages using age template with invalid date}}
* {{clc|Date of death not in Wikidata}}
* {{clc|Articles without Wikidata item}}

== See also ==
* {{tl|Death date text}} which accepts formats like "1 April 1990" or "April 1, 1990"
* {{tl|Death date and age}} or {{tl|Death-date and age}} if date of birth is known

{{Birth, death and age templates}}

<includeonly>{{sandbox other||
[[Category:Date mathematics templates]]
[[Category:Templates generating microformat dates]]
[[Category:Templates generating hCalendars]]
[[Category:Templates that add a tracking category]]
}}</includeonly>