Template:Infobox tropical cyclone/doc

From TWC Archive
Jump to navigation Jump to search

Usage

Simple usage

{{Infobox tropical cyclone
| name          = 
| basin         = <!-- Enter one: Atl, EPac, WPac, NIO, SWI, Aus, SPac (see [[Tropical cyclone basins]]) -->
| image         = <!-- filename only -->
| caption       = 
| formed        = <!-- {{start date|yyyy|mm|dd}} -->
| dissipated    = <!-- {{end date|yyyy|mm|dd}} -->
| extratropical = <!-- {{start date|yyyy|mm|dd}} -->
| remnant low   = <!-- {{start date|yyyy|mm|dd}} -->
| post-tropical = <!-- {{start date|yyyy|mm|dd}} -->
| 1-min winds   = <!-- in knots, number only -->
| 3-min winds   = <!-- in knots, number only -->
| 10-min winds  = <!-- in knots, number only -->
| gusts         = <!-- in knots, number only -->
| pressure      = <!-- in mbar (hPa), number only -->
| fatalities    = 
| damages       = 
| affected      = 
| cycloneseason = 
}}

Active storms

{{Infobox tropical cyclone
| name           = 
| basin          = <!-- Enter one: Atl, EPac, WPac, NIO, SWI, Aus, SPac (see [[Tropical cyclone basins]]) -->
| image          = <!-- filename only -->
| caption        = 
| formed         = <!-- {{start date|yyyy|mm|dd}} -->
| dissipated     = <!--leave blank until storm ends, then use {{end date|yyyy|mm|dd}} -->
| extratropical  = <!-- {{start date|yyyy|mm|dd}} -->
| remnant low    = <!-- {{start date|yyyy|mm|dd}} -->
| 1-min winds    = <!-- in knots (other units will display automatically) -->
| 3-min winds    = <!-- in knots (other units will display automatically) -->
| 10-min winds   = <!-- in knots (other units will display automatically) -->
| gusts          = <!-- in knots (other units will display automatically) -->
| pressure       = <!-- in mbar (hPa) (other units will display automatically) -->
| fatalities     = 
| damages        = <!-- Cost of damage in pure number form (in USD, unless currency specified) -->
| year           = <!-- year used for damages figure -->
| currency       = <!-- currency used for damages. Use the [[ISO 4217]] currency code (ex. USD, AUD, JPY) -->
| affected       = <!-- Areas affected -->
| cycloneseason  = <!-- link to season article (ex. [[2014 Pacific typhoon season]]) -->
<!-- Remove these after storm has ended -->
| track         = <!-- storm tracking image filename -->
| track_caption = <!-- Caption below tracking map. defaults to "Forecast map" -->
| time          = <!-- current time used for data (give both local and UTC) -->
| location      = <!-- {{Coord|LAT|LONG|type:event|display=inline}}  (set "display=inline,title" if used on a main article for the storm) -->
| movement      = <!-- direction and speed of movement -->
| mainarticle   = <!-- Page name of the main storm article (helpful when infobox used in season articles) -->
}}

Complete usage for past storms

