Template:Time/doc

Template:Documentation subpage Template:For Template:Lua This template displays the current time in a parameter-specified time zone. The time is calculated based on the offset from UTC for the specified time zone taking into account whether daylight saving time is currently active in that time zone.

Note: Most Wikipedia pages display a cached version of the page to reduce server load, so the template will only display the current time as of when the page was last parsed. You can refresh the displayed time by clicking the Template:Small link.

Usage

Typically, all that is needed is:

{{time|<TZ>}} where <TZ> is one of the supported time zone abbreviations

{{time|MST}}

To change the rendered format:

{{time|MST|df=y}}

{{time|MST|y}}

{{time|MST|dmy}}

{{time|MST|iso}}

Supported time zones

This is a list of the currently supported time zone abbreviations: Template:Div col

• ACST Template:Small
• AEST Template:Small
• AKST Template:Small
• AoETemplate:Efn-ua
• AST Template:Small
• AWST
• BST
• BT
• CET Template:Small
• ChST
• CST Template:Small
• EET Template:Small
• EST Template:Small
• GMT
• GMT-IETemplate:Efn-ua
• GMT-UKTemplate:Efn-ua
• HST Template:Small
• IDLETemplate:Efn-ua
• IDLWTemplate:Efn-ua
• IRKT
• IST
• JST
• KRAT
• MSK
• MST
• NPT
• NST
• NZST Template:Small
• OMST
• PETT
• PKT
• PMSTTemplate:Efn-ua
• PST Template:Small
• SAMT
• SAST
• SRET
• SST
• USZ1
• UTC
• VLAT
• WET Template:Small
• WGTTemplate:Efn-ua
• WIB
• WIT
• WITA
• YAKT
• YEKT

UTC offset

To display the time at a particular UTC offset, specify the UTC time offset as the time zone:

{{time|UTC-07:00}}

'UTC', a sign character, two hour digits, a colon, and two minute digits are required. Accepted sign characters are: '+', '-' (hyphen), '±', and '−' (minus).

Military/nautical time zones

To display the time at a particular military or nautical time zone, use the time zone's alpha designation:

{{time|M}}

Some military and nautical time zone designators are extended with an asterisk (*), a dagger (†), or double dagger (‡). When writing this template for designators that are extended with a dagger or double dagger, use '+' and '++' respectively:

{{time|M++}}

{{time|M+}}

Daylight saving time

Daylight saving time (DST) calculations are automatic for those time zones where it is observed. There are locales that do not observe DST within time zones where it is generally observed. To render the correct time for a non-observant locale, set Template:Para:

{{time|MST|dst=no}}

– time in Arizona

{{time|MST}}

– but, time on the Navajo Nation in Arizona

The opposite case is not supported. For places like Thule Air Base in Greenland, which observes US DST rules while WGT observes EU DST rules, a time zone properties table will be needed in Module:Time. See §Adding a new time zone.

Error messages

Template:Tld can produce several error messages. These are:

– when defining a custom format for am (or pm) time, you must also define a custom format for pm (or am) time

– indicates an internal error because one or more of the following time zone properties is malformed: UTC offset, DST begin or end definition. To resolve this error make sure that the time zone's properties are correct.

– indicates an internal error because one or more of the following time zone properties is missing: DST begin or end definition, DST event time, time zone article. To resolve this error supply the missing properties.

– value assigned to Template:Para is not one of the defined format strings; ss §Parameters

- the symbol ± is being used when the minute and hour offsets aren't 00:00

– value assigned to this parameter must either have the format: YYYY-MM-DDThh:mm:ss where all except 'T' are digits, or YYYYMMDDhhmmss

– the time zone positional parameter is not one of the supported time zone abbreviations. To resolve this error check the parameter's spelling or add the time zone's properties to the module. See §Adding a new time zone.

Adding a new time zone

Template:Tld uses Module:Time/data. In that module, is a table of tables, the data structure that specifies the properties of the individual time zones. A blank time zone properties table has this form:

