Template:Infobox weather event/Storm/doc
This is a documentation subpage for Template:Infobox weather event/Storm. It contains 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.
</syntaxhighlight><syntaxhighlight lang="wikitext"> | ||||
Flood | ||||
---|---|---|---|---|
Maximum rainfall | Lua error in Module:Convert at line 1850: attempt to index local 'en_value' (a nil value). | |||
|
<syntaxhighlight lang="wikitext"> | ||||||||
Nor'easter | ||||||||
---|---|---|---|---|---|---|---|---|
Highest winds | 180 km/h (115 mph) | |||||||
Highest gusts | 185 km/h (115 mph) | |||||||
Maximum rainfall | Lua error in Module:Convert at line 1850: attempt to index local 'en_value' (a nil value). | |||||||
|
<syntaxhighlight lang="wikitext">Template:Preview warning | ||||||||
Puff of the Big Bad Wolf | ||||||||
---|---|---|---|---|---|---|---|---|
The Three Little Pigs | ||||||||
Highest winds | 1625 km/h (1010 mph) | |||||||
Highest gusts | 1930 km/h (1200 mph) | |||||||
Template:Preview warning
|
TemplateData
<templatedata> { "params": { "child": { "label": "Child display?", "description": "Whether this is a child box or not. Use `yes`, unless you're using this box standalone.", "example": "yes", "type": "boolean", "default": "yes" }, "bodystyle": { "label": "Body style", "description": "Custom CSS for the box", "type": "string", "default": "border-collapse: collapse" }, "category": { "label": "Storm category", "description": "The storm category. This populates the header color and name automatically.", "type": "string", "suggested": true }, "basin": { "label": "Basin", "description": "Basin of the storm. Controls the name of the category, if the category supports basin-specific names.", "type": "string", "suggestedvalues": [ "atl", "epac", "satl", "wpac" ] }, "header": { "label": "Header text", "description": "Header text to show. Overrides category name if provided.", "type": "content" }, "header-style": { "label": "Header style", "description": "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.", "type": "string", "default": "font-size: 100%; background-color: #{{Storm colour|{{{category|}}}}}" }, "no-header": { "label": "No header?", "description": "Disables the header row", "example": "yes", "type": "boolean", "default": "no" }, "subheader": { "label": "Subheader text", "description": "Subheader text to show. Overrides interval, scale, and agency, if provided.", "type": "content" }, "interval": { "label": "Measurement interval", "description": "The measurement interval used by the agency. e.g. JMA uses 10-minute, JTWC uses 1-minute.", "example": "1", "type": "number", "suggested": true }, "post-interval": { "aliases": [ "postinterval" ], "label": "Post-interval text", "description": "Text to add after \"N-minute sustained\". A space is automatically provided.", "type": "string" }, "agency": { "label": "Agency", "description": "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\".", "example": "NWS", "type": "content", "suggested": true }, "scale": { "label": "Scale", "description": "Scale used to quantify the meteorological data. If the scale is used by multiple agencies, consider supplying \"agency\".", "example": "SSHWS", "type": "content", "suggested": true }, "winds": { "label": "Maximum sustained winds", "description": "The maximum sustained winds of a given storm. Not to be confused with maximum wind gusts (provided with \"gusts\"). Supply value in knots.", "example": "124", "type": "number", "suggested": true }, "winds-prefix": { "label": "Maximum winds prefix", "description": "Prefix for the maximum sustained winds. Use this to add approximation symbols, such as '~', '<', or '>'.", "example": "~", "type": "string" }, "winds-suffix": { "label": "Maximum winds suffix", "description": "Suffix for the maximum sustained winds. Use this to add references, footnotes, or other content.", "type": "content" }, "gusts": { "label": "Maximum wind gust", "description": "The maximum wind gust of a given storm. Not to be confused with maximum sustained winds (provided with \"winds\"). Supply value in knots.", "example": "164", "type": "number", "suggested": true }, "gusts-prefix": { "label": "Maximum gusts prefix", "description": "Prefix for the maximum wind gusts. Use this to add approximation symbols, such as '~', '<', or '>'.", "example": "~", "type": "string" }, "gusts-suffix": { "label": "Maximum gusts suffix", "description": "Suffix for the maximum wind gusts. Use this to add references, footnotes, or other content.", "type": "content" }, "beaufort-scale": { "aliases": [ "beaufort scale" ], "label": "Beaufort scale", "description": "The maximum sustained winds on the Beaufort scale. Rarely used except for historical storms; consider using \"winds\" instead.", "type": "number" }, "pressure": { "label": "Lowest pressure", "description": "Lowest pressure, usually measured near the storm's center. Supply value in hectopascals/millibars (hPa/mbar).", "example": "975", "type": "number", "suggested": true }, "pressure-prefix": { "label": "Lowest pressure prefix", "description": "Prefix for the pressure. Use this to add approximation symbols, such as '~', '<', or '>'.", "example": "~", "type": "string" }, "pressure-suffix": { "label": "Lowest pressure suffix", "description": "Suffix for the lowest pressure. Use this to add references, footnotes, or other content.", "type": "content" } , "lowest-temperature": { "aliases": [ "lowest temperature" ], "label": "Lowest temperature", "description": "Lowest temperature. Supply value in Fahrenheit when \"basin\" is \"atl\" or \"epac\". Otherwise, supply the value in Celcius.", "example": "13", "type": "number", "suggested": true }, "temperature-prefix": { "label": "Lowest temperature prefix", "description": "Prefix for the temperature. Use this to add approximation symbols, such as '~', '<', or '>'.", "example": "~", "type": "string" }, "temperature-suffix": { "label": "Lowest temperature suffix", "description": "Suffix for the lowest recorded temperature. Use this to add references, footnotes, or other content.", "type": "content" }, "largest-hail": { "aliases": [ "largest hail" ], "label": "Largest hail", "description": "Largest recorded size of hail. Supply value in inches when \"basin\" is \"atl\" or \"epac\". Otherwise, supply the value in centimeters.", "example": "12", "type": "number" }, "largest-hail-suffix": { "label": "Largest hail suffix", "description": "Suffix for the largest hail recorded. Use this to add references, footnotes, or other content.", "type": "content" }, "maximum-rain": { "aliases": [ "maximum rain" ], "label": "Maximum rainfall", "description": "Maximum recorded rainfall. Supply value in inches when \"basin\" is \"atl\" or \"epac\". Otherwise, supply the value in centimeters.", "example": "42", "type": "number" }, "maximum-rain-suffix": { "label": "Maximum rainfall suffix", "description": "Suffix for the maximum recorded rainfall. Use this to add references, footnotes, or other content.", "type": "content" }, "maximum-snow": { "aliases": [ "maximum snow" ], "label": "Maximum snow or ice accretion", "description": "Maximum height of accumulated snow or ice accretion. Supply value in inches when \"basin\" is \"atl\" or \"epac\". Otherwise, supply the value in centimeters.", "type": "content" }, "maximum-snow-suffix": { "label": "Maximum snow accumulation or ice accretion suffix", "description": "Suffix for the maximum recorded snow accumulation or ice accretion. Use this to add references, footnotes, or other content." }, "type": { "label": "Type", "description": "The type of the event. Overridden by the 'category' parameter, if one is provided.", "example": "Nor'easter", "type": "string", "suggested": true } }, "description": "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. ", "format": "block" }
</templatedata>