Template:Infobox time zone/doc: Difference between revisions

Revision as of 02:55, 8 July 2018

Latest revision as of 00:07, 18 June 2024

(33 intermediate revisions by 17 users not shown)

Line 1:

{{documentation subpage}}

{{Update|documentation|date=July 2019}}

{{Lua|Module:Infobox|Module:InfoboxImage|Module:String|Module:Check for unknown parameters}}

{{Uses TemplateStyles|Template:Infobox time zone/styles.css}}

==Recommended usage==

{{infobox time zone

|title =Eastern time zone

|caption =Second furthest blue to the left

|daylight savings use =all

|standard time initials =EST

|daylight time initials =EDT

}}

==Usage==

<syntaxhighlight lang="wikitext">

<pre>

{{Infobox time zone

|titlecaption = = <!-- caption for the image -->

|dst use = <!-- time zone uses DST, accepted values: all, none, some, parts, only; default is all -->

|image =

|captioninitials = = <!-- initials during standard time -->

|dst initials = <!-- DST timezone initials, keep blank if daylight saving isn't used -->

|daylight savings use =

|offset = <!-- offset from UTC during standard time -->

|standard time initials =

|daylightdst timeoffset initials= = ( <!-- offset from UTC during DST, keep blank if daylight savingssaving isn't used) -->

|format =

|display observance =

}}

</syntaxhighlight>

</pre>

== All parameters ==

<u>Recommended Usage</u>

{{Parameter names example | title | name | image | imagesize | alt | caption | initials | offset | UTC | dst use | daylight savings use | dst offset | dst initials | non dst initials | display observance | format }}

<syntaxhighlight lang="wikitext">

<pre>

{{Infobox time zone

|captiontitle = =<!-- title of the infobox; default is the page name -->

|name = <!-- full name of the timezone, to be used when initials are shared with another zone causing the time to show incorrectly -->

|daylight savings use =

|image = <!-- an image for the infobox -->

|standard time initials =

|imagesize = <!-- size for the image; default is "300px" -->

|daylight time initials = (keep blank if daylight savings isn't used)

|alt = <!-- alt text for the image; for those who cannot see the image -->

|caption = <!-- caption for the image; shown beneath the image -->

|initials = <!-- initials during standard time; if not set, then UTC value is displayed -->

|offset = <!-- offset from UTC during standard time -->

|UTC = <!-- -->

|dst use = <!-- time zone uses DST? Accepted values: all, none, some, parts, only; default is all -->

|daylight savings use = <!-- same as '''dst use'''; use either but not both -->

|dst offset = <!-- offset from UTC during DST, keep blank if daylight saving isn't used -->

|dst initials = <!-- DST timezone initials, keep blank if daylight saving isn't used -->

|non dst initials = <!-- initials of standard, non-DST timezone that is used when a DST-only timezone is not active; only use on DST only timezones -->

|display observance = <!-- display the DST observance section? Default is to display; single accepted value: no -->

|format = <!-- format to use for the time display; default is "dmy" -->

}}

</syntaxhighlight>

</pre>

== Template Data ==

{{TemplateData header}}

{{collapse top|bg=#ccc|title=Template Data}}

<templatedata>

{

"params": {

"name": {},

"title": {},

"image": {},

"imagesize": {},

"alt": {},

"caption": {},

"initials": {},

"offset": {},

"UTC": {},

"dst initials": {},

"dst offset": {},

"format": {},

"display observance": {},

"dst use": {},

"daylight savings use": {},

"non dst initials": {}

},

"format": "block",

"description": "Infobox for documenting a timezone"

}

</templatedata>

{{collapse bottom}}

== Tracking categories ==

{| class="wikitable"

* {{clc|Pages using infobox time zone with unknown parameters}}

!Parameter !!notes !!default

* {{clc|Infobox time zone with unknown time zone}}

|-

|<code>title</code> || the name of the time zone ||<code><nowiki>{{PAGENAMEBASE}}</nowiki></code>

|-

|<code>image</code> || a map showing the ___location of the time zone || Standard World Time Zones.png

|-

|<code>caption</code> || a caption to accompany the map ||

|-

|<code>daylight savings use</code> || the extent of DST use in the time zone: <code>none</code> or <code>all</code> or <code>some</code> || (Set to all if daylight time is given)<br>(Set to none if daylight time initials is not given)

|-

|<code>standard time initials</code> || the initials used to refer to standard time || UTC

|-

|<code>daylight time initials</code> || the initials used to refer to daylight time (keep blank if daylight savings isn't used) ||

|-

|<code>format</code> || the format you want the current time to be displayed in (dmy12, mdy12 , dmy , mdy) ||dmy12

|-

|<code>display observance</code> || Option to display the 'Observance of DST' section set to no to not show ||yes

|}

;Example

<pre>

{{infobox time zone

|title = Eastern Timezone

|caption = Second furthest blue to the left

|daylight savings use = all

|standard time initials = EST

|daylight time initials = EDT

}}

</pre>

<includeonly>{{sandbox other||

[[Category:Time zones templates|!]]

[[Category:Infobox templates|Time zone]]

[[Category:PagesTemplates usingthat Infoboxadd timea zone|!tracking category]]

}}</includeonly>