View source for Template:WPTC track map/doc

{{documentation subpage}}
This template is an updated version of {{tl|hurricane auto track map}} for newer [[:Category:Tropical cyclone tracks|tropical cyclone track maps]]. These track maps will be put automatically in the public domain as {{tl|PD-self}}.
== Usage ==
For most storms, use this formulation of the template:
<pre><nowiki>
{{WPTC track map | author= | name= | season= | start= | end= | source= | catname= | code=}}
</nowiki></pre>
For current storms, where the pre-filled source information will not be adequate (see [[#Parameters|Parameters]] below), use this formulation to provide a custom source:
<pre><nowiki>
{{WPTC track map | author= | name= | season= | start= | end= | othersource= | catname= | code=}}
</nowiki></pre>

== Parameters ==
{| class = wikitable
|-
! Parameter 
! Description 
! Acceptable value
|-
! <tt>name</tt>
| Name of the storm for which this track map was made 
| Any string
|-
! <tt>article</tt>
| Article for the storm for which this track map was made; if the same as <tt>name</tt>, then this parameter is not needed
| Any string
|-
! <tt>season</tt>
| Season article to which this storm belongs
| Any string
|-
! <tt>author</tt>
| Author of the track map
| Any string
|-
! <tt>source</tt>
| For common data sources, this field provides pre-filled source information. See the template's source code to see the existing pre-filled templates.
| Any of <tt>NHC</tt>, <tt>CPHC</tt>, <tt>JTWC</tt>, <tt>JMA</tt>, <tt>NHCCPHC</tt>, <tt>CPHCJTWC</tt>
|- 
! <tt>othersource</tt>
| If a custom data source is being used (e.g. running best tracks), fill out the correct source description here
| Any string
|-
! <tt>catname</tt>
| The name of the storm's Commons category. By default, the template tries to put the track map in <tt><nowiki>[[:Category:{{{name}}}]]</nowiki></tt>, and also sort the track map in <tt><nowiki>[[:Category:{{{season}}}]]</nowiki></tt> and <tt><nowiki>[[:Category:Tropical cyclone tracks]]</nowiki></tt> with <tt>{{{name}}}</tt>. Entering a value here will override this assumption.
| Any string
|-
! <tt>code</tt>
| This optional parameter can store the invocation of the [[:wikipedia:Wikipedia:WikiProject Tropical cyclones/Tracks|track map generator]] on the command line. 
| Any string
|}

== Example ==
This code produces the result immediately below:
<pre><nowiki>
{{WPTC track map 
| author = Titoxd
| name = Hurricane Adrian
| season = 2011 Pacific hurricane season
| start = 2011-06-03
| end = 2011-06-09
| othersource=Tracking data from the {{w|National Hurricane Center}}'s running best track.<sup>[ftp://ftp.nhc.noaa.gov/atcf/btk/bep012011.dat]</sup>
| catname=Hurricane Adrian (2011)
| code=./track --format atcf --input ../tracks-data/2011/btk/bep012011.dat  --output ~/public-html/wptc-maps/Adrian_2011_track.png --extra 1
}}
</nowiki></pre>
{{WPTC track map 
| author = Titoxd
| name = Hurricane Adrian
| season = 2011 Pacific hurricane season
| start = 2011-06-03
| end = 2011-06-09
| othersource=Tracking data from the {{w|National Hurricane Center}}'s running best track.<sup>[ftp://ftp.nhc.noaa.gov/atcf/btk/bep012011.dat]</sup>
| catname=Hurricane Adrian (2011)
| code=./track --format atcf --input ../tracks-data/2011/btk/bep012011.dat  --output ~/public-html/wptc-maps/Adrian_2011_track.png --extra 1
}}<includeonly>[[Category:Infobox templates: based on Information template|{{PAGENAME}}]]</includeonly><noinclude>

[[Category:Imported from Wikimedia Commons 2013]]</noinclude>