Module:Storm categories/icons/doc

This is the documentation page for Module:Storm categories/icons

This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

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.

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:

    -- 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|18px]]",