Difference between revisions of "Template:Infobox storm/doc"

From blackwiki
Jump to navigation Jump to search
imported>Bamyers99
(Documented enhanced parameter)
imported>Bamyers99
(Added TemplateData)
Line 46: Line 46:
 
*{{tl|Infobox flood}}
 
*{{tl|Infobox flood}}
 
*{{tl|Infobox hurricane}}
 
*{{tl|Infobox hurricane}}
 +
 +
==TemplateData==
 +
<templatedata>
 +
{
 +
"params": {
 +
"name": {
 +
"aliases": [
 +
"event"
 +
],
 +
"label": "Name",
 +
"description": "Name of storm",
 +
"example": "Hurricane Katrina",
 +
"type": "string"
 +
},
 +
"image": {
 +
"aliases": [
 +
"image location"
 +
],
 +
"label": "Image"
 +
},
 +
"image alt": {
 +
"aliases": [
 +
"alt"
 +
],
 +
"label": "Image alternative text",
 +
"description": "Alternative text for image.",
 +
"type": "string"
 +
},
 +
"caption": {
 +
"aliases": [
 +
"image name"
 +
],
 +
"label": "Image caption",
 +
"description": "Caption beneath image.",
 +
"type": "string"
 +
},
 +
"type": {
 +
"aliases": [
 +
"stormtype"
 +
],
 +
"label": "Type",
 +
"description": "Storm type",
 +
"example": "Blizzard",
 +
"type": "string"
 +
},
 +
"formed": {
 +
"aliases": [
 +
"date formed"
 +
],
 +
"label": "Formed",
 +
"description": "Date storm started",
 +
"type": "date"
 +
},
 +
"active": {
 +
"label": "Duration",
 +
"description": "Time period storm was active",
 +
"type": "string"
 +
},
 +
"dissipated": {
 +
"aliases": [
 +
"date dissipated"
 +
],
 +
"label": "Dissipated",
 +
"description": "Date storm ended",
 +
"type": "date"
 +
},
 +
"lowest pressure": {
 +
"label": "Lowest pressure",
 +
"description": "in mb/hPa",
 +
"type": "string"
 +
},
 +
"pressure": {},
 +
"lowest temperature": {
 +
"label": "Lowest temperature",
 +
"type": "string"
 +
},
 +
"tornadoes": {
 +
"label": "Tornadoes confirmed",
 +
"type": "string"
 +
},
 +
"fujitascale": {
 +
"label": "Fujita scale / Enhanced Fujita scale",
 +
"description": "add parameter enhanced=yes for Enhanced Fujita scale",
 +
"example": "EF4",
 +
"type": "string"
 +
},
 +
"enhanced": {
 +
"label": "Enhanced Fujita scale",
 +
"description": "Set to yes if fujitascale is enhanced",
 +
"example": "yes",
 +
"type": "string"
 +
},
 +
"tornado duration": {
 +
"label": "Duration of tornado outbreak",
 +
"type": "string"
 +
},
 +
"10-min winds": {},
 +
"10-min prefix": {},
 +
"10-min suffix": {},
 +
"1-min winds": {},
 +
"1-min prefix": {},
 +
"1-min suffix": {},
 +
"highest winds": {
 +
"description": "in km/h"
 +
},
 +
"sustained wind": {},
 +
"gusts": {
 +
"aliases": [
 +
"gust"
 +
],
 +
"label": "Highest gust"
 +
},
 +
"gusts prefix": {
 +
"aliases": [
 +
"pregusts"
 +
]
 +
},
 +
"gusts suffix": {},
 +
"beaufort scale": {},
 +
"hail": {
 +
"label": "Largest hail"
 +
},
 +
"RSI": {
 +
"label": "Regional Snowfall Index"
 +
},
 +
"maximum snow": {
 +
"aliases": [
 +
"maximum amount"
 +
],
 +
"label": "Maximum snowfall or ice accretion"
 +
},
 +
"maximum rain": {
 +
"label": "Maximum rainfall"
 +
},
 +
"damages": {
 +
"aliases": [
 +
"total damages (USD)",
 +
"total snow damages (USD)"
 +
],
 +
"label": "Damage"
 +
},
 +
"power outages": {},
 +
"casualties": {
 +
"aliases": [
 +
"total casualties",
 +
"snow casualties"
 +
],
 +
"label": "Casualties"
 +
},
 +
"affected": {
 +
"aliases": [
 +
"areas affected",
 +
"countries affected",
 +
"location"
 +
],
 +
"label": "Areas affected",
 +
"type": "string"
 +
},
 +
"current advisories": {},
 +
"notes": {}
 +
},
 +
"description": "Infobox for a storm",
 +
"format": "block"
 +
}
 +
