Jump to content

Template:Tropical cyclone season effects (cyclone)/doc

From Wikipedia, the free encyclopedia

Usage

[edit]

Use this template inside of {{Tropical cyclone season effects}}, in accordance with the documentation of that template.

This template is used for populating {{Tropical cyclone season effects}} and contains the required metadata for calculating the values in that template.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Namename

The name of the storm

Example
Katrina
Stringrequired
Date formedformed

The date that this storm formed.

Example
2020-12-31, 02 February 2020, etc.
Auto value
{{subst:CURRENTDATE}}
Daterequired
Date dissipateddissipated

The date that the storm dissipated. If the storm has not yet dissipated, leave this blank or set it to "present".

Default
present
Example
present, 2021-01-15, 31 December 2020, etc.
Datesuggested
Maximum sustained wind speedwinds

The maximum sustained wind speed in kph (default, can be changed by `winds-unit`).

Example
220
Numbersuggested
Wind speed unitswinds-unit

The units used for wind speed. This will also automatically change `winds-target` if it was not set.

Default
kph
Example
kph, mph, kn
Stringoptional
Lowest barometric pressurepressure

The lowest pressure within the storm in hPa (can be changed by `pressure-unit`).

Example
920
Numbersuggested
Barometric pressure unitspressure-unit

The units used for pressure. This will also automatically change `pressure-target` if it was not set.

Example
hPa, inHg, mbar
Stringoptional
Damagesdamages

The damages caused by the storm in USD (can be changed by `damages-currency`).

Example
104938213
Numbersuggested
Deathsdeaths

The deaths caused by the storm.

Example
400
Numbersuggested
Pagepage

The article for the storm (if it exists).

Example
Hurricane Katrina
Page namesuggested
Categorycategory

The category of the storm.

Example
cat5, nwpdepression, vintense, sprcyclstorm
Stringsuggested
Category sorting valuecategory-sort

The sorting value of the category. This is used to enable sorting capabilities for the "Category" column.

Numberoptional
Wind speed sorting valuewinds-sort

The sorting value for wind speed. This usually isn't required unless the wind speed is not a number.

Numberoptional
Wind speed prefixwinds-prefix

Text that goes before the wind speed.

Example
<, >, etc.
Stringoptional
Wind speed target unitwinds-target

The targeted unit for conversion. This is automatically guessed, but can be forced by the user.

Example
kph, mph, kn
Stringoptional
Barometric pressure sorting valuepressure-sort

The sorting value for pressure. This usually isn't required unless the pressure is not a number.

Numberoptional
Pressure prefixpressure-prefix

Text that goes before the pressure.

Example
<, >, etc.
Stringoptional
Pressure target unitpressure-target

The targeted unit for conversion. This is automatically guessed, but can be forced by the user.

Example
kph, mph, kn
Stringoptional
Affected areasaffected

The list of affected areas.

Example
[[China]], [[Hong Kong]], [[Palau]], [[Philippines]], [[Japan]], [[Thailand]], [[Vietnam]]
Contentsuggested
Damages currencydamages-currency

The currency symbol used for damages.

Default
$
Example
€, £, ¥, etc.
Stringoptional
Damages prefixdamages-prefix

Text that goes before the damages.

Example
<, >, etc.
Stringoptional
Deaths prefixdeaths-prefix

Text that goes before the deaths.

Example
<, >, etc.
Stringoptional
Referencesrefs

References to the storm's impact or meteorological data.

Contentsuggested
Show year?show-year

Whether or not to force the year of the period to show. In case the season spans longer than one year, this must be set to true.

Default
false
Example
true, false
Booleansuggested