Module:Storm categories/icons/doc

This is a documentation subpage for Module:Storm categories/icons.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 5,400 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.

Usage

This template contains icon overrides for Module:Storm categories. These icon overrides can either add an extra icon to the template without adding a category, or override the icon of an existing category or category alias for backwards compatibility. These are primarily used for categories that apply to basins across both hemispheres, but require an icon that applies to the southern hemisphere (where cyclones rotate counter-clockwise).

Overrides are defined in the following format: <syntaxhighlight line lang="lua" start="8">

   -- For overrides that include the icon of an existing category.
   ["override_id"] = cats["actual_category"].icon,
   -- For overrides that introduce a new icon.
   ["override_id"] = "File:Super duper ultra strong magnitude 100 storm icon.svg",

</syntaxhighlight>