Editing Module:Storm categories/doc (section)

=== Sortkey ===
The sortkey is a number that aids in sorting categories. Using the sortkey, it is possible to automatically sort a table of tropical cyclones given their category code. Due to the ambiguous nature of sortkeys, tables may be sorted incorrectly if values from other basins were used. For categories that span multiple basins, however, (e.g. <code>depression</code> and <code>storm</code>) they are given the lowest possible sortkeys in order to achieve maximum compatibility.
{{#ifeq:{{BASEPAGENAME}}|Storm categories|
  <p>This sortkey is used in {{T|storm sortkey}} and {{T|Tropical cyclone season effects (cyclone)}}, a subtemplate of {{T|Tropical cyclone season effects}}.</p>
}}
The sortkey format is as follows. Note that not all values between the given ranges were used. The arrangement of these were determined by their positions in the {{T|Storm colour}} template.
{| class="wikitable"
! Basin
! Sortkey range
|-
| {{gray|''Global (unused)''}}
| 90000 to 99999
|-
| Atl/EPac/SAtl
| 80000 to 89999
|-
| WPac
| 60000 to 69999
|-
| Nio
| 50000 to 59999
|-
| Aus/Fiji
| 40000 to 49999
|-
| SWio
| 30000 to 39999
|-
| Historical
| 20000 to 29999
|-
| Global
| 0 to 9999
|}

A demonstration of a sortable table using these sortkeys can be found below. Note that it does not use categories outside of its own basin (in this case, the Atl/EPac/SAtl basin) and the global range.
{| class="wikitable sortable"
! Category
! Sortkey
! Code
|- style="background-color:#{{#invoke:Storm categories|color|cat3}}" |
| cat3
| {{nts|{{#invoke:Storm categories|sortkey|cat3}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|cat3}}</nowiki></code>
|- style="background-color:#{{#invoke:Storm categories|color|cat1}}"
| cat1
| {{nts|{{#invoke:Storm categories|sortkey|cat1}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|cat1}}</nowiki></code>
|- style="background-color:#{{#invoke:Storm categories|color|cat5}}"
| cat5
| {{nts|{{#invoke:Storm categories|sortkey|cat5}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|cat5}}</nowiki></code>
|- style="background-color:#{{#invoke:Storm categories|color|cat4}}"
| cat4
| {{nts|{{#invoke:Storm categories|sortkey|cat4}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|cat4}}</nowiki></code>
|- style="background-color:#{{#invoke:Storm categories|color|depression}}"
| depression
| {{nts|{{#invoke:Storm categories|sortkey|depression}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|depression}}</nowiki></code>
|- style="background-color:#{{#invoke:Storm categories|color|cat2}}"
| cat2
| {{nts|{{#invoke:Storm categories|sortkey|cat2}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|cat2}}</nowiki></code>
|}

{{ctop|title=Sorting table which uses different basins}}
{| class="wikitable sortable"
! Category
! Sortkey
! Code
|- style="background-color:#{{#invoke:Storm categories|color|typhoon}}" |
| typhoon
| {{nts|{{#invoke:Storm categories|sortkey|typhoon}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|typhoon}}</nowiki></code>
|- style="background-color:#{{#invoke:Storm categories|color|potential}}"
| potential
| {{nts|{{#invoke:Storm categories|sortkey|potential}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|potential}}</nowiki></code>
|- style="background-color:#{{#invoke:Storm categories|color|cat5}}"
| cat5
| {{nts|{{#invoke:Storm categories|sortkey|cat5}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|cat5}}</nowiki></code>
|- style="background-color:#{{#invoke:Storm categories|color|svrcyclstorm}}"
| svrcyclstorm
| {{nts|{{#invoke:Storm categories|sortkey|svrcyclstorm}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|svrcyclstorm}}</nowiki></code>
|- style="background-color:#{{#invoke:Storm categories|color|unknown}}"
| unknown
| {{nts|{{#invoke:Storm categories|sortkey|unknown}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|unknown}}</nowiki></code>
|- style="background-color:#{{#invoke:Storm categories|color|supertyphoon}}"
| supertyphoon
| {{nts|{{#invoke:Storm categories|sortkey|supertyphoon}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|supertyphoon}}</nowiki></code>
|- style="background-color:#{{#invoke:Storm categories|color|niodepression}}"
| niodepression
| {{nts|{{#invoke:Storm categories|sortkey|niodepression}}}}
|| <code><nowiki>{{#invoke:Storm categories|sortkey|niodepression}}</nowiki></code>
|}
{{cbot}}