Template:Infobox weather event/scale/doc
 | This is a documentation subpage for Template:Infobox weather event/scale. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
[edit]This is a meta-template used by all of the tropical cyclone scale subboxes for Template:Infobox weather event. It is used to standardize all scale-based subboxes. This meta-template, in turn, relies on the meta-template Template:Infobox weather event/meteorology.
You can create a new scale box using other scale boxes as a references, or use you can use the following form for an easier and guided experience.
TemplateData
[edit]Meta-template for all weather event infobox scale subboxes which contain agency-based tropical cyclone scale information and meteorological data.
| 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 |
| Storm auto category | auto-category | The automatic category of the storm. This defines the category of the storm if a category parameter was not explicitly provided. | String | suggested |