{{Infobox tropical cyclone
| name          = 
| basin         = <!-- Enter one: Atl, EPac, WPac, NIO, SWI, Aus, SPac (see [[Tropical cyclone basins]]) -->
| type          = <!-- Manual entry of minor storm type (ex. Tropical depression, Tropical storm, Subtropical storm) -->
| category      = <!-- (use only if outside the above basins) manual entry of heading colors, see [[Template:Storm colour]] -->
| image         = 
| alt           = 
| caption       = 
| formed        = <!-- {{start date|yyyy|mm|dd}} -->
| dissipated    = <!--leave blank until storm ends, then use {{end date|yyyy|mm|dd}} -->
| extratropical = <!-- {{start date|yyyy|mm|dd}} -->
| remnant low   = <!-- {{start date|yyyy|mm|dd}} -->
| post-tropical = <!-- {{start date|yyyy|mm|dd}} -->
| duration      = <!-- {{start date|yyyy|mm|dd}} -->
| 1-min prefix  = 
| 1-min winds   = <!-- in knots (plain number only, other units will display automatically) -->
| 3-min prefix  = 
| 3-min winds   = <!-- in knots (plain number only, other units will display automatically) -->
| 10-min prefix = 
| 10-min winds  = <!-- in knots (plain number only, other units will display automatically) -->
| gustspre      = <!-- text to display before gusts, eg: <,≤,>,≥ -->
| gusts         = <!-- in knots (plain number only, other units will display automatically) -->
| pressurepre   = <!-- text to display before pressure, eg: <,≤,>,≥ -->
| pressure      = <!-- in mbar (hPa) -->
| pressurepost  = <!-- text to display below pressure, eg: "world record" -->
| fatalities    = 
| damagespre    = 
| damages       = <!-- Cost of damage in pure number form (in USD, unless currency specified) -->
| year          = <!-- year used for damages figure -->
| currency      = <!-- currency used for damages. Use the [[ISO 4217]] currency code (ex. USD, AUD, JPY) -->
| damagespost   = 
| affected      = <!-- Areas affected -->
| misc          = <!-- Additional relevant information not covered by other sections -->
| cycloneseason = <!-- link to season article (ex. [[2014 Pacific typhoon season]]) -->
| series        = 
| related       = 
| mainarticle   = <!-- Page name of the main storm article (helpful when infobox used in season articles) -->
}}

Example

Hurricane Hugo
Category 5 major hurricane (SSHWS/NWS)
Hurricane Hugo 15 September 1989 1105z.png
Hurricane Hugo as a Category 3 hurricane
FormedSeptember 10, 1989 (1989-09-10)
DissipatedSeptember 25, 1989 (1989-09-25)
(Extratropical after September 22, 1989 (1989-09-22))
Highest winds1-minute sustained: 160 mph (260 km/h)
Lowest pressure918 mbar (hPa); 27.11 inHg
Fatalities107 total (estimated)
Damage$10 billion (1989 USD)
Areas affectedLesser Antilles, Puerto Rico, Hispaniola, Turks and Caicos Islands
Part of the 1989 Atlantic hurricane season
{{Infobox tropical cyclone
| name          = Hurricane Hugo
| type          = hurricane
| basin         = Atl
| image         = Hurricane Hugo 15 September 1989 1105z.png
| caption       = Hurricane Hugo as a Category 3 hurricane
| formed        = {{start date|1989|09|10}}
| dissipated    = {{end date|1989|09|25}}
| extratropical = {{start date|1989|09|22}}
| 1-min winds   = 140
| pressure      = 918
| damages       = 10000
| year          = 1989
| fatalities    = 107 total <small>(estimated)</small>
| affected      = [[Lesser Antilles]], [[Puerto Rico]], [[Hispaniola]], [[Turks and Caicos Islands]]
| cycloneseason = [[1989 Atlantic hurricane season]]
| related       = {{Hurricane Georges related}} (not actually related)
}}

Microformat

The HTML mark-up produced by this template includes an hCalendar microformat that makes event details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.

Classes used

The HTML classes of this microformat include:

  • attendee
  • contact
  • description
  • dtend
  • dtstart
  • location
  • organiser
  • summary
  • url
  • vevent
Please do not rename or remove these classes
nor collapse nested elements which use them.

Parameters

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Infobox tropical cyclone in articles based on its TemplateData.

TemplateData for Infobox tropical cyclone

This infobox is for articles about specific [[tropical cyclone]] events (hurricanes, typhoons, tropical storms, tropical depressions)

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
namename Name

The name of the storm as given by the RSMC, TCWC, or other meteorological organization with jurisdiction over the region where the storm was at peak intensity. (Capitalize every word.)

Stringrequired
basinbasin Basin

[Important!] Code for one of the [[tropical cyclone basins]] that the storm belongs. Enter one: Atl, EPac, WPac, NIO, SWI, Aus, SPac, or leave blank only if rare storm outside of main basins.

Stringoptional
typetype Type

Manual entry for type of storm if outside one of the basins ("hurricane", "typhoon" or "cyclone"). This parameter will accept everything, but ensure proper capitalization.

Stringoptional
categorycategory

Manual entry for type header, per [[Template:Storm colour]].

Stringoptional
imageimage Image location

