Template:Infobox weather event/Tornado family/doc
This is a documentation subpage for Template:Infobox weather event/Tornado family. 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 tornado families. The header color changes depending on the highest tornado rating provided; the name stays the same. Use |tornadoes=
to indicate the number of tornadoes in this tornado family.
This template supports two scales: the Fujita scale (priority) and the TORRO scale. These can be provided using the |fujita-scale=
and |torro-scale=
parameters, respectively. The version of the Fujita scale changes depending on the value. For example, supplying |fujita-scale=EF5
will make the template automatically use the Enhanced Fujita scale. Likewise, supplying |fujita-scale=IF5
will make the template automatically use the International Fujita scale. The color of the header may be overridden with the |category=
parameter; supply a valid storm category color to change it.
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 lang="wikitext">Template:Infobox weather event/Tornado family</syntaxhighlight> | Template:Infobox weather event/Tornado family |
<syntaxhighlight lang="wikitext">Template:Infobox weather event/Tornado family</syntaxhighlight> | Template:Infobox weather event/Tornado family |
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." }, "tornadoes": { "label": "Tornadoes confirmed", "description": "The number of confirmed tornadoes in this tornado family.", "type": "number", "required": true },"fujita-scale": { "aliases": [ "fujitascale", "fujita" ], "label": "Fujita scale", "description": "The Fujita scale number of the strongest tornado in the tornado family. This could be an Enhanced Fujita scale, International Fujita scale, or standard Fujita scale, depending on the value provided.", "suggestedvalues": [ "F0", "F1", "F2", "F3", "F4", "F5", "EFU", "EF0", "EF1", "EF2", "EF3", "EF4", "EF5", "IF0-", "IF0", "IF0+", "IF1-", "IF1", "IF1+", "IF2-", "IF2", "IF2+", "IF3", "IF4", "IF5" ], "type": "string", "suggested": true }, "torro-scale": { "aliases": [ "torroscale", "torro" ], "label": "TORRO scale", "description": "The TORRO scale number of the strongest tornado in the tornado family.", "suggestedvalues": [ "FC", "T0", "T1", "T2", "T3", "T4", "T5", "T6", "T7", "T8", "T9", "T10", "T11" ], "type": "string", "suggested": true }, "fujita-ref": { "label": "Fujita rating reference", "description": "Reference for the Fujita rating of the strongest tornado in the tornado family.", "type": "content", "suggested": true }, "torro-ref": { "label": "TORRO rating reference", "description": "Reference for the TORRO rating of the strongest tornado in the tornado family.", "type": "content", "suggested": true }, "intensity-ref": { "label": "Intensity reference", "description": "Reference for the Fujita/TORRO rating of the strongest tornado in the tornado family. Use this in case the reference is the same between both ratings.", "type": "content" }, "duration": { "label": "Duration", "description": "The tornado family’s total duration.", "type": "content", "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>