Template:Infobox weather event/SSHWS/doc
This is a documentation subpage for Template:Infobox weather event/SSHWS. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
changeThis is a meta-template used by tropical cyclone scale subboxes for Template:Infobox weather event. It is used to standardize all Saffir–Simpson scale-based subboxes. This automatically provides the category, meaning the only parameters that need to be provided are |agency=
for the issuing agency and possibly |interval=
.
For examples, see Template:Infobox weather event/NWS or Template:Infobox weather event/JTWC.
Tropical depression | Tropical storm | Category 1-equivalent tropical cyclone | Category 2-equivalent tropical cyclone | Category 3-equivalent tropical cyclone | Category 4-equivalent tropical cyclone | Category 5-equivalent tropical cyclone |
<31 kn, <57 km/h, <35 mph | 32–63 kn, 59–116 km/h, 36–72 mph | 64–82 kn, 118–151 km/h, 73–94 mph | 83–95 kn, 153–175 km/h, 95–109 mph | 96–112 kn, 177–207 km/h, 110–128 mph | 113–136 kn, 209–251 km/h, 130–156 mph | >137 kn, >253 km/h, >157 mph |
TemplateData
changeA subbox for displaying meteorological information for a storm according to data from a given agency. 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 |
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 |
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 |
Category only? | categoryonly | Only return the category of this storm as a string. Useful if you only want the category of a storm based on meteorological data, but not the actual box itself.
| Boolean | optional |