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

From blackwiki
Jump to navigation Jump to search
imported>FrescoBot
m (Bot: links syntax and spacing)
imported>Zyxw
(update documentation and categories)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata -->
This template converts dates to YYYY-MM-DD or YYYY-MM or YYYY as appropriate - see below for restrictions on input formats accepted.
+
 
 +
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 ==
 
== Usage ==
This template only converts dates formatted in one of the formats below to an ISO 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}}
 +
 
 +
The template accepts one unnamed parameter containing a date in one of the following formats:
  
The template accepts one parameter - which must be unnamed. For example:
+
* <tt><nowiki>{{ISO end date|15 January 2001}}</nowiki><tt> returns {{ISO end date|15 January 2001}}
 +
* <tt><nowiki>{{ISO end date|15 Jan 2001}}</nowiki><tt> returns {{ISO end date|15 Jan 2001}}
 +
* <tt><nowiki>{{ISO end date|15-01-2001}}</nowiki><tt> returns {{ISO end date|15-01-2001}}
  
*{<nowiki>{</nowiki>ISO date|15 January 2001}} returns {{ISO date|15 January 2001}}  
+
* <tt><nowiki>{{ISO end date|January 15, 2001}}</nowiki><tt> returns {{ISO end date|January 15, 2001}}
*{<nowiki>{</nowiki>ISO date|March 2003}} returns {{ISO date|March 2003}}
+
* <tt><nowiki>{{ISO end date|Jan 15, 2001}}</nowiki><tt> returns {{ISO end date|Jan 15, 2001}}
 +
* <tt><nowiki>{{ISO end date|Jan. 15, 2001}}</nowiki><tt> returns {{ISO end date|Jan. 15, 2001}}
 +
* <tt><nowiki>{{ISO end date|01/15/2001}}</nowiki><tt> returns {{ISO end date|01/15/2001}}
  
The date parameter must be in one of the following formats:
+
* <tt><nowiki>{{ISO end date|January 2001}}</nowiki><tt> returns {{ISO end date|January 2001}}
* 15 January 2001
+
* <tt><nowiki>{{ISO end date|Jan 2001}}</nowiki><tt> returns {{ISO end date|Jan 2001}}
* 15 Jan 2001
 
* January 15, 2001
 
* Jan 15, 2001
 
* 15-01-2001
 
* January 2001
 
* Jan 2001
 
* 2001
 
  
Formats for which it can not work because #time returns an error:
+
* <tt><nowiki>{{ISO end date|2001}}</nowiki><tt> returns {{ISO end date|2001}}
* 01-15-2001
+
 
* 1/2001
+
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)''
 +
* <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)''
 +
* <tt><nowiki>{{ISO end date|1/2001}}</nowiki><tt> returns {{ISO end date|1/2001}}
 +
* <tt><nowiki>{{ISO end date|2001 January 15}}</nowiki><tt> 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}})''
  
 
== 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.
  
Line 32: Line 39:
  
 
== See also ==
 
== See also ==
 +
* {{Tl|ISO date}}
 +
* {{Tl|Birth date}}
 +
* {{Tl|Birth date and age}}
 +
* {{Tl|Start date}}
  
*{{Tl|ISO date}}
+
<includeonly>{{sandbox other||
*{{Tl|Birth date}}
+
<!-- Categories below this line; interwikis at Wikidata -->
*{{Tl|Birth date and age}}
 
*{{Tl|Start date}}
 
 
 
<includeonly>
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
 
[[Category:ISO date templates]]
 
[[Category:ISO date templates]]
[[Category:Date mathematics templates|{{PAGENAME}}]]
+
[[Category:Date conversion templates]]
[[Category:Templates generating hAtom|{{PAGENAME}}]]
+
[[Category:Date-computing templates]]
[[Category:Templates generating hCalendars|{{PAGENAME}}]]
+
[[Category:Templates generating hAtom]]
[[Category:Templates generating hCards|{{PAGENAME}}]]
+
[[Category:Templates generating hCalendars]]
 +
[[Category:Templates generating hCards]]
  
</includeonly>
+
}}</includeonly>

Revision as of 12:29, 2 January 2017

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-12

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