Difference between revisions of "Template:ISO end date/doc"

From blackwiki
Jump to navigation Jump to search
imported>WOSlinker
(tag fix)
imported>Jonesey95
m (Fix Linter errors using AutoEd)
 
Line 7: Line 7:
 
The template mat be used without any parameters, in which case it displays the current date:
 
The template mat be used without any parameters, in which case it displays the current date:
  
* <tt><nowiki>{{ISO end date}}</nowiki></tt> returns {{ISO end date}}
+
* <code><nowiki>{{ISO end date}}</nowiki></code> returns {{ISO end date}}
  
 
The template accepts one unnamed parameter containing a date in one of the following formats:
 
The template accepts one unnamed parameter containing a date in one of the following formats:
  
* <tt><nowiki>{{ISO end date|15 January 2001}}</nowiki></tt> returns {{ISO end date|15 January 2001}}
+
* <code><nowiki>{{ISO end date|15 January 2001}}</nowiki></code> returns {{ISO end date|15 January 2001}}
* <tt><nowiki>{{ISO end date|15 Jan 2001}}</nowiki></tt> returns {{ISO end date|15 Jan 2001}}
+
* <code><nowiki>{{ISO end date|15 Jan 2001}}</nowiki></code> returns {{ISO end date|15 Jan 2001}}
* <tt><nowiki>{{ISO end date|15-01-2001}}</nowiki></tt> returns {{ISO end date|15-01-2001}}
+
* <code><nowiki>{{ISO end date|15-01-2001}}</nowiki></code> returns {{ISO end date|15-01-2001}}
  
* <tt><nowiki>{{ISO end date|January 15, 2001}}</nowiki></tt> returns {{ISO end date|January 15, 2001}}
+
* <code><nowiki>{{ISO end date|January 15, 2001}}</nowiki></code> returns {{ISO end date|January 15, 2001}}
* <tt><nowiki>{{ISO end date|Jan 15, 2001}}</nowiki></tt> returns {{ISO end date|Jan 15, 2001}}
+
* <code><nowiki>{{ISO end date|Jan 15, 2001}}</nowiki></code> returns {{ISO end date|Jan 15, 2001}}
* <tt><nowiki>{{ISO end date|Jan. 15, 2001}}</nowiki></tt> returns {{ISO end date|Jan. 15, 2001}}
+
* <code><nowiki>{{ISO end date|Jan. 15, 2001}}</nowiki></code> returns {{ISO end date|Jan. 15, 2001}}
* <tt><nowiki>{{ISO end date|01/15/2001}}</nowiki></tt> returns {{ISO end date|01/15/2001}}
+
* <code><nowiki>{{ISO end date|01/15/2001}}</nowiki></code> returns {{ISO end date|01/15/2001}}
  
* <tt><nowiki>{{ISO end date|January 2001}}</nowiki></tt> returns {{ISO end date|January 2001}}
+
* <code><nowiki>{{ISO end date|January 2001}}</nowiki></code> returns {{ISO end date|January 2001}}
* <tt><nowiki>{{ISO end date|Jan 2001}}</nowiki></tt> returns {{ISO end date|Jan 2001}}
+
* <code><nowiki>{{ISO end date|Jan 2001}}</nowiki></code> returns {{ISO end date|Jan 2001}}
  
