Template:Infobox weather event/Winter storm/doc
This is a documentation subpage for Template:Infobox weather event/Winter storm. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
This sub-box generates a meteorological information box specifically targeted towards winter storms. When available, this box will change the header to reflect a winter storm category (such as a category provided by the Regional Snowfall Index). Otherwise, it will show a generic "Winter storm" header.
The winter storm category may be supplied using |category=
. In the event that this storm has an RSI value, the |RSI=
parameter can instead be used, and will automatically adjust the box to use imperial units instead of metric. The |basin=
parameter can also be used to change this behavior; set it to atl
or epac
to switch the default units. To avoid units entirely, you may choose to pass text into the related values (e.g. pass {{convert|100|in|cm|abbr=on}}
|maximum-rain=
or |maximum-snow=
), but this makes later maintenance difficult, and is not advised.
This subbox relies on the meta-template Template:Infobox weather event/meteorology.
{{Infobox weather event/Winter storm
| winds = 112
| lowest-temperature = -45
| maximum-snow = 17
}}
|
|
{{Infobox weather event/Winter storm
| RSI = 6.78
| winds = 87
| lowest-temperature = -23
| maximum-rain = 56
| maximum-snow = 12
}}
|
|
TemplateData
A subbox for displaying meteorological information for a storm. Should be used adjacent to an 'Infobox weather event' template, and before an 'Infobox weather event/Footer' template.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Child display? | child | Whether this is a child box or not. Use `yes`, unless you're using this box standalone.
| Boolean | optional |
Body style | bodystyle | Custom CSS for the box
| String | optional |
Storm category | category | The storm category. This populates the header color and name automatically. | String | suggested |
Basin | basin | Basin of the storm. Controls the name of the category, if the category supports basin-specific names.
| String | optional |
Header text | header | Header text to show. Overrides category name if provided. | Content | optional |
Header style | header-style | Controls the style of the subbox header. This header usually includes the category of the storm or the storm type, if a category is not applicable.
| String | optional |
No header? | no-header | Disables the header row
| Boolean | optional |
Subheader text | subheader | Subheader text to show. Overrides interval, scale, and agency, if provided. | Content | optional |
Measurement interval | interval | The measurement interval used by the agency. e.g. JMA uses 10-minute, JTWC uses 1-minute.
| Number | suggested |
Post-interval text | post-interval postinterval | Text to add after "N-minute sustained". A space is automatically provided. | String | optional |
Agency | agency | Agency issuing the meteorological data. If the agency uses multiple scales, or uses a scale that is used by multiple agencies, consider also supplying "scale".
| Content | suggested |
Scale | scale | Scale used to quantify the meteorological data. If the scale is used by multiple agencies, consider supplying "agency".
| Content | suggested |
Maximum sustained winds | winds | The maximum sustained winds of a given storm. Not to be confused with maximum wind gusts (provided with "gusts"). Supply value in knots.
| Number | suggested |
Maximum winds prefix | winds-prefix | Prefix for the maximum sustained winds. Use this to add approximation symbols, such as '~', '<', or '>'.
| String | optional |
Maximum winds suffix | winds-suffix | Suffix for the maximum sustained winds. Use this to add references, footnotes, or other content. | Content | optional |
Maximum wind gust | gusts | The maximum wind gust of a given storm. Not to be confused with maximum sustained winds (provided with "winds"). Supply value in knots.
| Number | suggested |
Maximum gusts prefix | gusts-prefix | Prefix for the maximum wind gusts. Use this to add approximation symbols, such as '~', '<', or '>'.
| String | optional |
Maximum gusts suffix | gusts-suffix | Suffix for the maximum wind gusts. Use this to add references, footnotes, or other content. | Content | optional |
Beaufort scale | beaufort-scale beaufort scale | The maximum sustained winds on the Beaufort scale. Rarely used except for historical storms; consider using "winds" instead. | Number | optional |
Lowest pressure | pressure | Lowest pressure, usually measured near the storm's center. Supply value in hectopascals/millibars (hPa/mbar).
| Number | suggested |
Lowest pressure prefix | pressure-prefix | Prefix for the pressure. Use this to add approximation symbols, such as '~', '<', or '>'.
| String | optional |
Lowest pressure suffix | pressure-suffix | Suffix for the lowest pressure. Use this to add references, footnotes, or other content. | Content | optional |
Lowest temperature | lowest-temperature lowest temperature | Lowest temperature. Supply value in Fahrenheit when "basin" is "atl" or "epac". Otherwise, supply the value in Celcius.
| Number | suggested |
Lowest temperature prefix | temperature-prefix | Prefix for the temperature. Use this to add approximation symbols, such as '~', '<', or '>'.
| String | optional |
Lowest temperature suffix | temperature-suffix | Suffix for the lowest recorded temperature. Use this to add references, footnotes, or other content. | Content | optional |
Largest hail | largest-hail largest hail | Largest recorded size of hail. Supply value in inches when "basin" is "atl" or "epac". Otherwise, supply the value in centimeters.
| Number | optional |
Largest hail suffix | largest-hail-suffix | Suffix for the largest hail recorded. Use this to add references, footnotes, or other content. | Content | optional |
Maximum rainfall | maximum-rain maximum rain | Maximum recorded rainfall. Supply value in inches when "basin" is "atl" or "epac". Otherwise, supply the value in centimeters.
| Number | optional |
Maximum rainfall suffix | maximum-rain-suffix | Suffix for the maximum recorded rainfall. Use this to add references, footnotes, or other content. | Content | optional |
Maximum snow or ice accretion | maximum-snow maximum snow | Maximum height of accumulated snow or ice accretion. Supply value in inches when "basin" is "atl" or "epac". Otherwise, supply the value in centimeters. | Content | optional |
Maximum snow accumulation or ice accretion suffix | maximum-snow-suffix | Suffix for the maximum recorded snow accumulation or ice accretion. Use this to add references, footnotes, or other content. | Unknown | optional |
Regional Snowfall Index | RSI | The Regional Snowfall Index value of the storm. Since the RSI only exists in North America, this automatically switches the basin and thus switches the primary units used. Be sure to input the value, not the category (i.e., not 0–5). | Number | suggested |
Storm type | type | The winter storm type. Changes the header or category suffix, if a category is available. Most commonly used by other subboxes; avoid supplying this parameter directly to avoid redundancy. | Content | optional |