View source for Template:Format date/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
==Usage==
This template ('''{{tl|Format date}}''') returns a date, or date-time, without the hidden version for use in [[microformat]]s. This template is probably best used internally in other templates.

If you need the microformat support, use template {{tl|Start date}} instead.

If you want sortable dates for a table, use {{tl|Date table sorting}} instead.

==Syntax==
*{{tlx|Format date|year|month|day}}
*{{tlx|Format date|year|month|day|HH|MM|SS|TimeZone}} (MM and SS are optional; TimeZone may be a numerical value, or "Z" for [[Coordinated Universal Time|UTC]]; see examples)

Examples:

*{{tlx|Format date|1993}} returns "{{Format date|1993}}"
*{{tlx|Format date|1993|02}} returns "{{Format date|1993|02}}"
*{{tlx|Format date|1993|02|24}} returns "{{Format date|1993|02|24}}"
*{{tlx|Format date|1993|02|24|08|30}} returns "{{Format date|1993|02|24|08|30}}"
*{{tlx|Format date|1993|02|24|08|||+01:00}} returns "{{Format date|1993|02|24|08|||+01:00}}"
*{{tlx|Format date|1993|02|24|08|||-07:00}} returns "{{Format date|1993|02|24|08|||-07:00}}"
*:{{tlx|Format date|1993|02|24|08|30|23}} returns "{{Format date|1993|02|24|08|30|23}}"
*{{tlx|Format date|1993|02|24|08|30|23|Z}} returns "{{Format date|1993|02|24|08|30|23|Z}}"
*{{tlx|Format date|1993|02|24|08|30|23|+01:00}} returns "{{Format date|1993|02|24|08|30|23|+01:00}}"
*{{tlx|Format date|1993|02|24|08|30|23|-07:00}} returns "{{Format date|1993|02|24|08|30|23|-07:00}}"

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:

*{{tlx|Format date|1993|02|24|df{{=}}y}} returns "{{Format date|1993|02|24|df=y}}"
*{{tlx|Format date|1993|02|24|08|30|df{{=}}yes}} returns "{{Format date|1993|02|24|08|30|df=yes}}"

'''Note:''' The template will appear broken when the parameters are left blank (as seen hereinbefore).

==See also==
*'''{{tl|Date}}''' (an alternative to this template, using a different syntax)
*'''{{tl|Start date}}''' (using the same syntax, but with the support for microformats)
*'''{{tl|Start date text}}''' (an alternative to the template {{tl|Start date}})
*'''{{tl|Format time}}''' for formatting times only
{{Date and time templates}}
<includeonly>{{Sandbox other||

<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Date mathematics templates|{{PAGENAME}}]] 	

<!-- ADD INTERWIKIS BELOW THIS LINE -->

}}</includeonly>
<templatedata>
{
	"params": {
		"1": {
			"aliases": [
				"year"
			],
			"label": "Year",
			"description": "The year to render in the date",
			"example": "1997",
			"type": "number",
			"autovalue": "",
			"suggested": true
		},
		"2": {
			"aliases": [
				"month"
			],
			"label": "Month",
			"description": "The month to render in the date",
			"example": "January",
			"type": "string",
			"autovalue": "",
			"suggested": true
		},
		"3": {
			"aliases": [
				"day"
			],
			"label": "Day",
			"description": "The day of the month to format in the date",
			"example": "20",
			"type": "string",
			"autovalue": "",
			"suggested": true
		},
		"4": {
			"aliases": [
				"hour",
				"hh"
			],
			"label": "Hour (HH)",
			"description": "the hour to format in the date (if desired)",
			"example": "03",
			"type": "string",
			"autovalue": ""
		},
		"5": {
			"aliases": [
				"minute",
				"mm"
			],
			"label": "Minute (MM)",
			"description": "The minute to format in the date (if desired)",
			"example": "21",
			"type": "string"
		},
		"6": {
			"aliases": [
				"second",
				"ss",
				"sec"
			],
			"label": "Second (SS)",
			"description": "The second to format in the date (if desired)",
			"example": "10",
			"type": "string",
			"autovalue": ""
		},
		"7": {
			"aliases": [
				"timezone",
				"TimeZone",
				"tz"
			],
			"label": "Time zone",
			"description": "A numerical offset from UTC, or 'Z'",
			"example": "+5",
			"type": "string"
		},
		"df": {
			"label": "Day first?",
			"description": "If 'y' or 'yes', displays the day before the month",
			"type": "string",
			"aliases": [
				"dayfirst"
			]
		},
		"time_joiner": {
			"label": "Time joiner",
			"description": "if included, replaces comma in \"<time>, <date>\" with the value given",
			"example": "on",
			"type": "string"
		},
		"hour_format": {
			"label": "Hour format",
			"description": "Formats hours and whether to render AM/PM or a.m./p.m.",
			"example": "g (7 ... p.m.), G (07 ... PM), h (19), or H (19)",
			"type": "string"
		}
	}
}
</templatedata>