Template:Tropical cyclone season effects/doc

Usage
Creates the tropical cyclone season effects table found in tropical cyclone articles.

If the season spans multiple years, you need to use the  and   parameters to specify the start and end of the season article. You also need to set the  parameter on each Tropical cyclone season effects (cyclone) to   (or similarly truthy) in order to show the full year instead of just the months.

The footer values are automatically calculated. The  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
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.

The header can be hidden with.

When the table is empty, it becomes unsortable and no values are displayed in the season aggregates.

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  argument must be set to any truthy value in order to display the period as "Season ongoing".

Mechanism
Tropical cyclone season effects (cyclone) automatically inserts the following element inside the "name" cell. This metadata element is not displayed, and should be invisible from the user in all cases. The  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,  , and   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  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.