Template:Infobox tropical cyclone/doc

Hurricane Hugo
Category 5 major hurricane (SSHWS/NWS)
	Hurricane Hugo as a Category 3 hurricane
Formed	September 10, 1989
Dissipated	September 25, 1989
	(Extratropical after September 22, 1989)
Highest winds	1-minute sustained: 160 mph (260 km/h) ;
Lowest pressure	918 mbar (hPa); 27.11 inHg
Fatalities	107 total (estimated)
Damage	$10 billion (1989 USD)
Areas affected	Lesser Antilles, Puerto Rico, Hispaniola, Turks and Caicos Islands
	Part of the 1989 Atlantic hurricane season
	History Meteorological history; Effects Lesser Antilles; Puerto Rico; Dominican Republic; Haiti; Cuba; United States Florida; Louisiana; Mississippi; ; Tornado outbreak; Other wikis Commons: Georges images;

This is a documentation subpage for Template:Infobox tropical cyclone.
It contains usage information, categories and other content that is not part of the original template page.

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.

Usage

Simple usage

{{Infobox hurricane
| 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 hurricane
| 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 hurricane
| 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

{{Infobox hurricane
| 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, which makes the event details parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to a calendar or diary application. For more information about the use of microformats on Wikipedia, please see the microformat project on English Wikipedia.

Sub-templates

Dates will only be included if you use {{Start date}} or {{End date}} (use the former for single dates; but do not use any of these if the date is before 1583 CE).

URLs will only be included if you use {{URL}}.

Please do not remove instances of these sub-templates.

Classes

hCalendar uses HTML classes including:

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 documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Infobox tropical cyclone

<templatedata> { "description": "This infobox is for articles about specific tropical cyclone events (hurricanes, typhoons, tropical storms, tropical depressions)", "params": { "name": { "description": "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.)", "type": "string", "required": true, "aliases": [ "Name" ] }, "basin": { "description": "[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.", "type": "string", "aliases": [ "Basin" ] }, "type": { "description": "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.", "type": "string", "aliases": [ "Type" ] }, "category": { "description": "Manual entry for type header, per Template:Storm colour.", "type": "string" }, "image": { "description": "[Important!] Location of picture to use", "type": "wiki-file-name", "aliases": [ "Image location" ] }, "alt": { "description": "Alternate text for main image, use if file name is not descriptive.", "type": "string" }, "caption": { "description": "Caption text for main image.", "type": "string" }, "image_size": { "description": "Do not use this setting unless correcting a specific problem. Images will scale to user preferences.", "type": "string" }, "track": { "description": "Used for active storms only. File name of storm map or forecast map.", "type": "wiki-file-name" }, "track_alt": { "description": "Used for active storms only. Alternate text for tracking image, use if file name is not descriptive.", "type": "string" }, "track_caption": { "description": "Used for active storms only. Caption text for tracking image.", "type": "string", "default": "Forecast map" }, "formed": { "label": "Formed", "description": "Date of formation; use Expression error: Unrecognized word "dd"., yyyy (yyyy-mm-dd).", "type": "date", "aliases": [ "Formed" ] }, "dissipated": { "label": "Dissipated", "description": "Date of storm end; leave blank until storm ends, then add Expression error: Unrecognized word "dd"., yyyy (yyyy-mm-dd).", "type": "string", "aliases": [ "Dissipated" ] }, "extratropical": { "description": "Date storm went Extratropical, use Expression error: Unrecognized word "dd"., yyyy (yyyy-mm-dd).", "type": "date", "aliases": [ "Extratropical" ] }, "remnant low": { "description": "Date storm degenerated into a Remnant low, use Expression error: Unrecognized word "dd"., yyyy (yyyy-mm-dd).", "type": "date", "aliases": [ "Remnant low" ] }, "10-min winds": { "label": "Highest winds", "description": "Sustained wind average over a period of 10 minutes (used by most weather agencies) as a pure number. The template will convert appropriately.", "type": "number" }, "3-min winds": { "label": "Highest winds", "description": "Sustained wind average over a period of 3 minute (used by RSMC New Delhi) as a pure number. The template will convert appropriately.", "type": "number" }, "1-min winds": { "label": "Highest winds", "description": "[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.", "type": "number" }, "gusts": { "label": "Gusts", "description": "[Important!] Gusts in knots as a pure number. The template will convert appropriately.", "type": "number", "aliases": [ "Gusts" ] }, "10-min prefix": { "label": "Highest winds", "description": "Optional text before \"10-min winds\"", "type": "string" }, "3-min prefix": { "label": "Highest winds", "description": "Optional text before \"3-min winds\"", "type": "string" }, "1-min prefix": { "label": "Highest winds", "description": "Optional text before \"1-min winds\"", "type": "string" }, "pressurepre": { "label": "Lowest pressure", "description": "Optional text before \"pressure\"", "type": "string", "aliases": [ "Pressurepre" ] }, "pressure": { "label": "Lowest pressure", "description": "[Important!] Pressure in mbar (hPa) as a pure number, will be displayed with labels and converted to inHg.", "type": "number", "aliases": [ "Pressure" ] }, "pressurepost": { "label": "Lowest pressure", "description": "Optional text after \"pressure\"", "type": "string", "aliases": [ "Pressurepost" ] }, "fatalities": { "label": "Fatalities", "description": "Number killed", "type": "string", "aliases": [ "Fatalities" ] }, "damagespre": { "label": "Damages", "description": "Optional text before \"damages\"", "type": "string", "aliases": [ "Damagespre" ] }, "damages": { "label": "Damages", "description": "Monetary cost of damage given as a pure number.", "type": "number", "aliases": [ "Damages" ] }, "year": { "label": "Damages", "description": "Year used for damages amount", "type": "string", "aliases": [ "Year" ] }, "currency": { "label": "Damages", "description": "Alternative currency used for damage amount (default is USD)", "type": "string", "aliases": [ "Currency" ] }, "damagespost": { "label": "Damages", "description": "Optional text after \"damages\"", "type": "string", "aliases": [ "Damagespost" ] }, "affected": { "label": "Areas affected", "description": "Areas affected by the storm (wikilink to location articles)", "type": "wiki-page-name", "aliases": [ "Areas" ] }, "time": { "description": "Used for active storms only. Time of report used for infobox data. Include both local time and UTC.", "type": "string" }, "location": { "label": "Location", "description": "Used for active storms only. The current location of the storm, use Coordinates: Unable to parse latitude as a number:LAT
{{#coordinates:}}: invalid latitude (set \"display=inline,title\" if used on a main article for the storm).", "type": "string" }, "movement": { "label": "Movement", "description": "Speed and direction of storm", "type": "string" }, "misc": { "aliases": [ "module" ], "description": "Use for relevant information not covered by other parameters (not typically used)." }, "cycloneseason": { "description": "Page with list of other storms this year in the same basin.", "type": "wiki-page-name", "aliases": [ "Hurricane season" ] }, "series": { "description": "Other articles related to this storm (used only for major storms),", "type": "wiki-page-name", "aliases": [ "Series" ] }, "related": { "description": "Other related articles. (not typically used)", "type": "wiki-page-name", "aliases": [ "Related" ] }, "mainarticle": { "description": "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.", "type": "wiki-page-name" }, "post-tropical": { "aliases": [ "Post-tropical" ] }, "duration": { "aliases": [ "Duration" ], "label": "Duration" }, "gusts prefix": { "aliases": [ "Pregusts" ], "label": "Gusts prefix", "description": "Optional text before \"gusts\"", "type": "string" } }, "format": "block", "paramOrder": [ "name", "basin", "type", "category", "image", "alt", "caption", "image_size", "track", "track_alt", "track_caption", "formed", "dissipated", "extratropical", "remnant low", "10-min winds", "3-min winds", "1-min winds", "gusts", "10-min prefix", "3-min prefix", "1-min prefix", "gusts prefix", "pressurepre", "pressure", "pressurepost", "fatalities", "damagespre", "damages", "year", "currency", "damagespost", "affected", "time", "location", "movement", "misc", "cycloneseason", "series", "related", "mainarticle", "post-tropical", "duration" ] } </templatedata>