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

From blackwiki
Jump to navigation Jump to search
imported>Vanisaac
m (→‎See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
 
(20 intermediate revisions by 15 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 +
{{high-use|40000}}
  
 
== Usage ==
 
== Usage ==
  
This template ('''{{tl|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 in [[microformat]]s. This hidden date degrades gracefully when CSS is not available.
+
This template ('''{{tl|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 [[microformat]]s. It should not be used outside such templates. The hidden date degrades gracefully when CSS is not available.
  
 
==Syntax==
 
==Syntax==
  
:<nowiki>{{End date|year|month|day}}</nowiki>
+
:{{tlx|End date|''year''|''month''|''day''}}
  
 
Examples:
 
Examples:
  
*<s><nowiki>{{End date|1993|2|24}}</nowiki> returns "{{End date|1993|2|24}}"</s>
+
*{{tlx|End date|1993|2|24}} -→ "{{End date|1993|2|24}}"
*<nowiki>{{End date|1993|2|24|08|30}}</nowiki> returns "{{End date|1993|2|24|08|30}}"
+
*{{tlx|End date|1993|2|24|08|30}} "{{End date|1993|2|24|08|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.
 
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.
Line 19: Line 20:
 
Examples:
 
Examples:
  
*<s><nowiki>{{End date|1993|2|24|df=yes}}</nowiki> returns "{{End date|1993|2|24|df=yes}}"</s>
+
*{{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 ===
 +
{{TemplateDataHeader}}
 +
<templatedata>{
 +
"description": "Date that an event or entity ended or was dissolved",
 +
"params": {
 +
"1": {"label": "YYYY", "description": "end year", "type": "number"},
 +
"2": {"label": "MM", "description": "end month", "inherits": "1"},
 +
"3": {"label": "DD", "description": "end day of month", "inherits": "1"},
 +
"4": {"label": "HH", "description": "end hours", "inherits": "1"},
 +
"5": {"label": "MM", "description": "end minutes", "inherits": "1", "default": "0"},
 +
"6": {"label": "SS", "description": "end seconds", "inherits": "5"},
 +
"7": {"label": "TZ", "description": "time zone offset, “+02:00”, “-06:00” or “Z” for UTC", "inherits": "1", "type": "string/line"},
 +
"df": {"label": "day first", "description": "boolean parameter to put the date before the month name", "default": "false", "type": "string/line"}
 +
}}</templatedata>
  
 
== Use in microformats ==
 
== Use in microformats ==
Line 31: Line 45:
 
(disable CSS or view source to see the hidden ISO-formatted output).
 
(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 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.
 
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 ==
 
== See also ==
 
*'''{{tl|Start date}}'''
 
*'''{{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 -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
[[Category:Date mathematics templates|{{PAGENAME}}]]
 
[[Category:Date mathematics templates|{{PAGENAME}}]]
 
[[Category:Templates generating hCalendars|{{PAGENAME}}]]
 
[[Category:Templates generating hCalendars|{{PAGENAME}}]]
  
<!-- ADD INTERWIKIS BELOW THIS LINE -->
+
}}</includeonly>
[[ar:قالب:End date]]
 
[[bn:টেমপ্লেট:End date]]
 
[[ca:Plantilla:Data final]]
 
[[fa:الگو:تاریخ پایان]]
 
[[id:Templat:End date]]
 
[[jv:Cithakan:End date]]
 
[[ms:Templat:Tarikh akhir]]
 
[[simple:Template:End date]]
 
[[sl:Predloga:End date]]
 
[[sv:Mall:End date]]
 
[[ur:سانچہ:End date]]
 
[[zh:Template:End date]]
 
</includeonly>
 

Latest revision as of 01:25, 25 April 2020

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 documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for End date

Date that an event or entity ended or was dissolved

Template parameters

ParameterDescriptionTypeStatus
YYYY1

end year

Numberoptional
MM2

end month

Numberoptional
DD3

end day of month

Numberoptional
HH4

end hours

Numberoptional
MM5

end minutes

Default
0
Numberoptional
SS6

end seconds

Default
0
Numberoptional
TZ7

time zone offset, “+02:00”, “-06:00” or “Z” for UTC

Lineoptional
day firstdf

boolean parameter to put the date before the month name

Default
false
Lineoptional

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

Template:Nowiki template demo

See also