[Important!] Location of picture to use

Fileoptional
altalt

Alternate text for main image, use if file name is not descriptive.

Stringoptional
captioncaption

Caption text for main image.

Stringoptional
image_sizeimage_size

Do not use this setting unless correcting a specific problem. Images will scale to user preferences.

Stringoptional
tracktrack

Used for active storms only. File name of storm map or forecast map.

Fileoptional
track_alttrack_alt

Used for active storms only. Alternate text for tracking image, use if file name is not descriptive.

Stringoptional
track_captiontrack_caption

Used for active storms only. Caption text for tracking image.

Default
Forecast map
Stringoptional
Formedformed Formed

Date of formation; use {{start date|yyyy|mm|dd}}.

Dateoptional
Dissipateddissipated Dissipated

Date of storm end; leave blank until storm ends, then add {{end date|yyyy|mm|dd}}.

Stringoptional
extratropicalextratropical Extratropical

Date storm went [[Extratropical cyclone|Extratropical]], use {{start date|yyyy|mm|dd}}.

Dateoptional
remnant lowremnant low Remnant low

Date storm degenerated into a [[Post-tropical cyclone|Remnant low]], use {{start date|yyyy|mm|dd}}.

Dateoptional
Highest winds10-min winds

Sustained wind average over a period of 10 minutes (used by most weather agencies) as a pure number. The template will convert appropriately.

Numberoptional
Highest winds3-min winds

Sustained wind average over a period of 3 minute (used by RSMC New Delhi) as a pure number. The template will convert appropriately.

Numberoptional
Highest winds1-min winds

[Important!] Sustained wind average over a period of one minute (used for the Saffir–Simpson hurricane wind scale) as a pure number. The template will convert appropriately.

Numberoptional
Gustsgusts Gusts

[Important!] Gusts in [[Knot (unit)|knots]] as a pure number. The template will convert appropriately.

Numberoptional
Highest winds10-min prefix

Optional text before "10-min winds"

Stringoptional
Highest winds3-min prefix

Optional text before "3-min winds"

Stringoptional
Highest winds1-min prefix

Optional text before "1-min winds"

Stringoptional
Gusts prefixgusts prefix Pregusts

Optional text before "gusts"

Stringoptional
Lowest pressurepressurepre Pressurepre

Optional text before "pressure"

Stringoptional
Lowest pressurepressure Pressure

[Important!] Pressure in mbar (hPa) as a pure number, will be displayed with labels and converted to inHg.

Numberoptional
Lowest pressurepressurepost Pressurepost

Optional text after "pressure"

Stringoptional
Fatalitiesfatalities Fatalities

Number killed

Stringoptional
Damagesdamagespre Damagespre

Optional text before "damages"

Stringoptional
Damagesdamages Damages

Monetary cost of damage given as a pure number.

Numberoptional
Damagesyear Year

Year used for damages amount

Stringoptional
Damagescurrency Currency

Alternative currency used for damage amount (default is USD)

Stringoptional
Damagesdamagespost Damagespost

Optional text after "damages"

Stringoptional
Areas affectedaffected Areas

Areas affected by the storm (wikilink to location articles)

Page nameoptional
timetime

Used for active storms only. Time of report used for infobox data. Include both local time and UTC.

Stringoptional
Locationlocation

Used for active storms only. The current location of the storm, use {{Coord|LAT|LONG|type:event|display=inline}} (set "display=inline,title" if used on a main article for the storm).

Stringoptional
Movementmovement

Speed and direction of storm

Stringoptional
miscmisc module

Use for relevant information not covered by other parameters (not typically used).

Unknownoptional
cycloneseasoncycloneseason Hurricane season

Page with list of other storms this year in the same basin.

Page nameoptional
seriesseries Series

Other articles related to this storm (used only for major storms),

Page nameoptional
relatedrelated Related

Other related articles. (not typically used)

Page nameoptional
mainarticlemainarticle

If this infobox is used in a season article or in a section of some other page, provide a link to the main article for the storm.

Page nameoptional
post-tropicalpost-tropical Post-tropical

no description

Unknownoptional
Durationduration Duration

no description

Unknownoptional

See also