View source for Template:Canada NTS Map Sheet/doc

{{documentation subpage}}
{{lua|Module:Canada NTS|Module:Canada NTS/data}}
{{Uses Wikidata|P625}}
This template creates a link to the Canadian Government [https://maps.canada.ca/czs/index-en.html Geospatial Data Extraction] web page to plot a [[National Topographic System]] (NTS) map sheet bounding box when the template is given an NTS identifier or latitude and longitude.  The bounding box may represent a 1:50,000 scale map sheet or a 1:250,000 scale map sheet.  This template will also give the name of the specified NTS map sheet linked to an appropriate Wikipedia article.

This template has a database of {{#invoke:Canada NTS|doc_support|count}} maps.

The linking schema this template uses is meant to be provisional, contingent on a solution implemented into [[meta:WikiMiniAtlas|WikiMiniAtlas]] to visualize bounding boxes from lists of coordinates.

== Usage ==
[[File:NTS Zones and Map Series Numbers.png|right|thumb|400px|NTS zones and map series.

Legend:
{{legend|#00F|High Arctic zone}}
{{legend|#00C0FF|Arctic zone}}
{{legend|#FFC000|Southern zone}}]]
The most basic use of this template is without parameters.  In that case, the template will attempt to fetch latitude and longitude from the article's [[Wikidata]] entry:
:<code><nowiki>{{Canada NTS Map Sheet}}</nowiki></code>
The template supports a variety of parameters to taylor its output to a specific need.  The map's bounding box can be specified using an NTS identifier or an explicit latitude/longitude pair.

===Basic use===
====Using an NTS identifier====
<code><nowiki>{{Canada NTS Map Sheet</nowiki>|&lt;{{var|series}}>|&lt;{{var|area}}>|&lt;{{var|sheet}}>}}</code>

Where:
*<code>&lt;{{var|series}}></code> is the first part of the ID string, which is a one-to-three digit number indicated on the map at right; leading zeros ignored
*<code>&lt;{{var|area}}></code> is the second part of the ID string, which is a letter from A to P if <code>&lt;{{var|series}}></code> is found in the Southern zone, or A to H if <code>&lt;{{var|series}}></code> is found in the Arctic or High Arctic zone; must be uppercase
*<code>&lt;{{var|sheet}}></code> is the third part of the ID string. If <code>&lt;{{var|sheet}}></code> is a number from 1 to 16 (leading zeros ignored), the template returns a bounding box for a 1:50,000 scale map. If <code>&lt;{{var|sheet}}></code> is omitted, the template returns a bounding box for a 1:250,000 scale map

====Using latitude and longitude====
:<kbd><nowiki>{{Canada NTS Map Sheet</nowiki>|lat=&lt;{{var|lat}}>|lon=&lt;{{var|lon}}>}}</kbd>

Where:
*<code>&lt;{{var|lat}}></code> is the north latitude of a given location in decimal notation
*<code>&lt;{{var|lon}}></code> is the west longitude in decimal notation

The parameters <code>&lt;{{var|lat}}></code> and <code>&lt;{{var|lon}}></code> can be omitted.  If they are, the coordinates will be obtained from the Wikidata entry for the current article.

<code>&lt;{{var|lat}}></code> and <code>&lt;{{var|lon}}></code> are normalized so that they are north latitude and west longitude.  For example, when given the coordinates of [[Novosibirsk]] ({{coord|55|03|N|82|57|E|format=dec}}), the template will provide a link to an untitled map in Ontario at the south shore of Hudson Bay:
:<code><nowiki>{{Canada NTS Map Sheet|lat=55.050|lon=82.950}}</nowiki></code> → {{Canada NTS Map Sheet|lat=55.050|lon=82.950}}

===Optional parameters===

The template supports three optional parameters:
:{{para|area}} – when set to <code>yes</code>, creates a link to a 1:250,000 scale map sheet; defaults to <code>no</code> so the template creates a link to a 1:50,000 scale map sheet
:{{para|link}} – when set to <code>yes</code> (the default), creates a link according to the setting of {{para|area}}
:{{para|name}} – when set to <code>yes</code> (the default), displays [[Natural Resources Canada]]'s name for the map sheet, wikilinked to the corresponding Wikipedia article

==Examples==
====Using an NTS identifier====
For the 1:50,000 scale map that encompasses [[Nanaimo, British Columbia]]:
:<code><nowiki>{{Canada NTS Map Sheet|92|G|4}}</nowiki></code> → {{Canada NTS Map Sheet|92|G|4}}
For the 1:250,000 scale map that encompasses Nanaimo:
:<code><nowiki>{{Canada NTS Map Sheet|92|G}}</nowiki></code> → {{Canada NTS Map Sheet|92|G}}
:<code><nowiki>{{Canada NTS Map Sheet|92|G|4|area=yes}}</nowiki></code> → {{Canada NTS Map Sheet|92|G|4|area=yes}}
For the 1:50,000 scale map that encompasses Nanaimo without a link:
:<code><nowiki>{{Canada NTS Map Sheet|92|G|4|link=no}}</nowiki></code> → {{Canada NTS Map Sheet|92|G|4|link=no}}
For the 1:50,000 scale map that encompasses Nanaimo without a wikilink:
:<code><nowiki>{{Canada NTS Map Sheet|92|G|4|name=no}}</nowiki></code> → {{Canada NTS Map Sheet|92|G|4|name=no}}
leading zeros ignored:
:<code><nowiki>{{Canada NTS Map Sheet|092|G|04}}</nowiki></code> → {{Canada NTS Map Sheet|092|G|04}}

====Using latitude and longitude====
For the 1:50,000 scale map that encompasses [[Nanaimo, British Columbia]]:
:<code><nowiki>{{Canada NTS Map Sheet|lat=49.164|lon=123.936}}</nowiki></code> → {{Canada NTS Map Sheet|lat=49.164|lon=123.936}}
For the 1:250,000 scale map that encompasses Nanaimo:
:<code><nowiki>{{Canada NTS Map Sheet|lat=49.164|lon=123.936|area=yes}}</nowiki></code> → {{Canada NTS Map Sheet|lat=49.164|lon=123.936|area=yes}}
When given both an NTS identifier and latitude and longitude, the template will use the NTS identifier and ignore the latitude and longitude.  For example, this template has the NTS identifier for Nanaimo and latitude and longitude for Toronto ({{coord|43.6426|-79.3871|format=dec}}):
:<code><nowiki>{{Canada NTS Map Sheet|lat=43.6426|lon=-79.3871|92|G|4}}</nowiki></code> → {{Canada NTS Map Sheet|lat=43.6426|lon=-79.3871|92|G|4}}

==Error messages==
This template has crude error reporting:
===Location===
:<span style="color:#d33">lat/long input fail</span> – This error is returned for these two cases:
:*The normalized coordinates specify a location that lies outside of the NTS's coverage area (see the map).  For example, the template returns an error when given the coordinates of [[Helena, Montana]]:
:*:<code><nowiki>{{Canada NTS Map Sheet|lat=46.592|lon=-112.035}}</nowiki></code> → {{Canada NTS Map Sheet|lat=46.592|lon=-112.035}}
:*One or both of {{para|lat}} and {{para|lon}} are missing and Wikidata does not have coordinates for the article in which this template is used.  For example, this template returns an error here because this template's documentation page does not have coordinates at Wikidata:
::<code><nowiki>{{Canada NTS Map Sheet|lat=|lon=}}</nowiki></code> → {{Canada NTS Map Sheet|lat=|lon=}}

===Syntax===
:<span style="color:#d33">invalid NTS series input</span> – This error is returned when the first positional parameter is not a map series number found in [[:File:NTS Zones and Map Series Numbers.png]].
:<span style="color:#d33">invalid NTS area input</span> – This error is returned when the second positional parameter is not in the range of A–P (<div style="display: inline-block; margin-left:.1em">{{legend|#FFC000|Southern zone}}</div>) or A–H (<div style="display: inline-block; margin-left:.1em">{{legend|#00C0FF|Arctic}}</div> and <div style="display: inline-block">{{legend|#00F|High Arctic zones}}</div>).
:<span style="color:#d33">invalid NTS sheet input</span> – This error is returned when the third positional parameter is not a number in the range of 1–16.

<includeonly>{{Sandbox other ||
[[Category:Map formatting and function templates]] 
}}</includeonly>