Template:Infobox time zone/doc: Difference between revisions

Revision as of 13:09, 23 September 2018

Latest revision as of 00:07, 18 June 2024

(18 intermediate revisions by 11 users not shown)

Line 1:

{{documentation subpage}}

==Usage==

{{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=usage==

<syntaxhighlight lang="wikitext">

<pre>

{{Infobox time zone

|caption = (<!-- caption for the image) -->

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

|initials = (<!-- initials during standard time) -->

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

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

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

}}

</syntaxhighlight>

</pre>

=== All Parameters=parameters ==

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

|title = = <!-- (title of the infobox; default is pagename)the page name -->

|imagename = = <!-- full name of (athe imagetimezone, forto be used when initials are shared with another zone causing the infobox)time to show incorrectly -->

|captionimage = = <!-- an (captionimage for the image)infobox -->

|dstimagesize use = = <!-- size for the (time zone uses DST, accepted values: all, none, some, parts, onlyimage; default is all)"300px" -->

|initialsalt = = <!-- alt text for the image; for those who cannot (initialssee duringthe standardimage time)-->

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

|name = (full name of the timezone, to be used when initials are shared with another zone causing the time to show incorrectly)

|dst initials = = (DST timezone<!-- initials, keepduring blankstandard time; if daylightnot set, then UTC value savingis isn'tdisplayed used)-->

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

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

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

|dst offsetuse = = <!-- time (offsetzone fromuses UTCDST? duringAccepted DSTvalues: all, keepnone, blanksome, parts, ifonly; daylightdefault savingis isn'tall used)-->

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

|display observance = (display the DST observance section; default is to display; single accepted value: no)

|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;? defaultDefault is to display; single accepted value: no) -->

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

}}

</syntaxhighlight>

</pre>

== TrackingTemplate categoryData ==

{{TemplateData header}}

* {{clc|Pages using infobox time zone}}

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

<includeonly>

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

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

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

<includeonly>{{sandbox other||

[[Category:Time zones templates|!]]

[[Category:Infobox templates|Time zone]]

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

}}</includeonly>