Template:Infobox weather event/meteorology/doc

Usage

edit

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 {{convert}} 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:

Automatic storm categories

edit

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

edit

Meta-template for all weather event infobox scale subboxes which contain agency-based tropical cyclone scale information and meteorological data.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Child display?child

Whether this is a child box or not. Use `yes`, unless you're using this box standalone.

Default
yes
Example
yes
Booleanoptional
Body stylebodystyle

Custom CSS for the box

Default
border-collapse: collapse
Stringoptional
Storm categorycategory

The storm category. This populates the header color and name automatically.

Stringsuggested
Basinbasin

Basin of the storm. Controls the name of the category, if the category supports basin-specific names.

Suggested values
atl epac satl wpac
Stringoptional
Header textheader

Header text to show. Overrides category name if provided.

Contentoptional
Header styleheader-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.

Default
font-size: 100%; background-color: #{​{Storm colour|{​{​{category|}​}​}​}​}
Stringoptional
No header?no-header

Disables the header row

Default
no
Example
yes
Booleanoptional
Subheader textsubheader

Subheader text to show. Overrides interval, scale, and agency, if provided.

Contentoptional
Measurement intervalinterval

The measurement interval used by the agency. e.g. JMA uses 10-minute, JTWC uses 1-minute.

Example
1
Numbersuggested
Post-interval textpost-interval postinterval

Text to add after "N-minute sustained". A space is automatically provided.

Stringoptional
Agencyagency

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
[[National Weather Service|NWS]]
Contentsuggested
Scalescale

Scale used to quantify the meteorological data. If the scale is used by multiple agencies, consider supplying "agency".

Example
[[Saffir–Simpson scale|SSHWS]]
Contentsuggested
Maximum sustained windswinds

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
Numbersuggested
Maximum winds prefixwinds-prefix

Prefix for the maximum sustained winds. Use this to add approximation symbols, such as '~', '<', or '>'.

Example
~
Stringoptional
Maximum winds suffixwinds-suffix

Suffix for the maximum sustained winds. Use this to add references, footnotes, or other content.

Contentoptional
Maximum wind gustgusts

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
Numbersuggested
Maximum gusts prefixgusts-prefix

Prefix for the maximum wind gusts. Use this to add approximation symbols, such as '~', '<', or '>'.

Example
~
Stringoptional
Maximum gusts suffixgusts-suffix

Suffix for the maximum wind gusts. Use this to add references, footnotes, or other content.

Contentoptional
Beaufort scalebeaufort-scale beaufort scale

The maximum sustained winds on the Beaufort scale. Rarely used except for historical storms; consider using "winds" instead.

Numberoptional
Lowest pressurepressure

Lowest pressure, usually measured near the storm's center. Supply value in hectopascals/millibars (hPa/mbar).

Example
975
Numbersuggested
Lowest pressure prefixpressure-prefix

Prefix for the pressure. Use this to add approximation symbols, such as '~', '<', or '>'.

Example
~
Stringoptional
Lowest pressure suffixpressure-suffix

Suffix for the lowest pressure. Use this to add references, footnotes, or other content.

Contentoptional
Lowest temperaturelowest-temperature lowest temperature

Lowest temperature. Supply value in Fahrenheit when "basin" is "atl" or "epac". Otherwise, supply the value in Celcius.

Example
13
Numbersuggested
Lowest temperature prefixtemperature-prefix

Prefix for the temperature. Use this to add approximation symbols, such as '~', '<', or '>'.

Example
~
Stringoptional
Lowest temperature suffixtemperature-suffix

Suffix for the lowest recorded temperature. Use this to add references, footnotes, or other content.

Contentoptional
Largest haillargest-hail largest hail

Largest recorded size of hail. Supply value in inches when "basin" is "atl" or "epac". Otherwise, supply the value in centimeters.

Example
12
Numberoptional
Largest hail suffixlargest-hail-suffix

Suffix for the largest hail recorded. Use this to add references, footnotes, or other content.

Contentoptional
Maximum rainfallmaximum-rain maximum rain

Maximum recorded rainfall. Supply value in inches when "basin" is "atl" or "epac". Otherwise, supply the value in centimeters.

Example
42
Numberoptional
Maximum rainfall suffixmaximum-rain-suffix

Suffix for the maximum recorded rainfall. Use this to add references, footnotes, or other content.

Contentoptional
Maximum snow or ice accretionmaximum-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.

Contentoptional
Maximum snow accumulation or ice accretion suffixmaximum-snow-suffix

Suffix for the maximum recorded snow accumulation or ice accretion. Use this to add references, footnotes, or other content.

Unknownoptional
Storm auto categoryauto-category

The automatic category of the storm. This defines the category of the storm if a category parameter was not explicitly provided.

Stringsuggested
Header suffixheader-suffix

Suffix for the header. Comes after the category name or actual header, if provided.

Contentsuggested