</templatedata>
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

Revision as of 19:03, 21 August 2016

This template may be used in articles about storms, including cyclones and winter storms.

Usage

Template:Parameter names example

{{Infobox storm
| name               = <!-- name of event, can be omitted if same as article title -->
| image              = <!-- just the filename-->
| alt                = 
| caption            = 
| type               = 
| formed             = <!-- {{Start date|YYYY|MM|DD|df=y}} -->
| active             = 
| dissipated         = <!-- {{End date|YYYY|MM|DD|df=y}} -->
| lowest pressure    = <!-- in mb/hPa, gets automatically converted to inHg -->
| lowest temperature = 
| tornadoes          = 
| fujitascale        = 
| enhanced           = <!-- yes = Enhanced Fujita scale -->
| tornado duration   = 
| beaufort scale     =
| highest winds      = <!-- in km/h, gets automatically converted to mph and knots -->
| gusts              = 
| hail               = 
| maximum snow       = <!-- maximum snowfall or ice accretion -->
| maximum rain       = <!-- maximum rainfall -->
| power outages      = 
| casualties         = 
| damages            = 
| areas affected     = 
| current advisories = 
| notes              = 
}}

Region- or type-specific parameters

Regional Snowfall Index (used only for U.S. winter storms)

| RSI                = <!-- Regional Snowfall Index -->

See also

TemplateData

Infobox for a storm

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename event

Name of storm

Example
Hurricane Katrina
Stringoptional
Imageimage image location

no description

Unknownoptional
Image alternative textimage alt alt

Alternative text for image.

Stringoptional
Image captioncaption image name

Caption beneath image.

Stringoptional
Typetype stormtype

Storm type

Example
Blizzard
Stringoptional
Formedformed date formed

Date storm started

Dateoptional
Durationactive

Time period storm was active

Stringoptional
Dissipateddissipated date dissipated

Date storm ended

Dateoptional
Lowest pressurelowest pressure

in mb/hPa

Stringoptional
Pressurepressure

no description

Unknownoptional
Lowest temperaturelowest temperature

no description

Stringoptional
Tornadoes confirmedtornadoes

no description

Stringoptional
Fujita scale / Enhanced Fujita scalefujitascale

add parameter enhanced=yes for Enhanced Fujita scale

Example
EF4
Stringoptional
Enhanced Fujita scaleenhanced

Set to yes if fujitascale is enhanced

Example
yes
Stringoptional
Duration of tornado outbreaktornado duration

no description

Stringoptional
10-min winds10-min winds

no description

Unknownoptional
10-min prefix10-min prefix

no description

Unknownoptional
10-min suffix10-min suffix

no description

Unknownoptional
1-min winds1-min winds

no description

Unknownoptional
1-min prefix1-min prefix

no description

Unknownoptional
1-min suffix1-min suffix

no description

Unknownoptional
Highest windshighest winds

in km/h

Unknownoptional
Sustained windsustained wind

no description

Unknownoptional
Highest gustgusts gust

no description

Unknownoptional
Gusts prefixgusts prefix pregusts

no description

Unknownoptional
Gusts suffixgusts suffix

no description

Unknownoptional
Beaufort scalebeaufort scale

no description

Unknownoptional
Largest hailhail

no description

Unknownoptional
Regional Snowfall IndexRSI

no description

Unknownoptional
Maximum snowfall or ice accretionmaximum snow maximum amount

no description

Unknownoptional
Maximum rainfallmaximum rain

no description

Unknownoptional
Damagedamages total damages (USD) total snow damages (USD)

no description

Unknownoptional
Power outagespower outages

no description

Unknownoptional
Casualtiescasualties total casualties snow casualties

no description

Unknownoptional
Areas affectedaffected areas affected countries affected location

no description

Stringoptional
Current advisoriescurrent advisories

no description

Unknownoptional
Notesnotes

no description

Unknownoptional