* <tt><nowiki>{{ISO end date|2001}}</nowiki></tt> returns {{ISO end date|2001}}
+
* <code><nowiki>{{ISO end date|2001}}</nowiki></code> returns {{ISO end date|2001}}
  
 
Formats for which it can not work because [[Help:Time function|#time]] returns an error or an incorrect ISO format:
 
Formats for which it can not work because [[Help:Time function|#time]] returns an error or an incorrect ISO format:
  
* <tt><nowiki>{{ISO end date|01-15-2001}}</nowiki></tt> returns {{ISO end date|01-15-2001}} ''(hyphens indicate DD-MM-YYYY and 15 is an invalid month number)''
+
* <code><nowiki>{{ISO end date|01-15-2001}}</nowiki></code> returns {{ISO end date|01-15-2001}} ''(hyphens indicate DD-MM-YYYY and 15 is an invalid month number)''
* <tt><nowiki>{{ISO end date|15/01/2001}}</nowiki></tt> returns {{ISO end date|15/01/2001}} ''(slashes indicate MM/DD/YYYY and 15 is an invalid month number)''
+
* <code><nowiki>{{ISO end date|15/01/2001}}</nowiki></code> returns {{ISO end date|15/01/2001}} ''(slashes indicate MM/DD/YYYY and 15 is an invalid month number)''
* <tt><nowiki>{{ISO end date|1/2001}}</nowiki></tt> returns {{ISO end date|1/2001}}
+
* <code><nowiki>{{ISO end date|1/2001}}</nowiki></code> returns {{ISO end date|1/2001}}
* <tt><nowiki>{{ISO end date|2001 January 15}}</nowiki></tt> returns {{ISO end date|2001 January 15}}
+
* <code><nowiki>{{ISO end date|2001 January 15}}</nowiki></code> returns {{ISO end date|2001 January 15}}
* <tt><nowiki>{{ISO end date|2001 January}}</nowiki></tt> returns {{ISO end date|2001 January}} ''(expected: {{ISO end date|January 2001}})''
+
* <code><nowiki>{{ISO end date|2001 January}}</nowiki></code> returns {{ISO end date|2001 January}} ''(expected: {{ISO end date|January 2001}})''
  
 
== Use in microformats ==
 
== Use in microformats ==
 
This template also wraps the date in the <code>dtend</code> classes needed by the [[hCalendar]] [[microformat]] - usually, but not always, within infobox or similar templates, or tables.
 
This template also wraps the date in the <code>dtend</code> classes needed by the [[hCalendar]] [[microformat]] - usually, but not always, within infobox or similar templates, or tables.
  
'''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>, this template should '''not''' be used for whole-day dates.'''
+
'''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 <code>28 March 1999 (1999-03-29)</code> or even <code>28 February 1999 (1999-03-01)</code> or <code>31 December 1999 (2000-01-01)</code>, this template should '''not''' be used for whole-day dates.'''
  
 
== See also ==
 
== See also ==

Latest revision as of 19:14, 4 June 2020

This template converts dates to ISO dates (YYYY-MM-DD or YYYY-MM or YYYY as appropriate), see below for restrictions on input formats accepted.

Usage

The template mat be used without any parameters, in which case it displays the current date:

  • {{ISO end date}} returns 2026-01-11

The template accepts one unnamed parameter containing a date in one of the following formats:

  • {{ISO end date|15 January 2001}} returns 2001-01-15
  • {{ISO end date|15 Jan 2001}} returns 2001-01-15
  • {{ISO end date|15-01-2001}} returns 2001-01-15
  • {{ISO end date|January 15, 2001}} returns 2001-01-15
  • {{ISO end date|Jan 15, 2001}} returns 2001-01-15
  • {{ISO end date|Jan. 15, 2001}} returns 2001-01-15
  • {{ISO end date|01/15/2001}} returns 2001-01-15
  • {{ISO end date|January 2001}} returns 2001-01
  • {{ISO end date|Jan 2001}} returns 2001-01
  • {{ISO end date|2001}} returns 2001

Formats for which it can not work because #time returns an error or an incorrect ISO format:

  • {{ISO end date|01-15-2001}} returns Error: Invalid time. (hyphens indicate DD-MM-YYYY and 15 is an invalid month number)
  • {{ISO end date|15/01/2001}} returns Error: Invalid time. (slashes indicate MM/DD/YYYY and 15 is an invalid month number)
  • {{ISO end date|1/2001}} returns Error: Invalid time.
  • {{ISO end date|2001 January 15}} returns Error: Invalid time.
  • {{ISO end date|2001 January}} returns 2001-01-01 (expected: 2001-01)

Use in microformats

This template also wraps the date in the dtend classes needed by the hCalendar microformat - usually, but not always, within infobox or similar templates, or tables.

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), this template should not be used for whole-day dates.

See also