Template:Infobox tropical cyclone/doc
This is a documentation subpage for Template:Infobox tropical cyclone. It may contain 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. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here. |
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
Category 5 major hurricane (SSHWS/NWS) | |
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 | |
{{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
nor collapse nested elements which use them.
Parameters
TemplateData for Infobox tropical cyclone
This infobox is for articles about specific [[tropical cyclone]] events (hurricanes, typhoons, tropical storms, tropical depressions)
Parameter | Description | Type | Status | |
---|---|---|---|---|
name | name 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.) | String | required |
basin | basin 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. | String | optional |
type | type 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. | String | optional |
category | category | Manual entry for type header, per [[Template:Storm colour]]. | String | optional |
image | image Image location | [Important!] Location of picture to use | File | optional |
alt | alt | Alternate text for main image, use if file name is not descriptive. | String | optional |
caption | caption | Caption text for main image. | String | optional |
image_size | image_size | Do not use this setting unless correcting a specific problem. Images will scale to user preferences. | String | optional |
track | track | Used for active storms only. File name of storm map or forecast map. | File | optional |
track_alt | track_alt | Used for active storms only. Alternate text for tracking image, use if file name is not descriptive. | String | optional |
track_caption | track_caption | Used for active storms only. Caption text for tracking image.
| String | optional |
Formed | formed Formed | Date of formation; use {{start date|yyyy|mm|dd}}. | Date | optional |
Dissipated | dissipated Dissipated | Date of storm end; leave blank until storm ends, then add {{end date|yyyy|mm|dd}}. | String | optional |
extratropical | extratropical Extratropical | Date storm went [[Extratropical cyclone|Extratropical]], use {{start date|yyyy|mm|dd}}. | Date | optional |
remnant low | remnant low Remnant low | Date storm degenerated into a [[Post-tropical cyclone|Remnant low]], use {{start date|yyyy|mm|dd}}. | Date | optional |
Highest winds | 10-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. | Number | optional |
Highest winds | 3-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. | Number | optional |
Highest winds | 1-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. | Number | optional |
Gusts | gusts Gusts | [Important!] Gusts in [[Knot (unit)|knots]] as a pure number. The template will convert appropriately. | Number | optional |
Highest winds | 10-min prefix | Optional text before "10-min winds" | String | optional |
Highest winds | 3-min prefix | Optional text before "3-min winds" | String | optional |
Highest winds | 1-min prefix | Optional text before "1-min winds" | String | optional |
Gusts prefix | gusts prefix Pregusts | Optional text before "gusts" | String | optional |
Lowest pressure | pressurepre Pressurepre | Optional text before "pressure" | String | optional |
Lowest pressure | pressure Pressure | [Important!] Pressure in mbar (hPa) as a pure number, will be displayed with labels and converted to inHg. | Number | optional |
Lowest pressure | pressurepost Pressurepost | Optional text after "pressure" | String | optional |
Fatalities | fatalities Fatalities | Number killed | String | optional |
Damages | damagespre Damagespre | Optional text before "damages" | String | optional |
Damages | damages Damages | Monetary cost of damage given as a pure number. | Number | optional |
Damages | year Year | Year used for damages amount | String | optional |
Damages | currency Currency | Alternative currency used for damage amount (default is USD) | String | optional |
Damages | damagespost Damagespost | Optional text after "damages" | String | optional |
Areas affected | affected Areas | Areas affected by the storm (wikilink to location articles) | Page name | optional |
time | time | Used for active storms only. Time of report used for infobox data. Include both local time and UTC. | String | optional |
Location | location | 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). | String | optional |
Movement | movement | Speed and direction of storm | String | optional |
misc | misc module | Use for relevant information not covered by other parameters (not typically used). | Unknown | optional |
cycloneseason | cycloneseason Hurricane season | Page with list of other storms this year in the same basin. | Page name | optional |
series | series Series | Other articles related to this storm (used only for major storms), | Page name | optional |
related | related Related | Other related articles. (not typically used) | Page name | optional |
mainarticle | mainarticle | 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 name | optional |
post-tropical | post-tropical Post-tropical | no description | Unknown | optional |
Duration | duration Duration | no description | Unknown | optional |
See also
- {{Infobox earthquake}}
- {{Infobox flood}}
- {{Infobox storm}}
- {{Infobox tornado}}
- Category:Tropical cyclone articles needing attention - used to track certain articles that experience errors using the infobox