Template:Infobox weather event/Storm/doc
This is a documentation subpage for Template:Infobox weather event/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 any general storm. This is the general-use version of Template:Infobox weather event/meteorology, and is the most customizable.
|category=
can be set to any valid storm category. It will, in turn, change the header color and text. If a category is set, the header can only be changed by |header=
. The header style (which includes the background color) can be changed with |headerstyle=
. To identify which scale and/or agency was used, supply the |scale=
and/or |agency=
parameters, respectively. To identify measurement interval (e.g. 10-minute, 3-minute), supply |interval=
with the number of minutes. To override the text below the header entirely, use |subheader=
.
If a category is not used, |type=
may be used instead to refer to the type of meteorological event. The value of |type=
will be used as the header text. Note that this will not show up if |category=
is set.
The |basin=
parameter can also be used to change the units; 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|142|mph|kmh|abbr=on}}
|winds=
or |gusts=
), 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/Storm
| type = Flood
| maximum-rain = 98
}}
|
|
{{Infobox weather event/Storm
| type = Nor'easter
| winds = 98
| gusts = 101
| maximum-rain = 42
}}
|
|
{{Infobox weather event/Storm
| category = 3
| type = Gust <!-- Note how this will be missing -->
| header = Puff of the Big Bad Wolf
| scale = [[The Three Little Pigs]]
| winds = 877
| gusts = 1042
}}
|
|
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 |
Type | type | The type of the event. Overridden by the 'category' parameter, if one is provided.
| String | suggested |