Template:Tropical cyclone season effects/doc
 | This is a documentation subpage for Template:Tropical cyclone season effects. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template uses Lua: |
Usage
[edit]Creates the tropical cyclone season effects table found in tropical cyclone articles.
If the season spans multiple years, you need to use the start-year and end-year parameters to specify the start and end of the season article. You also need to set the force-year parameter on each {{Tropical cyclone season effects (cyclone)}} to true (or similarly truthy) in order to show the full year instead of just the months.
The footer values are automatically calculated. The {{{1}}} of the template must always be a set of {{Tropical cyclone season effects (cyclone)}} templates, as this template contains the tracking metadata required to automatically calculate the season aggregates. You can include other templates, however if this were a row for a storm, its data will not be used in calculations unless the proper metadata tag is added.
Examples
[edit]The following is a reconstruction of the 2020 Pacific typhoon season effects table. Note that the final calculation for damages are different. This is because the damages listed in the original article is incorrect. You can use any calculator at your disposal to confirm this.
2020 Pacific typhoon season
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The header can be hidden with no-header.
When the table is empty, it becomes unsortable and no values are displayed in the season aggregates.
| Name | Dates active | Peak intensity | Areas affected | Damage (US$) |
Deaths | Refs | ||
|---|---|---|---|---|---|---|---|---|
| Category | Wind speed | Pressure | ||||||
| Season aggregates | ||||||||
| 0 systems | Season not started | |||||||
When the season is ongoing and cyclones are currently active, the season's period will show the entire period of the season. If the season is ongoing but no cyclones are active, the active argument must be set to any truthy value in order to display the period as "Season ongoing".
| Name | Dates active | Peak intensity | Areas affected | Damage (US$) |
Deaths | Refs | ||
|---|---|---|---|---|---|---|---|---|
| Category | Wind speed | Pressure | ||||||
| Storm A | January 17 – 21 | Tropical storm | 35 km/h (25 mph) | 1004 hPa (29.65 inHg) | $10 million | None | ||
| Storm B | October 1 – present | Tropical depression | 75 km/h (45 mph) | 960 hPa (28.35 inHg) | $50,000 | >2,322 | ||
| Season aggregates | ||||||||
| 2 systems | January 17 – 21, 2020 | 75 km/h (45 mph) | 960 hPa (28.35 inHg) | $10.1 million | 2,322 | |||
Wikitext
|
|---|
{{Tropical cyclone season effects|no-header=yes|year=2021|basin=WPac|
{{Tropical cyclone season effects (cyclone)|name=Storm A|formed=2020-01-17|dissipated=2020-01-21|category=nwpstorm|winds=20|pressure=1004|damages=10000000|deaths=0}}
{{Tropical cyclone season effects (cyclone)|name=Storm B|formed=2020-10-01|dissipated=|category=depression|winds=40|pressure=960|damages=50000|deaths-prefix=>|deaths=2322}}
}}
|
| Name | Dates active | Peak intensity | Areas affected | Damage (US$) |
Deaths | Refs | ||
|---|---|---|---|---|---|---|---|---|
| Category | Wind speed | Pressure | ||||||
| Storm B | January 1 – 4 | Tropical depression | Not specified | Unknown | None | None | ||
| Season aggregates | ||||||||
| 1 system | January 1, 2024 – Season ongoing | |||||||
Wikitext
|
|---|
{{Tropical cyclone season effects|active=yes|no-header=yes|year=2021|basin=WPac|
{{Tropical cyclone season effects (cyclone)|name=Storm B|formed={{CURRENTYEAR}}-01-01|dissipated={{CURRENTYEAR}}-01-04|category=depression|winds=Not specified|damages=0|deaths=0}}
}}
|
Mechanism
[edit]{{Tropical cyclone season effects (cyclone)}} automatically inserts the following element inside the "name" cell.
<span style="display:none;" data-tcse-entry='{"damages":"0","formed":"2022-01-01","name":"Storm name","category":"depression","dissipated":"2022-01-04","winds":"Not specified","deaths":"0"}'></span>
This metadata element is not displayed, and should be invisible from the user in all cases. The data-tcse-entry attribute is the primary search target for the template module. It contains a JSON string that includes specific data about the storm. This is then parsed by the main template to automatically summarize the values.
The default units are the units most used internationally – kilometers per hour (kph), hectopascals (hPa), and US dollars ($). These units may be overriden in the cyclone entry template using the winds-unit, pressure-unit, and damages-currency parameters. These same parameters can be used in the main template in order to override the results of the final computation. The currency link at the header can be modified with the currency-link parameter.
This template disallows mixed units in each row. If different units are used in one of the rows, the entire table will return an error.
See also
[edit]This template is composed of two other templates and requires one template for its content.
- Template:Tropical cyclone season effects (top)
- Template:Tropical cyclone season effects (bottom)
- Template:Tropical cyclone season effects (cyclone), which denotes entries in the template
- Template:Australian cyclone season effects (top), the basis for the header
Aggregates the overall effects of tropical cyclones in a given year range and basin.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Don't show header? | no-header | Whether or not to hide the table header. If true, `basin` and `year` are no longer required. | Boolean | suggested |
| Basin | basin | The basin of the season article
| String | suggested |
| Season (start) year | season-start-year year | If this is a single-year article, this is the year of the season. If this is a multi-year article, this is the first year this article handles. | Number | suggested |
| Season end year | season-end-year | If this is a multi-year season article, this is the last year this article handles. | Number | suggested |
| Wind speed target unit | winds-target | The targeted unit for conversion. This is automatically guessed, but can be forced by the user.
| String | optional |
| Pressure target unit | pressure-target | The targeted unit for conversion. This is automatically guessed, but can be forced by the user.
| String | optional |
| Currency | currency | The currency symbol for damages. This should be the same as the currency used in the main table content.
| String | optional |
| References | footer-refs | References placed in the footer (season aggregates). | Content | suggested |
| Active? | active | Forces the footer of the template to show "Season ongoing".
| Boolean | suggested |
| Storms | 1 | A set of {{Tropical cyclone season effects (cyclone}} templates, which will provide the data for this template.
| Content | required |