Difference between revisions of "Template:Death date/doc"

From Ava Zinn Wiki
Jump to: navigation, search
[unchecked revision][unchecked revision]
(high-use (setting up sandbox & test cases))
(expand)
Line 7: Line 7:
 
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.
  
; Syntax<nowiki>:</nowiki>
+
===Syntax===
: <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></tt>
 
  
; Example<nowiki>:</nowiki>
+
====To display the death date only====
<nowiki>{{Death date | 1993 | 2 | 24}}</nowiki><br>returns {{Death date | 1993 | 2 | 24}}
 
  
An optional parameter, df, can be set (to "y" or "yes" for example) to display the day before the month. This is primarily used in articles about people from parts of the world where the day precedes the month in a date. Conversely the unimplemented parameter , mf, can be set as a hint for "month first", currently the default behaviour.
+
: <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>
  
; Example<nowiki>:</nowiki>
+
====Examples====
  
<nowiki>{{Death date | 1993 | 2 | 24 | df=yes}}</nowiki><br> returns "{{Death date | 1993 | 2 | 24 | df=yes}}"
+
:<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.
 
'''Note''': The template will appear broken when the parameters are left blank.
 +
 +
=== Day First (df) and Month First (mf) 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'''.
 +
 +
The default output of this template is to display the month before the day (American-based style). This default may not be appropriate articles about people from parts of the world where the day 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.
 +
 +
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.
 +
 +
Do not specify both "df" and "mf" parameters in the same use of the template, as these formats are mutually exclusive.
 +
 +
Examples:
 +
 +
:<nowiki>{{Death date | 1993 | 2 | 24 | df=yes }}</nowiki> displays "24 February 1993".
 +
:<nowiki>{{Death date | 1993 | 2 | 24 | mf=yes }}</nowiki> displays "February 24, 1993".
  
 
==See also==
 
==See also==

Revision as of 21:21, 27 September 2008

Template:Template doc page viewed directly

Usage

Returns 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.

Syntax

To display the death date only

{{Death date/doc|year of death|month of death|day of death|additional parameters}}

Examples

{{Death date|1993|2|4|df=yes}} returns "4 February 1993(1993-02-04)"
{{Death date|1993|2|4|mf=yes}} returns "February 4, 1993(1993-02-04)"

Note: The template will appear broken when the parameters are left blank.

Day First (df) and Month First (mf) 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.

The default output of this template is to display the month before the day (American-based style). This default may not be appropriate articles about people from parts of the world where the day 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.

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

Examples:

{{Death date | 1993 | 2 | 24 | df=yes }} displays "24 February 1993".
{{Death date | 1993 | 2 | 24 | mf=yes }} displays "February 24, 1993".

See also