Template:Hurricane season bar/doc

This is a documentation subpage for Template:Hurricane season bar.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 2,400 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses TemplateStyles:

Template:Hurricane season bar/styles.css

This template allows a navigational template to be set up for supplying lists of links for tropical storms. It uses Template:Navbox as its backend.

Parameter List edit

Please remove the parameters that are left blank.

{{Hurricane season bar
 | region     =
 | year       =
 | type       =
|storms=
{{Hurricane season bar/button
 | intensity  =
 | stormname  =
 | linkname   =
 }}
{{Hurricane season bar/button
 | intensity  =
 | stormname  =
 | linkname   =
 }}
 
<!-- ... -->

{{Hurricane season bar/button
 | intensity  =
 | stormname  =
 | linkname   =
 }}
}}

Usage edit

This template uses the following common parameters. More detailed descriptions are listed below.

region – the geographical location of the storms intended to be used in this template.

year – the year that pertains this template.

type – the type of tropical storms that pertains this template.

storms – the list of storms for this navbox. Each storm is encapsulated in {{Hurricane season bar/button}} with the following additional parameters:

intensity – the strength of the storm.

stormname – the name of the storm.

linkname – the link for the storm where more information can be found.

Parameter descriptions edit

The following are parameters for this template. Entering the region, year, and type setups the title for this navbox template and creates a link to the parent article described by those parameters. It also pulls the relevant thumbnail for the navbox to use.

Setup parameters edit

region

The geographical location of the storms that pertains to this template. The following are currently valid values for this parameter:

Atlantic

Australian region

Pacific

North Indian Ocean

South Indian Ocean

South Pacific

year: The year the storms that pertains to this template were formed. Values may either be singular years or multi-year, depending on how each geographical location tracks their storm. See Category:Tropical cyclone seasons for reference.

type

This is the tropical storm's geographical name that goes hand-in-hand with its region parameter. Atlantic typhoons, for example, don't exist. The following are current valid values for this parameter:

cyclone

hurricane

typhoon

trackmap: This is an optional parameter should a custom image for the trackmap be desired instead of the one pulled automatically or if the automatic pull fails.

storms: This parameter is responsible for listing the different storms. It uses Template: Hurricane season bar/button for each storm listed. See below for detailed information about the parameters.

Storm parameters edit

intensity: This sets the color and icon for the storm depending on its tropical cyclone intensity. Possible values are transcluded below.

stormname: The storm's name and the name displayed on this template.

linkname: If desired and/or available, a link can be added that allows the user to click it to read more detailed information about the storm.

stormhistorylink: The link to the independent page of the meteorological history of a tropical cyclone.