Template:Infobox weather event/meteorology/TemplateData

Template documentation

Usage

Apply the following to template documentation pages that will use this TemplateData template: <syntaxhighlight lang="wikitext">

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." } }, "description": "Box.", "format": "block" }

</templatedata>

</syntaxhighlight>

Apply parameters as required.

TemplateData

TemplateData-ception. <templatedata> { "params": { "description": { "label": "Description", "description": "A custom description to use.", "type": "string", "suggested": true }, "extra-parameters": { "label": "Extra parameters", "description": "Extra parameters in JSON format.", "type": "string", "suggested": true }, "tc-scale": { "label": "Tropical cyclone scale?", "description": "When true, header parameters are removed; category, scale, and agency are removed (unless explicitly enabled with the 'meta' parameter); and only the data for winds, gusts, pressure, and Beaufort force will be displayed.", "type": "boolean", "suggested": true }, "force-all-data": { "label": "Force all data?", "description": "When true, parameters related to snow and rainfall are included, regardless of whether this is a tropical cyclone scale box or not.", "type": "boolean", "suggested": true }, "no-scale": { "label": "No scale?", "description": "When true, the category and basin parameters are disabled. This also enables the header and header style parameters.", "type": "boolean", "suggested": true }, "has-basin": { "label": "Has basin?", "description": "Should be 'true' whenever the subbox accepts a basin. This may be used for scales which are used in multiple agencies, such as the SSHWS scale (wherein the name must change in basins where the SSHWS is not the RSMC scale).", "type": "boolean", "suggested": true }, "meta": { "label": "Meta template?", "description": "When true, the template is recognized as a meta-template (a template which is the base of other subboxes). Category, agency, and scale parameters will be displayed.", "type": "boolean", "suggested": true } }, "description": "Meta-template for the TemplateData of meteorology-related subboxes.", "format": "inline" } </templatedata>

<syntaxhighlight lang="json"> { "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." } }, "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" } </syntaxhighlight>