Template:End date/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 01:21, 24 July 2022

This is a documentation subpage for Template:End date.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 90,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Usage

This template ({{End date}}) returns a date, or date-time. It also include the same date (and time) duplicated in a hidden (by CSS) ISO date format, for use inside other templates which emit microformats. It should not be used outside such templates. The hidden date degrades gracefully when CSS is not available.

Syntax

{{End date|year|month|day}}

Examples:

{{End date|1993|2|24}} → "February 24, 1993 (1993-02-24)"
{{End date|1993|2|24|08|30}} → "08:30, February 24, 1993 (1993-02-24T08:30)"

An optional parameter, df, can be set to "y" or "yes" (or indeed any value) to display the day before the month. This is primarily used in articles about events in parts of the world where the day precedes the month in a date.

Examples:

{{End date|1993|2|24|df=yes}} → "24 February 1993 (1993-02-24)"

Parameters

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

TemplateData for End date

Date that an event or entity ended or was dissolved

Template parameters
Parameter		Description	Type	Status
YYYY	`1`	end year	Number	optional
MM	`2`	end month	Number	optional
DD	`3`	end day of month	Number	optional
HH	`4`	end hours	Number	optional
MM	`5`	end minutes Default 0	Number	optional
SS	`6`	end seconds Default 0	Number	optional
TZ	`7`	time zone offset, “+02:00”, “-06:00” or “Z” for UTC	Line	optional
day first	`df`	boolean parameter to put the date before the month name Default false	Line	optional

Use in microformats

The template returns the date as hCalendar's (class="dtend"). For example:

(<span class="dtend">1993-02-24T08:30</span>)

(disable CSS or view source to see the hidden ISO-formatted output).

Note: due to the requirement exclusive "dtend" in hCalendar, and the accessibility problems that presents when a date is rendered (as seen without CSS) as 28 March 1999 (1999-03-29) or even 28 February 1999 (1999-03-01) or 31 December 1999 (2000-01-01), the Date end template should not be used for whole-day dates and should have a time of 24:00:00 or 23:59:59.

See the microformats project for further details.

Example

{{End date|2016|12|31}} → December 31, 2016

December&nbsp;31,&nbsp;2016<span style="display:none">&#160;(<span class="dtend itvend">2016-12-31</span>)</span>

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
 <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
+{{high-use|40000}}
 == Usage ==
@@ Line 12: / Line 13: @@
 Examples:
-*{{tlx|End date|1993|2|24}} -→ "{{End date|1993|2|24}}"
+*{{tlx|End date|1993|2|24}} → "{{End date|1993|2|24}}"
 *{{tlx|End date|1993|2|24|08|30}} → "{{End date|1993|2|24|08|30}}"
@@ Line 19: / Line 20: @@
 Examples:
-*{{tlx|End date|1993|2|24|df=yes}} → "{{End date|1993|2|24|df=yes}}"
+*{{tlx|End date|1993|2|24|df{{=}}yes}} → "{{End date|1993|2|24|df=yes}}"
-'''Note:''' The template will appear broken when the parameters are left blank (as seen above).
 === Parameters ===
@@ Line 46: / Line 45: @@
 (disable CSS or view source to see the hidden ISO-formatted output).
-'''Note: due to the requirement exclusive "dtend" in [[hCalendar]], and the accessibility problems that presents when a date is rendered (as seen without CSS) as <tt>28 March 1999 (1999-03-29)</tt> or even <tt>28 February 1999 (1999-03-01)</tt> or <tt>31 December 1999 (2000-01-01)</tt>, the ''Date end'' template should '''not''' be used for whole-day dates and should have a time of 24:00:00 or 23:59:59.'''
+'''Note: due to the requirement exclusive "dtend" in [[hCalendar]], and the accessibility problems that presents when a date is rendered (as seen without CSS) as <kbd>28 March 1999 (1999-03-29)</kbd> or even <kbd>28 February 1999 (1999-03-01)</kbd> or <kbd>31 December 1999 (2000-01-01)</kbd>, the ''Date end'' template should '''not''' be used for whole-day dates and should have a time of 24:00:00 or 23:59:59.'''
 See [[WP:UF|the microformats project]] for further details.
+=== Example ===
+{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{End date|2016|12|31}}</nowiki>}}
 == See also ==
 *'''{{tl|Start date}}'''
+*'''{{tl|Start and end dates}}'''
+*{{tl|trim date}}
+{{Birth, death and age templates|dates}}
-<includeonly>
+<includeonly>{{Sandbox other||
 <!-- ADD CATEGORIES BELOW THIS LINE -->
 [[Category:Date mathematics templates|{{PAGENAME}}]]
 [[Category:Templates generating hCalendars|{{PAGENAME}}]]
+}}</includeonly>
-<!-- ADD INTERWIKIS BELOW THIS LINE -->
-</includeonly>
-<includeonly>
-[[ca:Plantilla:Data final]]
-[[id:Templat:End date]]
-[[jv:Cithakan:End date]]
-[[ja:Template:End date]]
-[[ka:თარგი:დაასრულე თარიღი]]
-[[simple:Template:End date]]
-[[sl:Predloga:End date]]
-[[sv:Mall:End date]]
-[[zh:Template:End date]]
-</includeonly>