View source for Template:Infobox storm IF/doc

{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
{{Lua|Module:Infobox|Module:InfoboxImage|Module:Check for unknown parameters}}

This template may be used in articles about storms, including [[extratropical cyclone]]s and [[winter storm]]s.

== Usage ==
{{Parameter names example|name|season|RSI=1|image|alt|caption|type|maintype=extratropical cyclone|formed|active|dissipated|exited land|pressure|lowest temperature|tornadoes|fujitascale|fujitascale ref|international|tornado duration|beaufort scale|10-min winds=0|10-min prefix|10-min suffix|1-min winds=0|highest winds=0|gusts=0|1-min prefix|1-min suffix|hail|maximum snow|maximum rain|damages|power outages|fatalities|areas affected|notes}}

<syntaxhighlight lang="wikitext" style="overflow: auto;">
{{Infobox storm IF
| name               = <!-- name of event, can be omitted if same as article title -->
| image              = <!-- just the filename-->
| alt                = 
| caption            = 
| type               = 
| maintype           = <!-- extratropical/subtropical/tropical cyclone -->
| formed             = <!-- {{Start date|YYYY|MM|DD|df=y}} -->
| active             = 
| dissipated         = <!-- {{End date|YYYY|MM|DD|df=y}} -->
| exited land        = 
| lowest pressure    = <!-- in mb/hPa, gets automatically converted to inHg -->
| lowest temperature = 
| tornadoes          = 
| fujitascale        = 
| international      = <!-- yes = International Fujita scale -->
| fujitascale ref    =
| torro-scale        =
| tornado duration   = 
| highest winds      = <!-- in mph, gets automatically converted to km/h -->
| gusts              = <!-- enter in knots, gets converted and rounded to display MPH and km/hr--> 
| beaufort scale     =
| hail               = 
| maximum snow       = <!-- maximum snowfall or ice accretion -->
| maximum rain       = <!-- maximum rainfall -->
| damages            = 
| power outages      = 
| fatalities         = 
| areas affected     = 
| season             =
| notes              = 
}}
</syntaxhighlight>

===Region- or type-specific parameters===

'''[[Regional Snowfall Index]]''' (used only for U.S. winter storms)
<syntaxhighlight lang="wikitext">
| RSI                = <!-- Regional Snowfall Index value -->
| RSI2                = <!-- Regional Snowfall Index value for a second storm in the same article -->
</syntaxhighlight>
{{clear}}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"name": {
			"aliases": [
				"event"
			],
			"label": "Name",
			"description": "Name of storm",
			"example": "Hurricane Katrina",
			"type": "string"
		},
		"image": {
			"aliases": [
				"image location"
			],
			"label": "Image"
		},
		"image alt": {
			"aliases": [
				"alt"
			],
			"label": "Image alternative text",
			"description": "Alternative text for image.",
			"type": "string"
		},
		"caption": {
			"aliases": [
				"image name"
			],
			"label": "Image caption",
			"description": "Caption beneath image.",
			"type": "string"
		},
		"type": {
			"aliases": [
				"stormtype"
			],
			"label": "Type",
			"description": "Storm type",
			"example": "Blizzard",
			"type": "string"
		},
        "maintype": {
            "label": "Type of cyclone"
        },
		"formed": {
			"aliases": [
				"date formed"
			],
			"label": "Formed",
			"description": "Date storm started",
			"type": "date"
		},
		"active": {
			"label": "Duration",
			"description": "Time period storm was active",
			"type": "string",
			"aliases": [
				"duration"
			]
		},
		"dissipated": {
			"aliases": [
				"date dissipated"
			],
			"label": "Dissipated",
			"description": "Date storm ended",
			"type": "date"
		},
        "exited land": {
            "label": "Exited to sea",
            "description": "Date storm moved out to sea",
            "type": "date"
        },
		"lowest pressure": {
			"label": "Lowest pressure",
			"description": "in mb/hPa",
			"type": "string"
		},
		"pressure": {},
		"lowest temperature": {
			"label": "Lowest temperature",
			"type": "string"
		},
		"tornadoes": {
			"label": "Tornadoes confirmed",
			"type": "string"
		},
		"fujitascale": {
			"label": "Fujita scale / International Fujita scale",
			"description": "add parameter international=yes for International Fujita scale",
			"example": "EF4",
			"type": "string"
		},
		"international": {
			"label": "International Fujita scale",
			"description": "Set to yes if fujitascale is international",
			"example": "yes",
			"type": "string"
		},
		"tornado duration": {
			"label": "Duration of tornado outbreak",
			"type": "string"
		},
		"10-min winds": {},
		"10-min prefix": {},
		"10-min suffix": {},
		"1-min winds": {},
		"1-min prefix": {},
		"1-min suffix": {},
		"highest winds": {
			"description": "in mph"
		},
		"sustained wind": {},
		"gusts": {
			"aliases": [
				"gust"
			],
			"label": "Highest gust"
		},
		"gusts prefix": {
			"aliases": [
				"pregusts"
			]
		},
		"gusts suffix": {},
		"beaufort scale": {},
		"hail": {
			"label": "Largest hail"
		},
		"RSI": {
			"label": "Regional Snowfall Index"
		},
		"maximum snow": {
			"aliases": [
				"maximum amount"
			],
			"label": "Maximum snowfall or ice accretion"
		},
		"maximum rain": {
			"label": "Maximum rainfall"
		},
		"damages": {
			"aliases": [
				"total damages (USD)",
				"total snow damages (USD)"
			],
			"label": "Damage"
		},
		"power outages": {},
		"fatalities": {
			"aliases": [
				"total casualties",
				"snow casualties",
				"fatalities",
				"total fatalities"
			],
			"label": "Fatalities"
		},
		"affected": {
			"aliases": [
				"areas affected",
				"countries affected",
				"location"
			],
			"label": "Areas affected",
			"type": "string"
		},
		"notes": {},
		"fujitascale ref": {},
		"partof": {
			"label": "Part of"
		},
        "season": {
			"label": "Part of the"
		}
	},
	"description": "Infobox for a storm",
	"format": "block",
	"paramOrder": [
		"name",
		"image",
		"image alt",
		"caption",
		"type",
        "maintype",
		"formed",
		"active",
		"dissipated",
        "exited land",
		"lowest pressure",
		"pressure",
		"lowest temperature",
		"tornadoes",
		"fujitascale",
		"international",
		"fujitascale ref",
		"tornado duration",
		"10-min winds",
		"10-min prefix",
		"10-min suffix",
		"1-min winds",
		"1-min prefix",
		"1-min suffix",
		"highest winds",
		"sustained wind",
		"gusts",
		"gusts prefix",
		"gusts suffix",
		"beaufort scale",
		"hail",
		"RSI",
		"maximum snow",
		"maximum rain",
		"damages",
		"power outages",
		"fatalities",
		"affected",
		"partof",
        "season",
		"notes"
	]
}
</templatedata>

== Tracking category ==
* {{clc|Pages using infobox storm with unknown parameters}}
* {{clc|Pages using infobox storm with redundant parameters}}
* {{c|Pages using infobox storm with notes parameter}} (not a problem that requires any changes)

== See also ==
*{{tl|Infobox winter storm small}}
*{{tl|Infobox earthquake}}
*{{tl|Infobox flood}}
*{{tl|Infobox tropical cyclone}}