Template:Time zone/utc offset sort key
The template attempts to return a number that preserves the sorting order between input UTC offsets. The return value is designed for data-sort-value= in columns of data-sort-type="number" in sortable tables. Input are UTC offset strings, such as from {{Time zone/utc offset}} and {{Time zone/utc dst offset}}.
For invalid inputs, the template returns an empty string, which is equal to −∞ for sorting. The exact returned number is not guaranteed to be meaningful, and may change in future implementations.
Usage
[edit]{{Time zone/utc offset sort key}} has one required positional parameter for UTC offsets, for example |+08:00, |+00:00 and |−00:00 as returned from the {{Time zone/utc _ offset}} templates.
The parameter accepts both hyphen-minus (-) and minus sign (−) prefixes for negative UTC offsets, but not the plus–minus sign (±) prefix. The parameter does not accept fractional time units given by decimal fractions and decimal point. Numbers with more than two digits are not treated as large hour offsets, but may be as hour with minute with second (optionally).
Examples
[edit]Examples of the valid and invalid inputs, and their sorting behaviour:
| Input ( data-sort-type="number") |
Code | Sort key output ( data-sort-type="number") |
|---|---|---|
| +08:00 | {{Time zone/utc offset sort key|{{Time zone/utc offset|Asia/Hong_Kong}}}} → | 28800 |
| +00:00 | {{Time zone/utc offset sort key|{{Time zone/utc offset|Europe/London}}}} → | 0 |
| +01:00 | {{Time zone/utc offset sort key|{{Time zone/utc dst offset|Europe/London}}}} → | 3600 |
| −05:00 | {{Time zone/utc offset sort key|{{Time zone/utc offset|America/New_York}}}} → | -18000 |
| +05:30 | {{Time zone/utc offset sort key|{{Time zone/utc offset|Asia/Kolkata}}}} → | 19800 |
| +08:45 | {{Time zone/utc offset sort key|+08:45}} → | 31500 |
| +8:45 | {{Time zone/utc offset sort key|+8:45}} → | 31500 |
| -02:30 | {{Time zone/utc offset sort key|-02:30}} → | -9000 |
| −02:30 | {{Time zone/utc offset sort key|−02:30}} → | -9000 |
| −2:30 | {{Time zone/utc offset sort key|−2:30}} → | -9000 |
| +07:36:42 | {{Time zone/utc offset sort key|+07:36:42}} → | 27402 |
| +7:36:42 | {{Time zone/utc offset sort key|+7:36:42}} → | |
| +07:36:41.7 | {{Time zone/utc offset sort key|+07:36:41.7}} → | |
| +2 | {{Time zone/utc offset sort key|+2}} → | 7200 |
| 2 | {{Time zone/utc offset sort key|2}} → | 7200 |
| +200 | {{Time zone/utc offset sort key|+200}} → | 7200 |
| +0200 | {{Time zone/utc offset sort key|+0200}} → | 7200 |
| 259 | {{Time zone/utc offset sort key|259}} → | 10740 |
| 0259 | {{Time zone/utc offset sort key|0259}} → | 10740 |
| 259:08 | {{Time zone/utc offset sort key|259:08}} → | |
| 25908 | {{Time zone/utc offset sort key|25908}} → | |
| 025908 | {{Time zone/utc offset sort key|025908}} → | 10748 |
| 260 | {{Time zone/utc offset sort key|260}} → | |
| +24 | {{Time zone/utc offset sort key|+24}} → | 86400 |
| +24:00 | {{Time zone/utc offset sort key|+24:00}} → | 86400 |
| +24:59:59 | {{Time zone/utc offset sort key|+24:59:59}} → | 89999 |
| +25 | {{Time zone/utc offset sort key|+25}} → | 90000 |
| +25:00 | {{Time zone/utc offset sort key|+25:00}} → | |
| +99 | {{Time zone/utc offset sort key|+99}} → | 356400 |
| +99:00 | {{Time zone/utc offset sort key|+99:00}} → | |
| -2 | {{Time zone/utc offset sort key|-2}} → | -7200 |
| −2 | {{Time zone/utc offset sort key|−2}} → | -7200 |
| -2:30 | {{Time zone/utc offset sort key|-2:30}} → | -9000 |
| −2:30 | {{Time zone/utc offset sort key|−2:30}} → | -9000 |
| -2:30:32 | {{Time zone/utc offset sort key|-2:30:32}} → | |
| −2:30:32 | {{Time zone/utc offset sort key|−2:30:32}} → | |
| -2:30:32.13 | {{Time zone/utc offset sort key|-2:30:32.13}} → | |
| −2:30:32.13 | {{Time zone/utc offset sort key|−2:30:32.13}} → | |
| -02:30:32 | {{Time zone/utc offset sort key|-02:30:32}} → | -9032 |
| −02:30:32 | {{Time zone/utc offset sort key|−02:30:32}} → | -9032 |
| -230 | {{Time zone/utc offset sort key|-230}} → | -9000 |
| −230 | {{Time zone/utc offset sort key|−230}} → | -9000 |
| -00:00:01 | {{Time zone/utc offset sort key|-00:00:01}} → | -1 |
| −00:00:01 | {{Time zone/utc offset sort key|−00:00:01}} → | -1 |
| −00:00 | {{Time zone/utc offset sort key|−00:00}} → | 0 |
| +00:00 | {{Time zone/utc offset sort key|+00:00}} → | 0 |
| ±00:00 | {{Time zone/utc offset sort key|±00:00}} → | |
| ±00:30 | {{Time zone/utc offset sort key|±00:30}} → | |
| (None) | {{Time zone/utc offset sort key}} → | |
{{Time zone/utc offset sort key|}} → | ||
| + | {{Time zone/utc offset sort key|+}} → | |
| - | {{Time zone/utc offset sort key|-}} → | |
| Time zone FOO is not in {{Tz/utc offset}}. | {{Time zone/utc offset sort key|{{Time zone/utc offset|FOO}}}} → | |
| FOO | {{Time zone/utc offset sort key|FOO}} → | |
| +FOO | {{Time zone/utc offset sort key|+FOO}} → | |
| -FOO | {{Time zone/utc offset sort key|-FOO}} → | |
| UTC+05:45 | {{Time zone/utc offset sort key|UTC+05:45}} → | |
| UTC-08:00 | {{Time zone/utc offset sort key|UTC-08:00}} → | |
| UTC | {{Time zone/utc offset sort key|UTC}} → | |
| CST | {{Time zone/utc offset sort key|CST}} → | |
| Z | {{Time zone/utc offset sort key|Z}} → |
Implementation
[edit]Currently, the template parses the input using {{#time}}, and returns a signed number for the offset in seconds.
See also
[edit]tz database
[edit]Sub templates store data from the tz database and some related information. These examples are accurate as of version 2026f of the database.
| Code example | Produces | Description |
|---|---|---|
{{Time zone |
[https://data.iana.org/time-zones/releases/tzdata2026f.tar.gz 2026f] → 2026f |
Produces the version number of the tz database. Update this template when updating those below with data from a new release. Add a parameter (value doesn't matter) to include a link to the IANA FTP site. |
{{Time zone |
CN | Maps TZ to country code from zone.tab |
{{Time zone |
[[ISO 3166-1:CN|CN]] → CN |
Maps TZ to linked country code from zone.tab |
{{Time zone |
+4348+08735 | Maps TZ to coordinates in original format from zone.tab |
{{Time zone |
Xinjiang Time | Maps TZ to comments from zone.tab |
{{Time zone |
asia | Maps TZ to linked continent file that defines the zone (or link) and DST rules. |
{{Time zone |
+01:00 | Maps TZ to normal (non-DST) UTC offset |
{{Time zone |
[[UTC+01:00|+01:00]] → +01:00 |
Maps TZ to linked normal (non-DST) UTC offset |
{{Time zone |
UTC+01:00 | Maps TZ to normal (non-DST) UTC offset with prefix |
{{Time zone |
+02:00 | Maps TZ to DST UTC offset |
{{Time zone |
[[UTC+02:00|+02:00]] → +02:00 |
Maps TZ to linked DST UTC offset |
{{Time zone |
| [[ISO 3166-1:AQ|AQ]] || || [[Antarctica/South_Pole]] ||
|
Maps TZ to 4 elements as a wikitable row – country code, coordinates, zone name, and comments |
{{Time zone |
! scope="col" | [[ISO 3166 2-character country code|<abbr title="Country code">c.c.</abbr>]]
! scope="col" | Coordinates
! scope="col" | [[List of tz database time zones|Timezone name]]
! scope="col" | Comments
! scope="col" colspan="2" | [[UTC offset]]
|
A 6-column table header for the templates below.
Optionally, the two UTC offset columns can be merged by |
{{Time zone |
| [[ISO 3166-1:AQ|AQ]]
|
| Antarctica/South_Pole
|
| [[UTC+12:00|+12:00]]
| [[UTC+13:00|+13:00]]
|
Similar to {{Time zone/zone.tab cols wikitable}}, but adds two more lines to the output, containing the linked normal (non-DST) and DST UTC offsets |
{{Time zone |
| AQ
|
| Antarctica/South_Pole
|
| +12:00
| +13:00
|
Same as {{Time zone/zone.tab cols unlinked}}, but with no links |
{{Time zone |
| [[ISO 3166-1:AQ|AQ]]
|
| <div style="text-indent: -1.6em; margin-left: 1.6em;">Antarctica<wbr />/South_Pole</div>
|
| data-sort-value="43200" | [[UTC+12:00|+12:00]]
| data-sort-value="46800" | [[UTC+13:00|+13:00]]
|
A version of {{Time zone/zone.tab cols linked}} designed for:
Note: neither {{Time zone/zone.tab cols wiki6}} nor {{Time zone/zone.tab cols linked}} can currently be used for the full table in List of tz database time zones because of performance limitations in processing such a long table. They can, however, be used for a small number of rows in individual area articles. |