Template:Tropical cyclone season effects (cyclone)/doc

Usage

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.

Parameter		Description	Type	Status
Name	name	The name of the storm Example Katrina	String	required
Date formed	formed	The date that this storm formed. Example 2020-12-31, 02 February 2020, etc. Auto value {{subst:CURRENTDATE}}	Date	required
Date dissipated	dissipated	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.	Date	suggested
Maximum sustained wind speed	winds	The maximum sustained wind speed in kph (default, can be changed by `winds-unit`). Example 220	Number	suggested
Wind speed units	winds-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	String	optional
Lowest barometric pressure	pressure	The lowest pressure within the storm in hPa (can be changed by `pressure-unit`). Example 920	Number	suggested
Barometric pressure units	pressure-unit	The units used for pressure. This will also automatically change `pressure-target` if it was not set. Example hPa, inHg, mbar	String	optional
Damages	damages	The damages caused by the storm in USD (can be changed by `damages-currency`). Example 104938213	Number	suggested
Deaths	deaths	The deaths caused by the storm. Example 400	Number	suggested
Page	page	The article for the storm (if it exists). Example Hurricane Katrina	Page name	suggested
Category	category	The category of the storm. Example cat5, nwpdepression, vintense, sprcyclstorm	String	suggested
Category sorting value	category-sort	The sorting value of the category. This is used to enable sorting capabilities for the "Category" column.	Number	optional
Wind speed sorting value	winds-sort	The sorting value for wind speed. This usually isn't required unless the wind speed is not a number.	Number	optional
Wind speed prefix	winds-prefix	Text that goes before the wind speed. Example <, >, etc.	String	optional
Wind speed target unit	winds-target	The targeted unit for conversion. This is automatically guessed, but can be forced by the user. Example kph, mph, kn	String	optional
Barometric pressure sorting value	pressure-sort	The sorting value for pressure. This usually isn't required unless the pressure is not a number.	Number	optional
Pressure prefix	pressure-prefix	Text that goes before the pressure. Example <, >, etc.	String	optional
Pressure target unit	pressure-target	The targeted unit for conversion. This is automatically guessed, but can be forced by the user. Example kph, mph, kn	String	optional
Affected areas	affected	The list of affected areas. Example [[China]], [[Hong Kong]], [[Palau]], [[Philippines]], [[Japan]], [[Thailand]], [[Vietnam]]	Content	suggested
Damages currency	damages-currency	The currency symbol used for damages. Default $ Example €, £, ¥, etc.	String	optional
Damages prefix	damages-prefix	Text that goes before the damages. Example <, >, etc.	String	optional
Deaths prefix	deaths-prefix	Text that goes before the deaths. Example <, >, etc.	String	optional
References	refs	References to the storm's impact or meteorological data.	Content	suggested
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	Boolean	suggested