Template:Format date/doc
| This is a documentation subpage for Template:Format date. It contains usage information, categories and other content that is not part of the original template page. |
Usage
This template ({{Format date}}) returns a date, or date-time, without the hidden version for use in microformats. This template is probably best used internally in other templates.
If you need the microformat support, use template {{Start date}} instead.
If you want sortable dates for a table, use {{Dts}} instead.
Syntax
- {{Format date|year|month|day}}
- {{Format date|year|month|day|HH|MM|SS|TimeZone}} (MM and SS are optional; TimeZone may be a numerical value, or "Z" for UTC; see examples)
Examples:
- {{Format date|1993}} returns "1993"
- {{Format date|1993|02}} returns "February 1993"
- {{Format date|1993|02|24}} returns "February 24, 1993"
- {{Format date|1993|02|24|08|30}} returns "08:30, February 24, 1993"
- {{Format date|1993|02|24|08|||+01:00}} returns "February 24, 1993 (+01:00)"
- {{Format date|1993|02|24|08|||-07:00}} returns "February 24, 1993 (-07:00)"
- {{Format date|1993|02|24|08|30|23}} returns "08:30:23, February 24, 1993"
- {{Format date|1993|02|24|08|30|23|Z}} returns "08:30:23, February 24, 1993 (UTC)"
- {{Format date|1993|02|24|08|30|23|+01:00}} returns "08:30:23, February 24, 1993 (+01:00)"
- {{Format date|1993|02|24|08|30|23|-07:00}} returns "08:30:23, February 24, 1993 (-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:
- {{Format date|1993|02|24|df=y}} returns "24 February 1993"
- {{Format date|1993|02|24|08|30|df=yes}} returns "08:30, 24 February 1993"
Note: The template will appear broken when the parameters are left blank (as seen hereinbefore).
See also
- {{Date}} (an alternative to this template, using a different syntax)
- {{Start date}} (using the same syntax, but with the support for microformats)
- {{Start-date}} (an alternative to the template {{Start date}})
- {{Format time}}
Template:Wikipedia date templates
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Year | 1 year | The year to render in the date
| Number | suggested |
| Month | 2 month | The month to render in the date
| String | suggested |
| Day | 3 day | The day of the month to format in the date
| String | suggested |
| Hour (HH) | 4 hour hh | the hour to format in the date (if desired)
| String | optional |
| Minute (MM) | 5 minute mm | The minute to format in the date (if desired)
| String | optional |
| Second (SS) | 6 second ss sec | The second to format in the date (if desired)
| String | optional |
| Time zone | 7 timezone TimeZone tz | A numerical offset from UTC, or 'Z'
| String | optional |
| Day first? | df dayfirst | If 'y' or 'yes', displays the day before the month | String | optional |
| Time joiner | time_joiner | if included, replaces comma in "<time>, <date>" with the value given
| String | optional |
| Hour format | hour_format | Formats hours and whether to render AM/PM or a.m./p.m.
| String | optional |