[''] = {
	abbr = '',			
	dst_abbr = '',
	utc_offset = '',
	df = '',
	dst_begins = '',
	dst_ends = '',
	dst_time = '',
	dst_e_time = '',
	article = ''
},

To add a new time zone to Module:Time/data, add the appropriate information inside the single quotes. If a property does not apply, leave the quotes empty. The rules for each property are:

[''] – (required) the abbreviation of a time zone's standard time; must be lower case; this is the value that will be used in the template's time zone parameter

abbr = '' – (required) the abbreviation of a time zone's standard time as it will be rendered by the template

dst_abbr = '' – the abbreviation of a time zone's daylight saving or summer time as it will be rendered by the template

utc_offset = '' – (required) the offset in hours and minutes from UTC±00:00; has the form: utc_offset = '<sign>hh:mm' where <sign> may be + (optional) or - (required for time zones west of the 0 meridian)

df = '' – one of three keywords dmy, mdy, or iso used to specify date format typically used in the time zone; can be overridden with Template:Para template parameter

dst_begins = '' – a four word sentence in the form <ordinal> <day name> <in|of> <month name> where:

<ordinal> – any of the words 'first', '1st', 'second', '2nd', ... 'fifth', '5th', or 'last'

<day name> – any of the day names 'Sunday', 'Monday', 'Tuesday', etc.; capitalization is not important but otherwise must be spelled correctly; abbreviations not supported

<in|of> – either of the words 'in' or 'of'

<month name> – any of the month names 'January', 'February', 'March', etc.; capitalization is not important but otherwise must be spelled correctly; abbreviations not supported

dst_ends = '' – (required if dst_begins is specified) same as dst_begins

dst_time = '' – (required if dst_begins is specified) the time that daylight saving time begins; usually local time; when DST begins at a specified time UTC (European Summer Time for example) use: dst_time = 'hh:mm UTC'; four digits and the colon are required

dst_e_time = '' – the time that daylight saving time ends if different from the time it begins; usually local daylight saving time ; when DST ends at a specified time UTC use: dst_e_time = 'hh:mm UTC'; four digits and the colon are required

article = '' – (required) the title of a Wikipedia article that is appropriate to the timezone; do not include wikimarkup

The table-of-tables is organized east (plus UTC offsets) then west (minus UTC offset), by offset hours, and then alphabetically by time zone positional parameter name.

Adding a new alias

You may also want to add an alias of a timezone:

[''] = {tz = ''},

To add a new time zone to Module:Time/data, add the appropriate information inside the single quotes.

[''] – (required) the abbreviation of a time zone's alias. This must be lower case.

tz = '' – (required) the abbreviation of the time zone that's already in the code. This must be lower case

The table-of-tables is organized east (plus UTC offsets) then west (minus UTC offset), and by if it's a DST offset or if it's not.

TemplateData

Template:TemplateData header <templatedata> { "params": { "1": { "label": "time zone", "description": "The time zone for the time formatting", "example": "EST", "type": "string", "suggested": true }, "2": { "aliases": [ "df" ], "label": "date format", "description": "The format to render the date and time", "example": "dmy12", "suggested": true }, "dst": { "label": "Daylight savings time", "example": "yes", "type": "string" }, "lang": { "label": "ISO 639 language code", "description": "displays time/date in language specified by ISO 639 language", "type": "string" }, "dateonly": { "description": "If 'yes', suppresses display of the time and only shows the date", "example": "yes", "type": "string" }, "timeonly": { "description": "If 'yes', suppresses display of the date and only shows the time", "example": "yes", "type": "string" }, "hide-tz": { "label": "Hide time zone?", "description": "If 'yes', suppresses time zone abbreviation", "example": "yes", "type": "string" }, "unlink-tz": { "label": "Don't link time zone?", "description": "If 'yes', renders the timezone without linking to its article.", "example": "yes", "type": "string" } } } </templatedata>