Difference between revisions of "Template:Canada provinces map/doc"
Jump to navigation
Jump to search
imported>Andrybak |
|||
(9 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
− | <!-- PLEASE ADD CATEGORIES | + | <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE --> |
==Usage== | ==Usage== | ||
Add {{tl|Canada provinces map}} in articles pertaining [[provinces and territories of Canada]]. | Add {{tl|Canada provinces map}} in articles pertaining [[provinces and territories of Canada]]. | ||
Line 7: | Line 7: | ||
<pre> | <pre> | ||
{{Canada provinces map | {{Canada provinces map | ||
+ | |align = right | ||
|map= | |map= | ||
+ | |prefix = | ||
|width = | |width = | ||
}} | }} | ||
Line 16: | Line 18: | ||
<pre> | <pre> | ||
{{Canada provinces map | {{Canada provinces map | ||
+ | |align = right | ||
|map= | |map= | ||
− | |BC = British Columbia | + | |prefix = |
− | | | + | |BC = British Columbia |
− | |SK = Saskatchewan | + | | |
− | |MB = Manitoba | + | |SK = Saskatchewan |
− | | | + | |MB = Manitoba |
− | | | + | | |
− | |NB = New Brunswick | + | | |
− | |PE = Prince Edward Island | + | |NB = New Brunswick |
− | |NS = Nova Scotia | + | |PE = Prince Edward Island |
− | |NL = Newfoundland and Labrador | + | |NS = Nova Scotia |
− | | | + | |NL = Newfoundland and Labrador |
− | | | + | | |
− | | | + | | |
+ | | | ||
|width = 220px | |width = 220px | ||
− | |border = | + | |border = <!-- none --> |
|caption = | |caption = | ||
}} | }} | ||
Line 37: | Line 41: | ||
==Parameters== | ==Parameters== | ||
− | The | + | The <code>prefix</code> and <code>XY</code> parameters are used to adjust the wikilinks for the provinces and territories. |
− | + | {| class="wikitable" | |
+ | |- | ||
+ | ! Parameter !! Default !! Usage | ||
+ | |- | ||
+ | |<code>align</code> || <code>right</code> || Possible values are <code>left</code>, <code>right</code>, <code>center</code>, and <code>none</code> | ||
+ | |- | ||
+ | |<code>map</code> || <code>Canada-provinces layout.png</code> || Any image can be used, but be careful to make sure the labels are aligned with the provinces and territories | ||
+ | |- | ||
+ | |<code>prefix</code> || ''blank'' || text to use to prefix each link (for example, <code>Geography of</code>) | ||
+ | |- | ||
− | + | |- | |
− | + | |<code>BC</code> || <code>British Columbia</code> || name of an article (overrides the <code>prefix</code> parameter) | |
− | + | |- | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | < | + | |- |
− | < | + | |<code>SK</code> || <code>Saskatchewan</code> || name of an article (overrides the <code>prefix</code> parameter) |
+ | |- | ||
+ | |<code>MB</code> || <code>Manitoba</code> || name of an article (overrides the <code>prefix</code> parameter) | ||
+ | |- | ||
+ | |||
+ | |- | ||
+ | |||
+ | |- | ||
+ | |<code>NB</code> || <code>New Brunswick</code> || name of an article (overrides the <code>prefix</code> parameter) | ||
+ | |- | ||
+ | |<code>PE</code> || <code>Prince Edward Island</code> || name of an article (overrides the <code>prefix</code> parameter) | ||
+ | |- | ||
+ | |<code>NS</code> || <code>Nova Scotia</code> || name of an article (overrides the <code>prefix</code> parameter) | ||
+ | |- | ||
+ | |<code>NL</code> || <code>Newfoundland and Labrador</code> || name of an article (overrides the <code>prefix</code> parameter) | ||
+ | |- | ||
+ | |||
+ | |||
+ | |- | ||
− | + | |- | |
+ | |<code>width</code> || <code>280px</code> || | ||
+ | |- | ||
+ | |<code>border</code> || ''blank'' || set to <code>none</code> to remove the border (which is useful when there is no image, and the map is embedded in a table or sidebar) | ||
+ | |- | ||
+ | |<code>caption</code> || ''blank'' || use to add a caption to the image | ||
+ | |} | ||
− | <!-- PLEASE ADD | + | ==See also== |
− | [[ | + | *[[Template:Canada topic]] |
− | [[ | + | <includeonly>{{Sandbox other|| |
− | + | <!-- PLEASE ADD CATEGORIES BELOW THIS LINE, THANKS. --> | |
− | + | [[Category:Canada geography and place templates|Provinces map]] | |
− | + | [[Category:Dynamic map templates]] | |
− | + | }}</includeonly> | |
− | |||
− | </includeonly> |
Latest revision as of 16:43, 24 October 2020
![]() | This is a documentation subpage for Template:Canada provinces map. It contains usage information, categories and other content that is not part of the original template page. |
Usage
Add {{Canada provinces map}} in articles pertaining provinces and territories of Canada.
Simple syntax:
{{Canada provinces map |align = right |map= |prefix = |width = }}
A Canada provinces map with linked labels will be rendered.
Complete syntax:
{{Canada provinces map |align = right |map= |prefix = |BC = British Columbia | |SK = Saskatchewan |MB = Manitoba | | |NB = New Brunswick |PE = Prince Edward Island |NS = Nova Scotia |NL = Newfoundland and Labrador | | | |width = 220px |border = <!-- none --> |caption = }}
Parameters
The prefix
and XY
parameters are used to adjust the wikilinks for the provinces and territories.
Parameter | Default | Usage |
---|---|---|
align |
right |
Possible values are left , right , center , and none
|
map |
Canada-provinces layout.png |
Any image can be used, but be careful to make sure the labels are aligned with the provinces and territories |
prefix |
blank | text to use to prefix each link (for example, Geography of )
|
BC |
British Columbia |
name of an article (overrides the prefix parameter)
|
SK |
Saskatchewan |
name of an article (overrides the prefix parameter)
|
MB |
Manitoba |
name of an article (overrides the prefix parameter)
|
NB |
New Brunswick |
name of an article (overrides the prefix parameter)
|
PE |
Prince Edward Island |
name of an article (overrides the prefix parameter)
|
NS |
Nova Scotia |
name of an article (overrides the prefix parameter)
|
NL |
Newfoundland and Labrador |
name of an article (overrides the prefix parameter)
|
width |
280px |
|
border |
blank | set to none to remove the border (which is useful when there is no image, and the map is embedded in a table or sidebar)
|
caption |
blank | use to add a caption to the image |