Template:Infobox time zone/doc: Difference between revisions

Revision as of 03:59, 10 August 2018

Latest revision as of 00:07, 18 June 2024

(28 intermediate revisions by 16 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}}

<u>==Recommended Usage</u>usage==

<syntaxhighlight lang="wikitext">

<pre>

{{Infobox time zone

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

|caption =

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

|dst use = (default all)

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

|initials =

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

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

|offset =

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

}}

</syntaxhighlight>

</pre>

== All parameters ==

<u>All Parameters</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

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

|title =

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

|image =

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

|caption =

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

|dst use =

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

|initials =

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

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

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

|offset =

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

|dst offset = (keep blank if daylight savings isn't used)

|UTC = <!-- -->

|dst use = (all, none, some)

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

|display observance = (display the DST observance section?)

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

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

|dst initials = ( <!-- DST timezone initials, keep blank if daylight savingssaving 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 ==

<includeonly>

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

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