Template:Death date/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older edit
VisualWikitext
meta>Sardanaphalus
removed heading and link (now in template), sandbox non-categorisation
Ookami (talk | contribs)
1,664 edits
m 40 revisions imported
 
(13 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<includeonly>{{high-use|7,000+}}</includeonly>
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->
{{High-use|8230}}
{{Tracks Wikidata|P570}}


Returns a person's date of death.
'''{{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.
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.


===Range, Calendar===
== Usage ==
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).
: <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>


===Syntax===
=== Additional parameters ===
====To display the death date only====
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}}.
: <tt><nowiki>{{</nowiki>{{PAGENAME}}<nowiki>|</nowiki></tt>''year of death''<tt><nowiki>|</nowiki></tt>''month of death''<tt><nowiki>|</nowiki></tt>''day of death''<tt><nowiki>|</nowiki>''additional parameters''<nowiki>}}</nowiki></tt> where the month, day, and year are in the Gregorian calendar. '''Use of this template with non-Gregorian dates creates false hidden metadata.'''


====Examples====
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.
:<nowiki>{{Death date|1993|2|4|df=yes}}</nowiki> returns "{{Death date|1993|2|4|df=yes}}"
:<nowiki>{{Death date|1993|2|4|mf=yes}}</nowiki> returns "{{Death date|1993|2|4|mf=yes}}"


'''Note''': The template will appear broken when the parameters are left blank.
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.


==="day first" (df) and "month first" (mf) options===
Do not specify both "df" and "mf" parameters in the same use of the template, as these formats are mutually exclusive.
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 articles about people from parts of the world where the day almost always precedes the month in a date (e.g. Europe). In such articles the parameter, "df", should be set to display the day before the month.
=== 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).


The parameter "mf" 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.
== 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>}}


Do not specify both "df" and "mf" parameters in the same use of the template, as these formats are mutually exclusive.
== 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>


Examples:
== Tracking categories ==
:<nowiki>{{Death date | 1993 | 2 | 24 | df=yes }}</nowiki> displays "24 February 1993".
* {{clc|Pages using age template with invalid date}}
:<nowiki>{{Death date | 1993 | 2 | 24 | mf=yes }}</nowiki> displays "February 24, 1993".
* {{clc|Date of death not in Wikidata}}
* {{clc|Articles without Wikidata item}}


== See also ==
* {{tl|Death-date}} 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}}
{{Birth, death and age templates}}


<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
<includeonly>{{sandbox other||
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Date mathematics templates]]
[[Category:Date mathematics templates]]
[[Category:Templates generating microformat dates]]
[[Category:Templates generating microformat dates]]
[[Category:Templates generating hCalendars]]
[[Category:Templates generating hCalendars]]
[[Category:Templates that add a tracking category]]
}}</includeonly>
}}</includeonly>

Latest revision as of 13:17, 3 September 2020

This template tracks the Wikidata property:

Template:Death date 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

{{Death date|year of death|month of death|day of death|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=y or |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 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

  • {{Death date|1993|2|24}} → (1993-02-24)February 24, 1993
  • {{Death date|1993|2|24|df=yes}} → (1993-02-24)24 February 1993
  • {{Death date|1993|2|24|mf=yes}} → (1993-02-24)February 24, 1993

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Death date

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.

Template parameters

ParameterDescriptionTypeStatus
Year of death1

The year in which the person died.

Example
1993
Numberrequired
Month of death2

The month (number) in which the person died.

Example
2
Numberrequired
Day of death3

The day (number) in which the person died.

Example
24
Numberrequired
Day firstdf

When set to 'y' or 'yes', the date of death 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 death.

Example
y
Stringoptional

Tracking categories

See also


Retrieved from "https://zoophilia.wiki/index.php?title=Template:Death_date/doc&oldid=82632"