Template:Infobox weather event/meteorology/doc

Usage

This is a meta-template used by all of the meteorological info subboxes for Template:Infobox weather event. It is used to standardize all scale-based subboxes.

By default, units are metric with the exception of winds and gusts, which are always in knots. This is the case to reflect international usage of knots in measuring wind speeds. This may be overridden by supplying a

1. REDIRECT Template:Template link

template as a value, or by appending the relevant unit ("mph" or "kmh") to the end of the value for automatic conversion, however, both come as an "at your own risk" feature as this reduces maintainability.

The |basin= parameter can also be used to change the units; set it to atl or epac to switch to the imperial system. 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.

The following templates use this meta-template to supply meteorological information: <categorytree mode="pages">Weather event infobox meteorology templates</categorytree>

Automatic storm categories

For some sub-boxes (particularly in scale boxes), the category of a storm can be inferred from its wind speed or from other meteorological data. To allow the box to automatically calculate the category, supply an |auto-category= parameter. This parameter will be used in the event that |category= is empty, allowing editors to both let automatic calculations do the work or override the category if needed.

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." }, "auto-category": { "label": "Storm auto category", "description": "The automatic category of the storm. This defines the category of the storm if a category parameter was not explicitly provided.", "type": "string", "suggested": true }, "header-suffix": { "label": "Header suffix", "description": "Suffix for the header. Comes after the category name or actual header, if provided.", "type": "content", "suggested": true } }, "description": "Meta-template for all weather event infobox scale subboxes which contain agency-based tropical cyclone scale information and meteorological data.", "format": "block" }

</templatedata>