మాడ్యూల్:Storm categories/doc
This Lua module is used on many pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
In order to conform to Wikipedia:Manual of Style/Accessibility#Color guidelines, do not use storm colors in conjunction with links. This is necessary to avoid problems related to lack of contrast. |
This module depends on the following other modules: |
This template is used to control a multitude of tropical cyclone-related templates: {{storm colour}}, {{storm name}}, {{storm sortkey}}, and {{storm icon}}. It acts as a centralized location for storm categories to avoid discrepancies between templates, allowing for the same ID to be used across all related templates.
Data is located in the following submodules:
- Module:Storm categories/categories for fully-detailed storm categories
- Module:Storm categories/colors for color-only IDs
- Module:Storm categories/icons for icon-only IDs
Usage
మార్చుThis module exports three functions for templates: p.color
, p.name
, p.sortkey
, and p.icon
. It also provides p._color
, p._name
, p._sortkey
, and p._icon
for use in other modules.
All input IDs are case-insensitive, and all non-alphanumeric characters are stripped.
Color
మార్చుProvides the color of the given tropical cyclone category code. This comes in the format of their raw hexadecimal code. This function is available as a template at {{storm colour}}.
Code | Output |
---|---|
<span style="padding:4px;border:1px solid black;background-color:#{{#invoke:Storm categories|color|depression}}">depression</span>
|
depression |
Name
మార్చుProvides the name of the given tropical cyclone category code. A optional basin argument can be provided as the second argument in order to slightly tweak the name of the category, if the given category definition supports it. This function is available as a template at {{storm name}}.
Code | Interpreted | Output | |
---|---|---|---|
ID | Basin | ||
{{#invoke:Storm categories|name|severe}}
|
severe | (default) | Severe tropical storm |
{{#invoke:Storm categories|name|spr - cYcL -s TorM}}
|
sprcyclstorm | (default) | Super cyclonic storm |
{{#invoke:Storm categories|name|cat5}}
|
cat5 | (default) | Category 5-equivalent tropical cyclone |
{{#invoke:Storm categories|name|cat5|WPac}}
|
cat5 | wpac | Category 5-equivalent super typhoon |
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. depression
and storm
) they are given the lowest possible sortkeys in order to achieve maximum compatibility.
This sortkey is used in {{storm sortkey}} and {{Tropical cyclone season effects (cyclone)}}, a subtemplate of {{Tropical cyclone season effects}}.
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 {{Storm colour}} template.
Basin | Sortkey range |
---|---|
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.
Category | Sortkey | Code |
---|---|---|
cat3 | 80,030 | {{#invoke:Storm categories|sortkey|cat3}}
|
cat1 | 80,010 | {{#invoke:Storm categories|sortkey|cat1}}
|
cat5 | 80,050 | {{#invoke:Storm categories|sortkey|cat5}}
|
cat4 | 80,040 | {{#invoke:Storm categories|sortkey|cat4}}
|
depression | 90 | {{#invoke:Storm categories|sortkey|depression}}
|
cat2 | 80,020 | {{#invoke:Storm categories|sortkey|cat2}}
|
Sorting table which uses different basins
| ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Icon
మార్చుIcons exist for some Storm categories for presentation purposes. This function is available as a template at {{storm icon}}. p.icon
will return wikitext of an image or formatted text.
Full list of available values
మార్చుThe following table is generated by invoking the demo
function of this module. Some IDs are only available as colors or icons because they existed as parameters on old non-module template implementations and cannot be feasibly aliased to a specific tropical cyclone category.
It will show any color errors, including colors which aren't compliant with the minimal Web Content Accessibility Guidelines 2.0 AA color standards (see for more information).
Legend
Icon | ID | Name | Color | Sortkey | |||
---|---|---|---|---|---|---|---|
Basin | Name | Basin | Sortkey | ||||
aus1 | Category 1 tropical cyclone | #00faf4 | Aus/Fiji | 40006 | |||
aus2 | Category 2 tropical cyclone | #ccffff | Aus/Fiji | 40008 | |||
aus3 | Category 3 severe tropical cyclone | #ffffcc | Aus/Fiji | 40010 | |||
aus4 | Category 4 severe tropical cyclone | #ffc140 | Aus/Fiji | 40013 | |||
aus5 | Category 5 severe tropical cyclone | #ff6060[W 1] | Aus/Fiji | 40015 | |||
TC | beaufort0 | Calm (Force 0) | #FFFFFF | Global | 1500 | ||
TC | beaufort1 | Light Air (Force 1) | #757575[W 1][W 2] | Global | 1510 | ||
TC | beaufort10 | Storm (Force 10) | #AAFD9C | Global | 1600 | ||
TC | beaufort11 | Violent Storm (Force 11) | #D6FFA4 | Global | 1610 | ||
TC | beaufort12 | Hurricane-force (Force 12) | #FFFCD1 | Global | 1620 | ||
TC | beaufort2 | Light Breeze (Force 2) | #909090[W 1] | Global | 1520 | ||
TC | beaufort3 | Gentle Breeze (Force 3) | #B7B7B7[W 1] | Global | 1530 | ||
TC | beaufort4 | Moderate Breeze (Force 4) | #D2D2D2 | Global | 1540 | ||
TC | beaufort5 | Fresh Breeze (Force 5) | #F1F1F1 | Global | 1550 | ||
TC | beaufort6 | Strong Breeze (Force 6) | #007FCE[W 1][W 2] | Global | 1560 | ||
TC | beaufort7 | Near Gale (Force 7) | #46A1FF[W 1] | Global | 1570 | ||
TC | beaufort8 | Gale (Force 8) | #5EDBF8 | Global | 1580 | ||
TC | beaufort9 | Strong Gale (Force 9) | #3BFDFD | Global | 1590 | ||
cat1 | atl | Category 1 hurricane | #ffffcc | Atl/EPac/SAtl | 80010 | ||
default | Category 1-equivalent tropical cyclone | ||||||
epac | Category 1 hurricane | ||||||
satl | Category 1 hurricane | ||||||
wpac | Category 1-equivalent typhoon | ||||||
cat2 | atl | Category 2 hurricane | #ffe775 | Atl/EPac/SAtl | 80020 | ||
default | Category 2-equivalent tropical cyclone | ||||||
epac | Category 2 hurricane | ||||||
satl | Category 2 hurricane | ||||||
wpac | Category 2-equivalent typhoon | ||||||
cat3 | atl | Category 3 hurricane | #ffc140 | Atl/EPac/SAtl | 80030 | ||
default | Category 3-equivalent tropical cyclone | ||||||
epac | Category 3 hurricane | ||||||
satl | Category 3 hurricane | ||||||
wpac | Category 3-equivalent typhoon | ||||||
cat4 | atl | Category 4 hurricane | #ff8f20[W 1] | Atl/EPac/SAtl | 80040 | ||
default | Category 4-equivalent tropical cyclone | ||||||
epac | Category 4 hurricane | ||||||
satl | Category 4 hurricane | ||||||
wpac | Category 4-equivalent typhoon | ||||||
cat5 | atl | Category 5 hurricane | #ff6060[W 1] | Atl/EPac/SAtl | 80050 | ||
default | Category 5-equivalent tropical cyclone | ||||||
epac | Category 5 hurricane | ||||||
satl | Category 5 hurricane | ||||||
wpac | Category 5-equivalent super typhoon | ||||||
cs | Cyclonic storm | #00faf4 | NIO | 50006 | |||
cyclstorm | Cyclonic storm | #00faf4 | NIO | 50006 | |||
d | Tropical depression | #80ccff[1] | Global | 90 | |||
dd | Deep depression | #5ebaff[W 1] | NIO | 50002 | |||
deepdepression | Deep depression | #5ebaff[W 1] | NIO | 50002 | |||
depression | Tropical depression | #5ebaff[W 1] | Global | 90 | |||
di | Tropical disturbance | #80ccff | Global | 80 | |||
disturbance | Tropical disturbance | #80ccff | Global | 80 | |||
ef0 | EF0 tornado | #00faf4 | Global | 1000 | |||
ef1 | EF1 tornado | #ffffcc | Global | 1010 | |||
ef2 | EF2 tornado | #ffe775 | Global | 1020 | |||
ef3 | EF3 tornado | #ffc140 | Global | 1030 | |||
ef4 | EF4 tornado | #ff8f20[W 1] | Global | 1040 | |||
ef5 | EF5 tornado | #ff6060[W 1] | Global | 1050 | |||
efu | EFU tornado | #cccccc | Global | 1001 | |||
escs | Extremely severe cyclonic storm | #ffc140 | NIO | 50015 | |||
esvrcyclstorm | Extremely severe cyclonic storm | #ffc140 | NIO | 50015 | |||
et | Extratropical cyclone | #cccccc | Global | 50 | |||
ex | Extratropical cyclone | #cccccc | Global | 50 | |||
extratropical | Extratropical cyclone | #cccccc | Global | 50 | |||
TC | f0 | Calm (Force 0) | #FFFFFF | Global | 1500 | ||
TC | f1 | Light Air (Force 1) | #757575[W 1][W 2] | Global | 1510 | ||
TC | f10 | Storm (Force 10) | #AAFD9C | Global | 1600 | ||
TC | f11 | Violent Storm (Force 11) | #D6FFA4 | Global | 1610 | ||
TC | f12 | Hurricane-force (Force 12) | #FFFCD1 | Global | 1620 | ||
TC | f2 | Light Breeze (Force 2) | #909090[W 1] | Global | 1520 | ||
TC | f3 | Gentle Breeze (Force 3) | #B7B7B7[W 1] | Global | 1530 | ||
TC | f4 | Moderate Breeze (Force 4) | #D2D2D2 | Global | 1540 | ||
TC | f5 | Fresh Breeze (Force 5) | #F1F1F1 | Global | 1550 | ||
TC | f6 | Strong Breeze (Force 6) | #007FCE[W 1][W 2] | Global | 1560 | ||
TC | f7 | Near Gale (Force 7) | #46A1FF[W 1] | Global | 1570 | ||
TC | f8 | Gale (Force 8) | #5EDBF8 | Global | 1580 | ||
TC | f9 | Strong Gale (Force 9) | #3BFDFD | Global | 1590 | ||
fiji1 | Category 1 tropical cyclone | #00faf4 | Aus/Fiji | 40006 | |||
fiji2 | Category 2 tropical cyclone | #ccffff | Aus/Fiji | 40008 | |||
fiji3 | Category 3 severe tropical cyclone | #ffffcc | Aus/Fiji | 40010 | |||
fiji4 | Category 4 severe tropical cyclone | #ffc140 | Aus/Fiji | 40013 | |||
fiji5 | Category 5 severe tropical cyclone | #ff6060[W 1] | Aus/Fiji | 40015 | |||
intense | Intense tropical cyclone | #ffc140 | SWIO | 30008 | |||
itc | Intense tropical cyclone | #ffc140 | SWIO | 30008 | |||
land | Land depression | #80ccff | NIO | 50000 | |||
landdepression | Land depression | #80ccff | NIO | 50000 | |||
ld | Land depression | #80ccff | NIO | 50000 | |||
low | Tropical low | #5ebaff[W 1] | Aus/Fiji | 40002 | |||
md | Monsoon depression | #5ebaff[W 1] | Global | 30 | |||
TC | moddepression | Moderate tropical depression | #5ebaff[W 1] | Global | 95 | ||
monsoondepression | Monsoon depression | #5ebaff[W 1] | Global | 30 | |||
mstorm | Moderate tropical storm | #00faf4 | SWIO | 30004 | |||
mts | Moderate tropical storm | #00faf4 | SWIO | 30004 | |||
mtstorm | Moderate tropical storm | #00faf4 | Global | 105 | |||
niocyclone | Cyclonic storm | #00faf4 | NIO | 50006 | |||
niodepression | Depression | #80ccff | NIO | 50001 | |||
nioland | Land depression | #80ccff | NIO | 50000 | |||
nwpdepression | Tropical depression | #5ebaff[W 1] | Global | 90 | |||
nwpsevere | Severe tropical storm | #ccffff | Global | 120 | |||
nwpstorm | Tropical storm | #00faf4 | Global | 100 | |||
od | Overland depression | #5ebaff[W 1] | Global | 60 | |||
overland | Overland depression | #5ebaff[W 1] | Global | 60 | |||
overlanddepression | Overland depression | #5ebaff[W 1] | Global | 60 | |||
post | Post-tropical depression | #cccccc | Global | 70 | |||
posttropical | Post-tropical depression | #cccccc | Global | 70 | |||
potential | Potential tropical cyclone | #80ccff | Global | 25 | |||
potentialtropicalcyclone | Potential tropical cyclone | #80ccff | Global | 25 | |||
pt | Potential tropical cyclone | #80ccff | Global | 25 | |||
remnant | Post-tropical depression | #cccccc | Global | 70 | |||
remnantlow | Post-tropical depression | #cccccc | Global | 70 | |||
rl | Post-tropical depression | #cccccc | Global | 70 | |||
rsi0 | Category 0 "Nuisance" | #cccccc | Atl/EPac/SAtl | 80100 | |||
rsi1 | Category 1 "Notable" | #ffffcc | Atl/EPac/SAtl | 80110 | |||
rsi2 | Category 2 "Minor" | #ffe775 | Atl/EPac/SAtl | 80120 | |||
rsi3 | Category 3 "Major" | #ffc140 | Atl/EPac/SAtl | 80130 | |||
rsi4 | Category 4 "Crippling" | #ff8f20[W 1] | Atl/EPac/SAtl | 80140 | |||
rsi5 | Category 5 "Extreme" | #ff6060[W 1] | Atl/EPac/SAtl | 80150 | |||
rsicrippling | Category 4 "Crippling" | #ff8f20[W 1] | Atl/EPac/SAtl | 80140 | |||
rsiextreme | Category 5 "Extreme" | #ff6060[W 1] | Atl/EPac/SAtl | 80150 | |||
rsimajor | Category 3 "Major" | #ffc140 | Atl/EPac/SAtl | 80130 | |||
rsiminor | Category 2 "Minor" | #ffe775 | Atl/EPac/SAtl | 80120 | |||
rsinotable | Category 1 "Notable" | #ffffcc | Atl/EPac/SAtl | 80110 | |||
rsinuisance | Category 0 "Nuisance" | #cccccc | Atl/EPac/SAtl | 80100 | |||
scs | Severe cyclonic storm | #ccffff | NIO | 50008 | |||
sd | Subtropical depression | #5ebaff[W 1] | Global | 62 | |||
severe | Severe tropical storm | #ccffff | Global | 120 | |||
TC | severedep | Severe tropical depression | #5ebaff[W 1] | Global | 120 | ||
severets | Severe tropical storm | #ccffff | Global | 120 | |||
shdepression | Tropical depression | #5ebaff[W 1] | Global | 90 | |||
TC | shem1 | Tropical cyclone | #00faf4 | Historical | 20008 | ||
TC | shem2 | Tropical cyclone | #ccffff | Historical | 20008 | ||
TC | shem3 | Tropical cyclone | #ffffcc | SWIO | 30006 | ||
TC | shem4 | Tropical cyclone | #ffc140 | Historical | 20008 | ||
TC | shem5 | Severe tropical cyclone | #ff6060[W 1] | Historical | 20010 | ||
shemdepression | Tropical depression | #5ebaff[W 1] | Global | 90 | |||
TC | shemsvrtc | Severe tropical cyclone | #ffe775 | Historical | 20020 | ||
TC | shemtc | Tropical cyclone | #ffffcc | SWIO | 30006 | ||
spdepression | Tropical depression | #5ebaff[W 1] | Global | 90 | |||
sprcyclstorm | Super cyclonic storm | #ff6060[W 1] | NIO | 50020 | |||
ss | Subtropical storm | #00faf4 | Global | 65 | |||
storm | Tropical storm | #00faf4 | Global | 100 | |||
strong | Severe tropical storm | #ccffff | Global | 120 | |||
sts | Severe tropical storm | #ccffff | Global | 120 | |||
TC | sty | Category 4 super typhoon | #ff6060[W 1] | Atl/EPac/SAtl | 80045 | ||
TC | styphoon | Supertyphoon | #ff6060[W 1] | WPAC | 60050 | ||
sub | Moderate tropical storm | #00faf4 | SWIO | 30004 | |||
subdepression | Subtropical depression | #5ebaff[W 1] | Global | 62 | |||
subdisturbance | Subtropical disturbance | #80ccff | Global | 55 | |||
TC | sublow | Subtropical low | #5ebaff[W 1] | Aus/Fiji | 40000 | ||
subtropical | Subtropical storm | #00faf4 | Global | 65 | |||
TC | subtropicalcyclone | Subtropical cyclone | #00faf4 | Global | 70 | ||
sucs | Super cyclonic storm | #ff6060[W 1] | NIO | 50020 | |||
TC | supertyphoon | Category 4 super typhoon | #ff6060[W 1] | Atl/EPac/SAtl | 80045 | ||
svrcyclstorm | Severe cyclonic storm | #ccffff | NIO | 50008 | |||
TC | svtyphoon | Severe typhoon | #ff8f20[W 1] | WPAC | 60015 | ||
swiodepression | Tropical depression | #5ebaff[W 1] | Global | 90 | |||
swiodisturbance | Tropical disturbance | #80ccff | Global | 80 | |||
[2] | swiosts | Severe tropical storm | #ccffff | Global | 120 | ||
[3] | swiotc | Tropical cyclone | #ffffcc | SWIO | 30006 | ||
swsubdep | Subtropical depression | #5ebaff[W 1] | Global | 62 | |||
[3] | tc | Tropical cyclone | #ffffcc | SWIO | 30006 | ||
td | Tropical depression | #5ebaff[W 1] | Global | 90 | |||
tdist | Tropical disturbance | #80ccff | Global | 80 | |||
tl | Tropical low | #5ebaff[W 1] | Aus/Fiji | 40002 | |||
TC | tropicalcyclone | Tropical cyclone | #ffffcc | SWIO | 30006 | ||
ts | Tropical storm | #00faf4 | Global | 100 | |||
ty | Typhoon | #fdaf9a | WPAC | 60010 | |||
typhoon | Typhoon | #fdaf9a | WPAC | 60010 | |||
? | unknown | Unknown strength tropical cyclone | #c0c0c0 | Global | 0 | ||
vintense | Very intense tropical cyclone | #ff6060[W 1] | SWIO | 30010 | |||
vitc | Very intense tropical cyclone | #ff6060[W 1] | SWIO | 30010 | |||
vity | Violent typhoon | #ff6060[W 1] | WPAC | 60030 | |||
vityphoon | Violent typhoon | #ff6060[W 1] | WPAC | 60030 | |||
vscs | Very severe cyclonic storm | #ffffcc | NIO | 50010 | |||
vstrtyphoon | Very strong typhoon | #fe887d[W 1] | WPAC | 60020 | |||
vsty | Very strong typhoon | #fe887d[W 1] | WPAC | 60020 | |||
vstyphoon | Very strong typhoon | #fe887d[W 1] | WPAC | 60020 | |||
vsvrcyclstorm | Very severe cyclonic storm | #ffffcc | NIO | 50010 | |||
wssi0 | No impacts | #cccccc | Atl/EPac/SAtl | 80200 | |||
wssi1 | Limited impacts | #80ccff | Atl/EPac/SAtl | 80210 | |||
wssi2 | Minor impacts | #ffc140 | Atl/EPac/SAtl | 80220 | |||
wssi3 | Moderate impacts | #ff8f20[W 1] | Atl/EPac/SAtl | 80230 | |||
wssi4 | Major impacts | #ff6060[W 1] | Atl/EPac/SAtl | 80240 | |||
wssi5 | Extreme impacts | #cf75ff[W 1] | Atl/EPac/SAtl | 80250 | |||
wssiextreme | Extreme impacts | #cf75ff[W 1] | Atl/EPac/SAtl | 80250 | |||
wssilimited | Limited impacts | #80ccff | Atl/EPac/SAtl | 80210 | |||
wssimajor | Major impacts | #ff6060[W 1] | Atl/EPac/SAtl | 80240 | |||
wssiminor | Minor impacts | #ffc140 | Atl/EPac/SAtl | 80220 | |||
wssimoderate | Moderate impacts | #ff8f20[W 1] | Atl/EPac/SAtl | 80230 | |||
wssinone | No impacts | #cccccc | Atl/EPac/SAtl | 80200 | |||
zodw | Zone of disturbed weather | #80ccff | SWIO | 30000 | |||
1 | not available | #ffffcc | not available | ||||
2 | not available | #ffe775 | not available | ||||
3 | not available | #ffc140 | not available | ||||
4 | not available | #ff8f20[W 1] | not available | ||||
5 | not available | #ff6060[W 1] | not available | ||||
a1 | not available | #00faf4 | not available | ||||
a2 | not available | #ccffff | not available | ||||
a3 | not available | #ffffcc | not available | ||||
a4 | not available | #ffc140 | not available | ||||
a5 | not available | #ff6060[W 1] | not available | ||||
et2 | not available | ||||||
ex2 | not available | ||||||
extratropical2 | not available | ||||||
stss | not available |
Warnings
This table contains warnings than should be addressed. Please note that some warnings cannot be fully addressed without changes that would require consensus.
- ↑ 1.00 1.01 1.02 1.03 1.04 1.05 1.06 1.07 1.08 1.09 1.10 1.11 1.12 1.13 1.14 1.15 1.16 1.17 1.18 1.19 1.20 1.21 1.22 1.23 1.24 1.25 1.26 1.27 1.28 1.29 1.30 1.31 1.32 1.33 1.34 1.35 1.36 1.37 1.38 1.39 1.40 1.41 1.42 1.43 1.44 1.45 1.46 1.47 1.48 1.49 1.50 1.51 1.52 1.53 1.54 1.55 1.56 1.57 1.58 1.59 1.60 1.61 1.62 1.63 1.64 1.65 This color has with links (not WCAG 2.0 AA-compatible). It should not be used in conjunction with a link.
- ↑ 2.0 2.1 2.2 2.3 2.4 This color has with visited links (not WCAG 2.0 AA-compatible with #0b0080). It should not be used in conjunction with a visited link.