Difference between revisions of "Template:Location map/doc"

From blackwiki
Jump to navigation Jump to search
imported>Lord Belbury
(remove unnecessary and snide "if you want to waste time")
 
(74 intermediate revisions by 33 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
{{High-risk|428,000+}}
+
{{High-use| 599433 }}
 
{{Lua|Module:Location map}}
 
{{Lua|Module:Location map}}
 +
{{Location map|USA
 +
|relief= 1
 +
|width= 320
 +
|lat= 44.6
 +
|long= -110.5
 +
|caption= Location of [[Yellowstone]] in the north-western United States of America
 +
}}
  
This template generates a location map as a [[m:Help:composite images|composite image]] consisting of a map and a location mark. Optionally a label and caption can be added.
+
The '''location map''' template generates a location map as a [[m:Help:composite images|composite image]], consisting of a map and a location mark. Optionally, a label and caption can be added.
  
== Usage ==
+
==Usage==
 +
Map image files are not accessed directly, but by using an auxiliary map definition. For example, if the first unnamed parameter supplied to this template is {{code|Japan}}, then this template uses the entry for Japan in [[Module:Location map/data/Japan]] if it exists, otherwise it uses {{tl|Location map Japan}}, one of which contains the data needed to generate the composite image.
  
Map image files are not accessed directly but by using an auxiliary map definition. For example, if the first unnamed parameter supplied to this template is "Japan", then this template uses the entry for Japan in [[Module:Location map/data/Japan]] if it exists, or {{tl|Location map Japan}} otherwise, one of which contains the data needed to generate the composite image.
+
===Please note===
 +
*Assigning {{em|any}} value to the parameter {{para|caption}} causes the map to be displayed as a thumbnail image. If this parameter is not declared, the template will generate a default caption.
 +
*The coordinates are not checked. If the coordinates specified fall outside the area covered by the map image, the location mark will not display inside the image; however, it may be displayed somewhere else on the page.
 +
*Do not use {{kbd|px}} when setting the map image size. Using {{para|width|200px}} will usually cause a very large map to be displayed. Use {{para|width|200}}.
 +
*To create a map with more than one location mark, use either {{tl|Location map+}} or {{tl|Location map many}}.
  
;Please note:
+
==Blank templates==
* Assigning any value to the parameter <code>caption</code> causes the map to be displayed as a thumbnail image. If this parameter is not declared, the template will generate a default caption.
 
* The coordinates are not checked. If the coordinates specified fall outside the area covered by the map image, the location mark will not display inside the image; however, it may be displayed somewhere else on the page.
 
* Do not use '''<code>px</code>'''. Using <code>width=200px</code> will usually cause a very large map to be displayed. Use <code>width=200</code>.
 
* To create a map with more than one location mark use {{tl|Location map+}} or {{tl|Location map many}}.
 
  
== Blank templates ==
+
{| class="wikitable"
 
+
|+ Blank templates
{{Location map
+
|-
| Coloado
+
! scope="col" | Decimal degrees
| relief = 1
+
! scope="col" | Degrees, minutes, seconds
| width = 320
+
! scope="col" | With {{tl|Coord}}<small><br>(usually for infoboxes)</small>
| lat = 44.6
+
! scope="col" | [[Wikidata]]
| long = -110.5
+
|-
| caption = Location of Yellowstone in the northwestern United States
+
|style="vertical-align:top;"|
 +
<pre>
 +
{{Location map|{{{1}}}
 +
|width      =
 +
|float      =
 +
|border    =
 +
|caption    =
 +
|alt        =
 +
|relief     =
 +
|AlternativeMap=
 +
|overlay_image =
 +
|label      =
 +
|label_size =
 +
|position  =
 +
|background =
 +
|mark      =
 +
|marksize  =
 +
|link      =  
 +
|lat_deg    =
 +
|lon_deg    =
 +
}}
 +
</pre>
 +
|style="vertical-align:top;"|
 +
<pre>
 +
{{Location map|{{{1}}}
 +
|width     =  
 +
|float      =  
 +
|border    =  
 +
|caption   =
 +
|alt        =
 +
|relief    =
 +
|AlternativeMap=
 +
|overlay_image =
 +
|label      =
 +
|label_size =
 +
|position  =
 +
|background =
 +
|mark      =
 +
|marksize  =
 +
|link      =
 +
|lat_deg    =
 +
|lat_min    =
 +
|lat_sec    =
 +
|lat_dir    =
 +
|lon_deg    =
 +
|lon_min    =
 +
|lon_sec    =
 +
|lon_dir    =  
 
}}
 
}}
 
+
</pre>
{|
+
|style="vertical-align:top;"|
! Decimal degrees
+
<pre>
!
+
{{Location map|{{{1}}}
! Degrees, minutes, seconds
+
|width      =  
|-
+
|float      =  
| style="vertical-align:top;" |
+
|border    =  
<pre style="overflow: auto; margin-right: 5px;">
+
|caption    =  
{{Location map
+
|alt        =  
| {{{1}}}
+
|relief    =  
| width      =  
+
|AlternativeMap=  
| float      =  
+
|overlay_image =  
| border    =  
+
|label      =  
| caption    =  
+
|label_size =  
| alt        =  
+
|position  =  
| relief    =  
+
|background =  
| AlternativeMap =  
+
|mark      =  
| overlay_image =  
+
|marksize  =  
| label      =  
+
|coordinates=  
| label_size =  
 
| position  =  
 
| background =  
 
| mark      =  
 
| marksize  =  
 
| link      =
 
| lat_deg    =
 
| lon_deg    =  
 
 
}}
 
}}
 
</pre>
 
</pre>
| width="20px" |
+
|style="vertical-align:top;"|
| style="vertical-align:top;" |
+
<pre>
<pre style="overflow: auto; margin-right: 5px;">
+
{{Location map|{{{1}}}
{{Location map
+
|width      =  
| {{{1}}}
+
|float      =  
| width      =  
+
|border    =  
| float      =  
+
|caption    =  
| border    =  
+
|alt        =  
| caption    =  
+
|relief    =  
| alt        =  
+
|AlternativeMap=  
| relief    =  
+
|overlay_image =  
| AlternativeMap =  
+
|label      =  
| overlay_image =  
+
|label_size =  
| label      =  
+
|position  =  
| label_size =  
+
|background =  
| position  =  
+
|mark      =  
| background =  
+
|marksize  =  
| mark      =  
 
| marksize  =
 
| link      =
 
| lat_deg    =
 
| lat_min    =
 
| lat_sec    =
 
| lat_dir    =
 
| lon_deg    =
 
| lon_min    =
 
| lon_sec    =
 
| lon_dir    =  
 
 
}}
 
}}
 
</pre>
 
</pre>
 
|}
 
|}
  
== Parameters ==
+
==Parameters==
{| class="wikitable" style="width:100%;"
+
{|class="wikitable" style="width:100%"
! colspan="2" style="background-color:lightblue" | Map display parameters
+
|+ style=background-color:lightblue| Parameters
 
|-
 
|-
! Parameter
+
! scope="col" | Parameter kind
! Description
+
! scope="col" | Parameter
 +
! scope="col" | Description
 
|-
 
|-
| <code>{{{1}}}</code>
+
| rowspan="11" | Map display
| '''Required'''. Use the name of the map as the first unnamed parameter. For example, specifying ''England'' will use the values for England in [[Module:Location map/data/England]] if it exists, or {{tl|Location map England}} otherwise. See the [[#Examples|examples]] below.
+
|{{code|{{{1}}}}}
 +
|'''Required''' – use the name of the map as the first unnamed parameter; for example, specifying {{code|England}} will use the values for England in [[Module:Location map/data/England]] if it exists, or {{tld|Location map England}} if it does not. See the [[#Examples|examples]] below. Multiple maps can be shown by providing a list of map names separated by {{kbd|#}}. For multiple maps, the first is shown by default. A reader can select the others with radio buttons.
 
|-
 
|-
| <code>width</code>
+
|{{code|width}}
| Determines the width of the map in [[pixel]]s, overriding any default values. Do not include <code>px</code>, for example: <code>width=300</code>, not <code>width=300px</code>.
+
|Determines the width of the map in [[pixel]]s, overriding any default values; do not include {{kbd|px}}. For example, use {{para|width|300}}, not {{para|width|300px}}.
 
|-
 
|-
| <code>default_width</code>
+
|{{code|default_width}}
| Determines the default width of the map in pixels, intended for use by templates e.g. place infoboxes. The default value is 240. Do not include <code>px</code>. This value will be multiplied by the <code>defaultscale</code> parameter specified in individual map templates, if it exists, in order to achieve an appropriate size for vertical maps. For example if <code>default_width=200</code> is given, a map of Thailand will be displayed with a width of 200 * 0.57 = 114 pixels (as specified in [[Template:Location map Thailand]]).
+
|Determines the default width of the map in pixels, intended for use by templates, e.g. place infoboxes; the default value is 240. Do not include {{kbd|px}}. This value will be multiplied by the {{code|defaultscale}} parameter specified in individual map templates, if it exists, in order to achieve an appropriate size for vertical maps. For example, if {{para|default_width|200}} is given, a map of Thailand will be displayed with a width of 200×0.57=114 pixels (as specified in [[Module:Location map/data/Thailand]]).
 
|-
 
|-
| <code>float</code>
+
|{{code|max_width}}
| Specifies the position of the map on the page. Valid values are <code>left</code>, <code>right</code>, <code>center</code> and <code>none</code>. The default is <code>right</code>''.
+
|The maximum size of the map in pixels. Intended for use by templates, e.g. place infoboxes. Do not include {{kbd|px}}.
 
|-
 
|-
| <code>border</code>
+
|{{code|float}}
| Specifies the color of the 1px map border. The default is ''lightgrey'' (see [[web colors]]). If set to <code>none</code>, no border will be generated. This parameter is seldom used.
+
|Specifies the position of the map on the page; valid values are {{code|left}}, {{code|right}}, {{code|center}} and {{code|none}}. The default is {{code|right}}.
 
|-
 
|-
| <code>caption</code>
+
|{{code|border}}
| The text of a caption to be displayed below the map. Specifying a caption will cause the map to be displayed with a frame. If <code>caption</code> is defined but is not assigned a value, the map will not be framed and no caption will be displayed. If <code>caption</code> is not defined, the map will not be framed and a default caption will be generated. The default caption is created from the <code>label</code> parameter (or the current page name if label not defined) and the <code>name</code> parameter from map definition template. See the [[#Examples|examples]] below.
+
|Specifies the colour of the 1px map border; the default is {{code|lightgrey}} (see [[web colors]]). If set to {{code|none}}, no border will be generated. This parameter is seldom used.
 
|-
 
|-
| <code>alt</code>
+
|{{code|caption}}
| Alt text for map; used by [[screen reader]]s, see [[WP:ALT]].
+
|The text of a caption to be displayed below the map; specifying a caption will cause the map to be displayed with a frame. If {{para|caption}} is defined but not assigned a value, the map will not be framed and no caption will be displayed. If {{para|caption}} is not defined, the map will not be framed and a default caption will be generated. The default caption is created from the {{para|label}} parameter (or the current page name if {{para|label}} not defined) and the {{para|name}} parameter from the map definition template. Multiple captions can be shown when separated by {{kbd|##}} (that's two).
 
|-
 
|-
| <code>relief</code>
+
|{{code|alt}}
| Any non-blank value (1, yes, etc.) will cause the template to display the map specified in the map definition template as <code>image1</code>, which is usually a [[Cartographic relief depiction|relief map]]. See the example at [[Template:Location map+/relief|Location map+/relief]].
+
|Alt text for map; used by [[screen reader]]s. See [[WP:ALT]].
 
|-
 
|-
| <code>AlternativeMap</code>
+
|{{code|relief}}
| Allows the use of an alternative map. The image must have the same edge coordinates as the location map template. See the example at [[Template:Location map+/AlternativeMap|Location map+/AlternativeMap]].
+
|Any non-blank value ({{code|1}}, {{code|yes}}, etc.) will cause the template to display the map specified in the map definition template as {{code|image1}}, which is usually a [[Cartographic relief depiction|relief map]]; see the example at [[Template:Location map+/relief|Location map+/relief]].
 
|-
 
|-
| <code>overlay_image</code>
+
|{{code|AlternativeMap}}
| Allows an overlay to be superimposed on the map. This parameter is seldom used. See the example at [[Template:Location map+/overlay|Location map+/overlay]].
+
|Allows the use of an alternative map; the image must have the same edge coordinates as the location map template. See the example at [[Template:Location map+/AlternativeMap|Location map+/AlternativeMap]].
 
|-
 
|-
! colspan="2" style="background-color:lightblue" | Label and mark parameters
+
|{{code|overlay_image}}
 +
|Allows an overlay to be superimposed on the map; this parameter is seldom used. See the example at [[Template:Location map+/overlay|Location map+/overlay]].
 
|-
 
|-
! Parameter
+
| rowspan="17" | Label and mark parameters<ref group="note">If no coordinates are specified, the template will try to get them from the page's [[Wikidata]] item.</ref>
! Description
+
|{{code|label}}
 +
|The text of the label to display next to the identifying mark; a [[H:WIKILINK|wikilink]] can be used. You can enclose the label inside of {{tl|nowrap}} if you want to make sure that it stays on a single line. The default (if not specified) is no label, just the marker.
 
|-
 
|-
| <code>label</code>
+
|{{code|label_size}}
| The text of the label to display next to the mark. A [[Wiki markup|wiki link]] can be used. The default if not specified is no label, just the marker.
+
|The font size to use for the label, given as a percentage of the normal font size (<100=smaller, >100=larger); the default size is 90. Do not include {{kbd|%}}. For example, use {{para|label_size|80}}, not {{para|label_size|80%}}. If set to {{code|0}}, the label is only displayed when the user hovers over the mark.
 
|-
 
|-
| <code>label_size</code>
+
|{{code|label_width}}
| The font size to use for the label, given as a percentage of the normal font size (<100 = smaller, >100 = larger). The default is 90. Do not include <code>%</code>, for example: <code>label_size=80</code>, not <code>label_size=80%</code>.
+
|The width to use for the label, given as an [[Em (typography)#CSS|em size]]; the default width is 6. Do not include {{kbd|em}}. For example, use {{para|label_width|7}}, not {{para|label_width|7em}}.
 
|-
 
|-
| <code>label_width</code>
+
|{{code|position}}
| The width to use for the label, given as an [[Em (typography)#CSS|em size]]. The default is 6. Do not include <code>em</code>, for example: <code>label_width=7</code>, not <code>label_width=7em</code>.
+
|The position of the label relative to the identifying mark; valid values are {{code|left}}, {{code|right}}, {{code|top}},{{code|bottom}} and {{code|none}}. This defaults to either {{code|left}} or {{code|right}}, depending on the coordinates of the marker and its position relative to the right border of the map image. When {{para|position|none}}, any defined label will not be displayed with the mark, but it will be used to create the default caption.
 
|-
 
|-
| <code>position</code>
+
|{{code|background}}
| The position of the label relative to the mark. Valid values are <code>left</code>, <code>right</code>, <code>top</code> and <code>bottom</code>. This defaults to either <code>left</code> or <code>right</code>, depending on the coordinates of the marker and its position relative to the right border of the map image.
+
|The background colour to use for the label; see [[Web colors]]. The default is no background colour, which shows the map image behind the label.
 
|-
 
|-
| <code>background</code>
+
|{{code|mark}}
| The background color to use for the label. See [[Web colors]]. The default is no background color, which shows the map image behind the label.
+
|The name of an image file to display as the identifying mark; the default is [[:File:Red pog.svg|Red pog.svg]] ([[File:Red pog.svg|8px]]). See examples at [[Commons:Location markers]] and [[Commons:Category:Map icons]].
 
|-
 
|-
| <code>mark</code>
+
|{{code|marksize}}
| The name of an image to display as the mark. The default is [[:File:Red pog.svg|Red pog.svg]] ([[File:Red pog.svg|8px]]). See examples at [[Commons:Location markers]] and [[Commons:Category:Map icons]].
+
|The size of the identifying mark in pixels; the default is 8. Do not include {{kbd|px}}. For example, use {{para|marksize|10}}, not {{para|marksize|10px}}.
 
|-
 
|-
| <code>marksize</code>
+
|{{code|link}}
| The size of the mark in [[pixel]]s. The default is 8. Do not include <code>px</code>, for example: <code>marksize=10</code>, not <code>marksize=10px</code>.
+
|Specifies a [[H:WIKILINK|wikilink]] which can be followed if the reader clicks on the identifying mark; do not include {{kbd|[[]]}} (double square brackets). For example, use {{para|link|Yellowstone National Park}}, not {{para|link|[{{Zwsp}}[Yellowstone National Park]]}}.
 
|-
 
|-
| <code>link</code>
+
|{{code|coordinates}}
| Specifies a [[Wiki markup|wiki link]] which will be followed if the reader clicks on the mark. The name of the linked article is displayed when the mouse pointer hovers over the mark.
+
|The coordinates in {{tl|Coord}} format.<br><small>Whilst {{em|not}} recommended, coordinates can also be entered in decimal degrees (e.g. {{code|48.067°N 12.863°E}}); you shouldn't need to do this, though.</small>
 
|-
 
|-
| <code>lat_deg</code>
+
|{{code|lat_deg}}
| '''Required'''. The degrees of [[latitude]]. This value can be specified using [[decimal degrees]] and when this format is used minutes and seconds should not be specified.
+
|The degrees of [[latitude]]; this value can be specified using [[decimal degrees]], and when this format is used, minutes and seconds should not be specified.
 
|-
 
|-
| <code>lat_min</code>
+
|{{code|lat_min}}
| The minutes of latitude.
+
|The minutes of latitude.
 
|-
 
|-
| <code>lat_sec</code>
+
|{{code|lat_sec}}
| The seconds of latitude. Usually not necessary.
+
|The seconds of latitude; not usually necessary.
 
|-
 
|-
| <code>lat_dir</code>
+
|{{code|lat_dir}}
| N if north (default value) or S for south of the [[Equator]]. Other values will be disregarded. Not required if using signed decimal degrees (i.e. negative numbers for southern latitude).
+
|{{code|N}} for north (default value), or {{code|S}} for south of the [[Equator]]; other values will be disregarded. Not required if using signed decimal degrees, i.e. negative numbers for southern latitude.
 
|-
 
|-
| <code>lon_deg</code>
+
|{{code|lon_deg}}
| '''Required'''. The degrees of [[longitude]]. This value can be specified using [[decimal degrees]] and when this format is used minutes and seconds should not be specified.
+
|The degrees of [[longitude]]; this value can be specified using [[decimal degrees]], and when this format is used, minutes and seconds should not be specified.
 
|-
 
|-
| <code>lon_min</code>
+
|{{code|lon_min}}
| The minutes of longitude.
+
|The minutes of longitude.
 
|-
 
|-
| <code>lon_sec</code>
+
|{{code|lon_sec}}
| The seconds of longitude. Usually not necessary.
+
|The seconds of longitude; not usually necessary.
 
|-
 
|-
| <code>lon_dir</code>
+
|{{code|lon_dir}}
| E for east (default value) or W for west of the [[Prime Meridian]]. Other values will be disregarded. Not required if using signed decimal degrees (i.e. negative numbers for western longitude).
+
|{{code|E}} for east (default value), or {{code|W}} for west of the [[IERS Reference Meridian|Prime Meridian]]; other values will be disregarded. Not required if using signed decimal degrees, i.e. negative numbers for western longitude.
 
|}
 
|}
  
== Available maps ==
+
<references group="note"/>
[[File:template_location_map.svg|thumb|360px|Location map templates as of 5 Nov 2014. To find the best location map template covering a given place, open the SVG file in a Web browser and use arrow keys and zoom function. Hovering over a region shows its name and highlights it. Clicking it loads its page.]]
 
There are over 1000 maps available. To find other maps:
 
  
* [[Special:PrefixIndex/Module:Location map/data/]] - Checked before a map template is searched for. New maps should be created here rather than creating new templates.
+
==Available maps==
* [[Template:Location map/List]] - some of the items listed here are redirects and a few templates may not function as expected
+
[[File:template location map.svg|thumb|360px|Location map templates as of 5 Nov 2014. To find the best location map template covering a given place, open the SVG file in a web browser and use arrow keys and zoom function. Hovering over a region shows its name and highlights it. Clicking it loads its page.]]
* [[:Category:Location map templates]] - templates sorted by category
+
There are over 1,000 maps available. To find other maps:
* [[Special:WhatLinksHere/Template:Location map/Info]] - a search that might help
+
*[[Special:PrefixIndex/Module:Location map/data/]] – checked before a map template is searched for; new maps should be created here rather than creating new templates
* [[Special:Prefixindex/Template:Location map]] - another search that might help
+
*[[Template:Location map/List]] some of the items listed here are redirects, and a few templates may not function as expected
 
+
*[[:Category:Location map templates]] templates sorted by category
== Creating new map definitions ==
+
*[[Special:WhatLinksHere/Template:Location map/Info]] a search that might help
 +
*[[Special:Prefixindex/Template:Location map]] another search that might help
  
 +
==Creating new map definitions==
 
See [[Template:Location map/Creating a new map definition|Creating a new map definition]].
 
See [[Template:Location map/Creating a new map definition|Creating a new map definition]].
  
== Examples ==
+
==Examples==
 +
===Default width and float, no label, default caption (decimal coordinates)===
 +
Note: when a label is not specified, the default caption is "Page name (Map name)", so if this example was viewed on a page named <u>Pag</u>, the default caption would be "Pag (Croatia)". Likewise, on a page named <u>Pag (town)</u>, the default caption would be "Pag (town) (Croatia)".
 +
{{Location map|Croatia
 +
|alt    = Pag is on an island.
 +
|lat_deg = 44.44
 +
|lon_deg = 15.05
 +
}}
 +
<pre style=width:40em>
 +
{{Location map|Croatia
 +
|alt    = Pag is on an island.
 +
|lat_deg = 44.44
 +
|lon_deg = 15.05
 +
}}
 +
</pre>
 +
{{clear}}
  
=== Default width and float, no label, default caption (decimal coordinates) ===
+
===Map with the default caption (degrees/minutes)===
Note: When a label is not specified, the default caption is "Page name (Map name)", so if this example was viewed on a page named ''Pag'', the default caption would be "Pag (Croatia)". Likewise, on a page named ''Pag (town)'', the default caption would be "Pag (town) (Croatia)".
+
Note: when a label is specified, the default caption is "Label text (Map name)", seen as "Pag (Croatia)" in this example.
{{Location map | Croatia
+
{{Location map|Croatia
| alt     = Pag is on an island.
+
|width = 200
| lat_deg = 44.44
+
|float = right
| lon_deg = 15.05
+
|alt = Pag is on an island.
 +
|label = Pag
 +
|position = right
 +
|mark = Green pog.svg <!--green dot-->
 +
|lat_deg = 44 |lat_min = 26 <!-- default: lat_dir = N -->
 +
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
 
}}
 
}}
<pre style="width: 40em;">
+
<pre style=width:40em>
{{Location map | Croatia
+
{{Location map|Croatia
| alt     = Pag is on an island.
+
|width = 200
| lat_deg = 44.44
+
|float = right
| lon_deg = 15.05
+
|alt = Pag is on an island.
 +
|label = Pag
 +
|position = right
 +
|mark = Green pog.svg <!--green dot-->
 +
|lat_deg = 44 |lat_min = 26 <!-- default: lat_dir = N -->
 +
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
  
=== Map with the default caption (degrees/minutes) ===
+
When {{para|position|none}}, the label text is not displayed next to the mark, but is still used in the default caption and default alt text.
Note: When a label is specified, the default caption is "Label text (Map name)", seen as "Pag (Croatia)" in this example.
+
{{Location map|Croatia
{{Location map | Croatia
+
|width = 200
| width = 200
+
|float = right
| float = right
+
|label = Pag
| alt = Pag is on an island.
+
|position = none
| label = Pag
+
|mark = Green pog.svg <!--green dot-->
| position = right
+
|lat_deg = 44 |lat_min = 26 <!-- default: lat_dir = N -->
| mark = Green pog.svg <!--green dot-->
+
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
| lat_deg = 44 | lat_min = 26 <!-- default: lat_dir = N -->
 
| lon_deg = 15 | lon_min = 3  <!-- default: lon_dir = E -->
 
 
}}
 
}}
<pre style="width: 40em;">
+
<pre style=width:40em>
{{Location map | Croatia
+
{{Location map|Croatia
| width = 200
+
|width = 200
| float = right
+
|float = right
| alt = Pag is on an island.
+
|label = Pag
| label = Pag
+
|position = none
| position = right
+
|mark = Green pog.svg <!--green dot-->
| mark = Green pog.svg <!--green dot-->
+
|lat_deg = 44 |lat_min = 26 <!-- default: lat_dir = N -->
| lat_deg = 44 | lat_min = 26 <!-- default: lat_dir = N -->
+
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
| lon_deg = 15 | lon_min = 3  <!-- default: lon_dir = E -->
 
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
  
=== Mark outside of map border, no caption ===
+
===Mark outside of map border, no caption===
{{Location map | Croatia
+
{{Location map|Croatia
| width    = 200
+
|width    = 200
| float    = right
+
|float    = right
| caption  =
+
|caption  =
| alt      = Rimini in Italy (outside the map)
+
|alt      = Rimini in Italy (outside the map)
| lat_deg  = 44.05
+
|lat_deg  = 44.05
| lon_deg  = 12.57 <!--outside map's left border at 13.1-->
+
|lon_deg  = 12.57 <!--outside maps left border at 13.1-->
| outside  = 1 <!-- we're aware the point is outside the map, so suppress the warning category -->
+
|outside  = 1 <!--we're aware the point is outside the map, so suppress the warning category-->
| label    = Rimini
+
|label    = Rimini
| position = right
+
|position = right
 
}}
 
}}
<pre style="width: 60em;">
+
<pre style=width:60em>
{{Location map | Croatia
+
{{Location map|Croatia
| width    = 200
+
|width    = 200
| float    = right
+
|float    = right
| caption  =
+
|caption  =
| alt      = Rimini in Italy (outside the map)
+
|alt      = Rimini in Italy (outside the map)
| lat_deg  = 44.05
+
|lat_deg  = 44.05
| lon_deg  = 12.57 <!--outside map's left border at 13.1-->
+
|lon_deg  = 12.57 <!--outside maps left border at 13.1-->
| outside  = 1 <!-- we're aware the point is outside the map, so suppress the warning category -->
+
|outside  = 1 <!--we're aware the point is outside the map, so suppress the warning category-->
| label    = Rimini
+
|label    = Rimini
| position = right
+
|position = right
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
  
=== Caption, label_size, background, mark, marksize ===
+
===Caption, label_size, background, mark, marksize===
{{Location map | Italy
+
{{Location map|Italy
| width      = 200
+
|width      = 200
| float      = right
+
|float      = right
| caption    = Location of Rimini in Italy
+
|caption    = Location of Rimini in Italy
| alt        = Map of Italy with mark showing location of Rimini
+
|alt        = Map of Italy with mark showing location of Rimini
| label      = Rimini
+
|label      = Rimini
| label_size = 150 <!--150% of normal size-->
+
|label_size = 150 <!--150% of normal size-->
| position  = bottom
+
|position  = bottom
| background = orange
+
|background = orange
| mark      = Orange_pog.svg
+
|mark      = Orange_pog.svg
| marksize  = 12 <!--size in pixels-->
+
|marksize  = 12 <!--size in pixels-->
| lat_deg    = 44.05
+
|lat_deg    = 44.05
| lon_deg    = 12.57
+
|lon_deg    = 12.578
 
}}
 
}}
<pre style="width: 40em;">
+
<pre style=width:40em>
{{Location map | Italy
+
{{Location map|Italy
| width      = 200
+
|width      = 200
| float      = right
+
|float      = right
| caption    = Location of Rimini in Italy
+
|caption    = Location of Rimini in Italy
| alt        = Map of Italy with mark showing location of Rimini
+
|alt        = Map of Italy with mark showing location of Rimini
| label      = Rimini
+
|label      = Rimini
| label_size = 150 <!--150% of normal size-->
+
|label_size = 150 <!--150% of normal size-->
| position  = bottom
+
|position  = bottom
| background = orange
+
|background = orange
| mark      = Orange_pog.svg
+
|mark      = Orange_pog.svg
| marksize  = 12 <!--size in pixels-->
+
|marksize  = 12 <!--size in pixels-->
| lat_deg    = 44.05
+
|lat_deg    = 44.05
| lon_deg    = 12.57
+
|lon_deg    = 12.57
 
}}
 
}}
 
</pre>
 
</pre>
Line 296: Line 358:
  
 
{{anchor|Using Alternative Map}}<!--former section name for links from other pages-->
 
{{anchor|Using Alternative Map}}<!--former section name for links from other pages-->
=== AlternativeMap parameter ===
+
 
{{Location map | Italy
+
===AlternativeMap parameter===
| AlternativeMap = Italy location map.svg
+
{{Location map|Italy
| width  = 200
+
|AlternativeMap = Italy location map.svg
| float  = right
+
|width  = 200
| caption = Location of Rome in Italy
+
|float  = right
| alt    = Map of Italy with mark showing location of Rome
+
|caption = Location of Rome in Italy
| label  = Rome
+
|alt    = Map of Italy with mark showing location of Rome
| lat_deg = 41.9
+
|label  = Rome
| lon_deg = 12.5
+
|lat_deg = 41.9
 +
|lon_deg = 12.5
 
}}
 
}}
<pre style="width: 40em;">
+
<pre style=width:40em>
{{Location map | Italy
+
{{Location map|Italy
| AlternativeMap = Italy location map.svg
+
|AlternativeMap = Italy location map.svg
| width  = 200
+
|width  = 200
| float  = right
+
|float  = right
| caption = Location of Rome in Italy
+
|caption = Location of Rome in Italy
| alt    = Map of Italy with mark showing location of Rome
+
|alt    = Map of Italy with mark showing location of Rome
| label  = Rome
+
|label  = Rome
| lat_deg = 41.9
+
|lat_deg = 41.9
| lon_deg = 12.5
+
|lon_deg = 12.5
 
}}
 
}}
 
</pre>
 
</pre>
Line 322: Line 385:
  
 
{{anchor|Relief}}<!--former section name for links from other pages-->
 
{{anchor|Relief}}<!--former section name for links from other pages-->
=== Relief parameter ===
+
 
Also demonstrates automatic positioning of label to the left, due to far right position of mark.
+
===Relief parameter===
{{Location map | Nepal
+
Also demonstrates automatic positioning of label to the left due to the far right position of the mark.
| relief = yes
+
{{Location map|Nepal
| caption = Location of Biratnagar Airport in Nepal
+
|relief = yes
| alt = Biratnagar Airport is located in southeastern Nepal
+
|caption = Location of Biratnagar Airport in Nepal
| label = Biratnagar
+
|alt = Biratnagar Airport is located in southeastern Nepal.
| mark = Airplane silhouette.svg
+
|label = Biratnagar
| marksize = 10
+
|mark = Airplane silhouette.svg
| lat_deg = 26 | lat_min = 28 | lat_sec = 53 | lat_dir = N
+
|marksize = 10
| lon_deg = 87 | lon_min = 15 | lon_sec = 50 | lon_dir = E
+
|lat_deg = 26 |lat_min = 28 |lat_sec = 53 |lat_dir = N
 +
|lon_deg = 87 |lon_min = 15 |lon_sec = 50 |lon_dir = E
 
}}
 
}}
<pre style="width: 40em;">
+
<pre style=width:40em>
{{Location map | Nepal
+
{{Location map|Nepal
| relief = yes
+
|relief = yes
| caption = Location of Biratnagar Airport in Nepal
+
|caption = Location of Biratnagar Airport in Nepal
| alt = Biratnagar Airport is located in southeastern Nepal
+
|alt = Biratnagar Airport is located in southeastern Nepal.
| label = Biratnagar
+
|label = Biratnagar
| mark = Airplane silhouette.svg
+
|mark = Airplane silhouette.svg
| marksize = 10
+
|marksize = 10
| lat_deg = 26 | lat_min = 28 | lat_sec = 53 | lat_dir = N
+
|lat_deg = 26 |lat_min = 28 |lat_sec = 53 |lat_dir = N
| lon_deg = 87 | lon_min = 15 | lon_sec = 50 | lon_dir = E
+
|lon_deg = 87 |lon_min = 15 |lon_sec = 50 |lon_dir = E
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
  
{{Location map | Nepal
+
{{Location map|Nepal
| relief =  
+
|relief =  
| caption = Location of Biratnagar Airport in Nepal
+
|caption = Location of Biratnagar Airport in Nepal
| alt = Biratnagar Airport is located in southeastern Nepal
+
|alt = Biratnagar Airport is located in southeastern Nepal.
| label = Biratnagar
+
|label = Biratnagar
| mark = Airplane silhouette.svg
+
|mark = Airplane silhouette.svg
| marksize = 10
+
|marksize = 10
| lat_deg = 26 | lat_min = 28 | lat_sec = 53 | lat_dir = N
+
|lat_deg = 26 |lat_min = 28 |lat_sec = 53 |lat_dir = N
| lon_deg = 87 | lon_min = 15 | lon_sec = 50 | lon_dir = E
+
|lon_deg = 87 |lon_min = 15 |lon_sec = 50 |lon_dir = E
 
}}
 
}}
<pre style="width: 40em;">
+
<pre style=width:40em>
{{Location map | Nepal
+
{{Location map|Nepal
| relief =  
+
|relief =  
| caption = Location of Biratnagar Airport in Nepal
+
|caption = Location of Biratnagar Airport in Nepal
| alt = Biratnagar Airport is located in southeastern Nepal
+
|alt = Biratnagar Airport is located in southeastern Nepal.
| label = Biratnagar
+
|label = Biratnagar
| mark = Airplane silhouette.svg
+
|mark = Airplane silhouette.svg
| marksize = 10
+
|marksize = 10
| lat_deg = 26 | lat_min = 28 | lat_sec = 53 | lat_dir = N
+
|lat_deg = 26 |lat_min = 28 |lat_sec = 53 |lat_dir = N
| lon_deg = 87 | lon_min = 15 | lon_sec = 50 | lon_dir = E
+
|lon_deg = 87 |lon_min = 15 |lon_sec = 50 |lon_dir = E
 
}}
 
}}
 
</pre>
 
</pre>
Line 373: Line 437:
  
 
{{anchor|Alternative style of map}}<!--former section name for links from other pages-->
 
{{anchor|Alternative style of map}}<!--former section name for links from other pages-->
=== Same coordinates on different maps ===
+
 
{{Location map | UK Scotland
+
===User selection of multiple maps===
| relief = 1
+
{{Location map|UK Scotland#UK
| width = 180
+
|relief = 1
| float = right
+
|width = 180
| caption = Lockerbie in Scotland, UK
+
|float = right
| alt = Lockerbie is in southern Scotland.
+
|caption = Lockerbie in Scotland, UK
| label = Lockerbie
+
|alt = Lockerbie is in southern Scotland.
| mark = Blue_pog.svg
+
|label = Lockerbie
| marksize = 9
+
|mark = Blue_pog.svg
| lat_deg = 55 | lat_min = 07 | lat_sec = 16 | lat_dir = N
+
|marksize = 9
| lon_deg = 03 | lon_min = 21 | lon_sec = 19 | lon_dir = W
+
|lat_deg = 55 |lat_min = 07 |lat_sec = 16 |lat_dir = N
 +
|lon_deg = 03 |lon_min = 21 |lon_sec = 19 |lon_dir = W
 
}}
 
}}
<pre style="width: 40em;">
+
<pre style=width:40em>
{{Location map | UK Scotland
+
{{Location map|UK Scotland#UK
| relief = 1
+
|relief = 1
| width = 180
+
|width = 180
| float = right
+
|float = right
| caption = Lockerbie in Scotland, UK
+
|caption = Lockerbie in Scotland, UK
| alt = Lockerbie is in southern Scotland.
+
|alt = Lockerbie is in southern Scotland.
| label = Lockerbie
+
|label = Lockerbie
| mark = Blue_pog.svg
+
|mark = Blue_pog.svg
| marksize = 9
+
|marksize = 9
| lat_deg = 55 | lat_min = 07 | lat_sec = 16 | lat_dir = N
+
|lat_deg = 55 |lat_min = 07 |lat_sec = 16 |lat_dir = N
| lon_deg = 03 | lon_min = 21 | lon_sec = 19 | lon_dir = W
+
|lon_deg = 03 |lon_min = 21 |lon_sec = 19 |lon_dir = W
 
}}
 
}}
 
</pre>
 
</pre>
{{clear}}
 
  
{{Location map | United Kingdom
+
===Map that crosses 180° meridian===
| relief = 1
+
{{Category see also|Location map templates crossing the 180th meridian}}
| width = 180
+
 
| float = right
+
[[Module:Location map/data/Russia Chukotka Autonomous Okrug]] is an example of a map that crosses the [[180th meridian]]. To the west of 180° in the [[Eastern Hemisphere]] is [[Pevek]], at 170°17′E [[longitude]]. To the east of 180° in the [[Western Hemisphere]] is [[Uelen]], at 169°48′W longitude.
| caption = Lockerbie in Scotland, UK
+
 
| alt = Lockerbie is in southern Scotland.
+
{{Location map
| label = Lockerbie
+
| Russia Chukotka Autonomous Okrug
| mark = Blue_pog.svg
+
| float      = right
| marksize = 9
+
| width       = 250
| lat_deg = 55 | lat_min = 07 | lat_sec = 16 | lat_dir = N
+
| caption    = [[Chukotka Autonomous Okrug]]
| lon_deg = 03 | lon_min = 21 | lon_sec = 19 | lon_dir = W
+
| label      = Pevek
 +
| position    = bottom
 +
| background  = lightgreen
 +
| mark       = Locator_Dot.png
 +
| marksize   = 7
 +
| coordinates = {{coord|69|42|N|170|17|E}}
 
}}
 
}}
<pre style="width: 40em;">
+
<pre style="width: 30em">
{{Location map | United Kingdom
+
{{Location map
| relief = 1
+
| Russia Chukotka Autonomous Okrug
| width = 180
+
| float      = right
| float = right
+
| width       = 250
| caption = Lockerbie in Scotland, UK
+
| caption    = [[Chukotka Autonomous Okrug]]
| alt = Lockerbie is in southern Scotland.
+
| label      = Pevek
| label = Lockerbie
+
| position    = bottom
| mark = Blue_pog.svg
+
| background  = lightgreen
| marksize = 9
+
| mark       = Locator_Dot.png
| lat_deg = 55 | lat_min = 07 | lat_sec = 16 | lat_dir = N
+
| marksize   = 7
| lon_deg = 03 | lon_min = 21 | lon_sec = 19 | lon_dir = W
+
| coordinates = {{coord|69|42|N|170|17|E}}
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
  
=== Map that crosses 180° meridian ===
+
{{Location map
:See [[:Category:Location map templates crossing 180th meridian]]
+
| Russia Chukotka Autonomous Okrug
{{Location map | Fiji
+
| float      = right
| width     = 180
+
| width       = 250
| float      = right
+
| caption    = [[Chukotka Autonomous Okrug]]
| label     = Suva
+
| label       = Uelen
| position   = right
+
| position   = bottom
| background = yellow
+
| background = lightgreen
| mark       = Locator_Dot.png
+
| mark       = Locator_Dot.png
| marksize   = 7
+
| marksize   = 7
| lat_deg = 18 | lat_min =  8 | lat_sec = 0 | lat_dir = S
+
| coordinates = {{coord|66|09|N|169|48|W}}
| lon_deg = 178 | lon_min = 26 | lon_sec = 0 | lon_dir = E
 
 
}}
 
}}
<pre style="width: 40em;">
+
<pre style="width: 30em">
{{Location map | Fiji
+
{{Location map
| width     = 180
+
| Russia Chukotka Autonomous Okrug
| float      = right
+
| float      = right
| label     = Suva
+
| width       = 250
| position   = right
+
| caption    = [[Chukotka Autonomous Okrug]]
| background = yellow
+
| label       = Uelen
| mark       = Locator_Dot.png
+
| position   = bottom
| marksize   = 7
+
| background = lightgreen
| lat_deg = 18 | lat_min =  8 | lat_sec = 0 | lat_dir = S
+
| mark       = Locator_Dot.png
| lon_deg = 178 | lon_min = 26 | lon_sec = 0 | lon_dir = E
+
| marksize   = 7
 +
| coordinates = {{coord|66|09|N|169|48|W}}
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
== Template data ==
+
 
{{TemplateDataHeader}}
+
==Template data==
 +
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
 +
{{TemplateData header|noheader=1}}
 
<templatedata>
 
<templatedata>
 
{
 
{
Line 464: Line 535:
 
"params": {
 
"params": {
 
"1": {
 
"1": {
"label": "Map name",
+
"label": "Map name(s)",
 
"type": "string",
 
"type": "string",
 
"required": true,
 
"required": true,
"description": "The name of the map to be used"
+
"description": "The name of the map to be used; multiple maps can be provided as a list separated by \"#\"."
 
},
 
},
 
"width": {
 
"width": {
 
"label": "Map width",
 
"label": "Map width",
 
"type": "number",
 
"type": "number",
"description": "Determines the width of the map in pixels, overriding any default values. Do not include \"px\", for example: \"300\", not \"300px\"."
+
"description": "Determines the width of the map in pixels, overriding any default values; do not include \"px\". For example, use \"width=300\", not \"width=300px\"."
 
},
 
},
 
"default_width": {
 
"default_width": {
 
"label": "Default width",
 
"label": "Default width",
 
"type": "number",
 
"type": "number",
"description": "Determines the default width of the map in pixels, intended for use by templates such as infoboxes. The default value is 240. Do not include \"px\". This value will be multiplied by the defaultscale parameter specified in individual map templates, if it exists, in order to achieve an appropriate size for vertical maps."
+
"description": "Determines the default width of the map in pixels, intended for use by templates, e.g. place infoboxes; the default value is 240. Do not include \"px\". This value will be multiplied by the 'defaultscale' parameter specified in individual map templates, if it exists, in order to achieve an appropriate size for vertical maps."
 
},
 
},
 
"float": {
 
"float": {
 
"label": "Position",
 
"label": "Position",
 
"type": "string",
 
"type": "string",
"description": "Specifies the position of the map on the page. Valid values are left, right, center and none. The default is right."
+
"description": "Specifies the position of the map on the page; valid values are \"left\", \"right\", \"center\" and \"none\". The default is \"right\"."
 
},
 
},
 
"border": {
 
"border": {
 
"label": "Border color",
 
"label": "Border color",
 
"type": "string",
 
"type": "string",
"description": "Specifies the color of the map border. If set to none, no border will be generated. "
+
"description": "Specifies the colour of the map border; if set to \"none\", no border will be generated."
 
},
 
},
 
"caption": {
 
"caption": {
 
"label": "Map caption",
 
"label": "Map caption",
 
"type": "string",
 
"type": "string",
"description": "The text of a caption to be displayed below the map.  If caption is defined but is not assigned a value, the map will not be framed and no caption will be displayed. If caption is not defined, the map will not be framed and a default caption will be generated."
+
"description": "The text of a caption to be displayed below the map; if caption is defined but is not assigned a value, the map will not be framed and no caption will be displayed. If caption is not defined, the map will not be framed and a default caption will be generated."
 
},
 
},
 
"alt": {
 
"alt": {
Line 502: Line 573:
 
"label": "Alternative map from template",
 
"label": "Alternative map from template",
 
"type": "string",
 
"type": "string",
"description": "Any non-blank value (1, yes, etc.) will cause the template to display the map specified in the map definition template as image1, which is usually a relief map."
+
"description": "Any non-blank value (\"1\", \"yes\", etc.) will cause the template to display the map specified in the map definition template as \"image1\", which is usually a relief map."
 
},
 
},
 
"AlternativeMap": {
 
"AlternativeMap": {
 
"label": "Alternative map not from template",
 
"label": "Alternative map not from template",
 
"type": "string",
 
"type": "string",
"description": "Allows the use of an alternative map. The image must have the same edge coordinates as the map template."
+
"description": "Allows the use of an alternative map; the image must have the same edge coordinates as the location map template."
 
},
 
},
 
"overlay_image": {
 
"overlay_image": {
 
"label": "Overlay image",
 
"label": "Overlay image",
 
"type": "string",
 
"type": "string",
"description": "Allows an overlay to be superimposed on the map. This parameter is seldom used."
+
"description": "Allows an overlay to be superimposed on the map; this parameter is seldom used."
 
},
 
},
 
"label": {
 
"label": {
 
"label": "Marker label",
 
"label": "Marker label",
 
"type": "string",
 
"type": "string",
"description": "The text of the label to display next to the mark. A wiki link can be used."
+
"description": "The text of the label to display next to the identifying mark; a wikilink can be used."
 
},
 
},
 
"label_size": {
 
"label_size": {
 
"label": "Label size",
 
"label": "Label size",
 
"type": "number",
 
"type": "number",
"description": "The font size to use for the label, given as a percentage of the normal font size. Do not include \"%\"."
+
"description": "The font size to use for the label, given as a percentage of the normal font size; do not include \"%\"."
 
},
 
},
 
"label_width": {
 
"label_width": {
 
"label": "Label width",
 
"label": "Label width",
 
"type": "number",
 
"type": "number",
"description": "The width to use for the label, given as an em size. Do not include \"em\"."
+
"description": "The width to use for the label, given as an em size; do not include \"em\"."
 
},
 
},
 
"position": {
 
"position": {
 
"label": "Label position",
 
"label": "Label position",
 
"type": "string",
 
"type": "string",
"description": "The position of the label relative to the mark. Valid values are left, right, top and bottom. This defaults to either left or right, depending on the coordinates of the marker and its position relative to the right border of the map image."
+
"description": "The position of the label relative to the identifying mark; valid values are \"left\", \"right\", \"top\", \"bottom\" and \"none\". This defaults to either \"left\" or \"right\", depending on the coordinates of the marker and its position relative to the right border of the map image. When \"position=none\", any defined label will not be displayed with the mark, but it will be used to create the default caption."
 
},
 
},
 
"background": {
 
"background": {
 
"label": "Label background",
 
"label": "Label background",
 
"type": "string",
 
"type": "string",
"description": "The background color to use for the label."
+
"description": "The background colour to use for the label."
 
},
 
},
 
"mark": {
 
"mark": {
 
"label": "Marker image",
 
"label": "Marker image",
 
"type": "string",
 
"type": "string",
"description": "The name of an image to display as the marker."
+
"description": "The name of an image file to display as the identifying mark."
 
},
 
},
 
"marksize": {
 
"marksize": {
 
"label": "Marker size",
 
"label": "Marker size",
 
"type": "number",
 
"type": "number",
"description": "The size of the mark in pixels. Do not include \"px\"."
+
"description": "The size of the identifying mark in pixels; do not include \"px\"."
 
},
 
},
 
"link": {
 
"link": {
 
"label": "Marker link",
 
"label": "Marker link",
 
"type": "string",
 
"type": "string",
"description": "Specifies a wiki link which will be followed if the reader clicks on the mark."
+
"description": "Specifies a wikilink which can be followed if the reader clicks on the identifying mark."
 
},
 
},
 
"lat_deg": {
 
"lat_deg": {
Line 558: Line 629:
 
"type": "number",
 
"type": "number",
 
"required": true,
 
"required": true,
"description": "The degrees of latitude. This value can be specified using decimal degrees. When this format is used minutes and seconds should not be specified."
+
"description": "The degrees of latitude; this value can be specified using decimal degrees, and when this format is used, minutes and seconds should not be specified."
 
},
 
},
 
"lat_min": {
 
"lat_min": {
Line 573: Line 644:
 
"label": "Latitude direction",
 
"label": "Latitude direction",
 
"type": "string",
 
"type": "string",
"description": "N if north or S for south of the Equator. Not required if using signed decimal degrees."
+
"description": "\"N\" for north or \"S\" for south of the Equator; not required if using signed decimal degrees."
 
},
 
},
 
"lon_deg": {
 
"lon_deg": {
Line 579: Line 650:
 
"type": "number",
 
"type": "number",
 
"required": true,
 
"required": true,
"description": " The degrees of longitude. This value can be specified using decimal degrees. When this format is used minutes and seconds should not be specified."
+
"description": "The degrees of longitude; this value can be specified using decimal degrees, and when this format is used, minutes and seconds should not be specified."
 
},
 
},
 
"lon_min": {
 
"lon_min": {
Line 594: Line 665:
 
"label": "Longitude direction",
 
"label": "Longitude direction",
 
"type": "string",
 
"type": "string",
"description": "E for east or W for west of the Prime Meridian. Not required if using signed decimal degrees."
+
"description": "\"E\" for east or \"W\" for west of the Prime Meridian; not required if using signed decimal degrees."
 +
},
 +
"coordinates": {
 +
"label": "Coordinates",
 +
"description": "Coordinates, usually in {{Coord}} format; however, they can also be typed out in decimal degrees (with no spaces between \"°\" and \"N\"/\"S\"/\"E\"/\"W\").",
 +
"example": "{{Coord|48.067|12.863}}",
 +
"type": "string"
 
}
 
}
}
+
},
 +
"paramOrder": [
 +
"1",
 +
"width",
 +
"default_width",
 +
"float",
 +
"border",
 +
"caption",
 +
"alt",
 +
"relief",
 +
"AlternativeMap",
 +
"overlay_image",
 +
"label",
 +
"label_size",
 +
"label_width",
 +
"position",
 +
"background",
 +
"mark",
 +
"marksize",
 +
"link",
 +
"coordinates",
 +
"lat_deg",
 +
"lat_min",
 +
"lat_sec",
 +
"lat_dir",
 +
"lon_deg",
 +
"lon_min",
 +
"lon_sec",
 +
"lon_dir"
 +
]
 
}
 
}
 
</templatedata>
 
</templatedata>
 +
{{Collapse bottom}}
 +
  
== See also ==
+
==See also==
 
{{Commons|Location markers}}
 
{{Commons|Location markers}}
 
{{Commons category|Map pointers}}
 
{{Commons category|Map pointers}}
 +
* [[Wikipedia:Maps for Wikipedia]], a list of mapping tools available on Wikipedia
 +
* [[Template:Location map/Info]]
  
;For similar examples, see the documentation at [[Template:Location map+]], as well as:
+
For similar examples, see the documentation at [[Template:Location map+]], as well as:
* [[Template:Location map+/relief]], an example using the ''relief'' parameter
+
*[[Template:Location map+/relief]], an example using the {{para|relief}} parameter
* [[Template:Location map+/AlternativeMap]], an example using the ''AlternativeMap'' parameter
+
*[[Template:Location map+/AlternativeMap]], an example using the {{para|AlternativeMap}} parameter
* [[Template:Location map+/overlay]], an example using the ''overlay_image'' parameter
+
*[[Template:Location map+/overlay]], an example using the {{para|overlay_image}} parameter
  
;Location map templates
+
Location map templates
* [[Template:Location map many]], to display up to 9 markers and labels
+
*[[Template:Location map many]], to display up to nine (9) markers and labels
* [[Template:Location map+]], to display unlimited number of markers and labels
+
*[[Template:Location map+]], to display unlimited number of markers and labels
  
;Other templates
+
Other templates
* [[Template:Annotated image]], allows text notes to overlap image, allows cropping
+
*[[Template:Annotated image]], allows text notes to overlap image, allows cropping
* [[Template:Overlay]] - places up to 30 marker images of various chooseable kinds over a base image with optional grid and legend
+
*[[Template:Overlay]], places up to thirty (30) marker images of various choose-able kinds over a base image with optional grid and legend
* [[Template:Superimpose]], supports simple layer superimposition.
+
*[[Template:Superimpose]], supports simple layer superimposition
* [[Template:Superimpose2]], to place up to 50 image layers over one another
+
*[[Template:Superimpose2]], to place up to fifty (50) image layers over one another
  
; Infoboxes incorporating Location map - any country or region
+
Infoboxes incorporating Location map any country or region
 
{{Location map/doc/See also infobox templates}}
 
{{Location map/doc/See also infobox templates}}
  
; Infoboxes incorporating Location map - specific countries or regions
+
Infoboxes incorporating Location map specific countries or regions
{{Collapsible list | framestyle = border 1px; | titlestyle = text-align:left;background-color:lightgrey; |
+
{{Collapsible list|framestyle=border 1px|titlestyle=text-align:left; background-color:lightgrey|
* [[Template:Infobox Belgium Municipality]]
+
*[[Template:Infobox Australian place]]
* [[Template:Infobox closed London station]] (UK)
+
*[[Template:Infobox Belgium Municipality]]
* [[Template:Infobox European Parliament constituency]]
+
*[[Template:Infobox European Parliament constituency]]
* [[Template:Infobox former Arab villages in Palestine]]
+
*[[Template:Infobox frazione]] (Italy)
* [[Template:Infobox frazione]] (Italy)
+
*[[Template:Infobox French commune]]
* [[Template:Infobox French commune]]
+
*[[Template:Infobox German location]]
* [[Template:Infobox German location]]
+
*[[Template:Infobox Greek Dimos]]
* [[Template:Infobox Greek Dimos]]
+
*[[Template:Infobox Israel municipality]]
* [[Template:Infobox Holiday Camp]] (UK)
+
*[[Template:Infobox Israel village]]
* [[Template:Infobox Hungarian settlement]]
+
*[[Template:Infobox Italian comune]]
* [[Template:Infobox Israel municipality]]
+
*[[Template:Infobox London station]]
* [[Template:Infobox Italian comune]]
+
*[[Template:Infobox NRHP]] (USA)
* [[Template:Infobox Kibbutz]] (Israel)
+
*[[Template:Infobox Pennsylvania historic site]] (USA)
* [[Template:Infobox London station]]
+
*[[Template:Infobox Site of Special Scientific Interest]] (UK)
* [[Template:Infobox Mandir]] (India)
+
*[[Template:Infobox Tibetan Buddhist monastery]]
* [[Template:Infobox motorway services]] (UK)
+
*[[Template:Infobox UK place]]
* [[Template:Infobox NRHP]] (USA)
+
*[[Template:Infobox UK postcode area]]
* [[Template:Infobox PAhistoric]] (USA)
+
*[[Template:Infobox Venezuelan municipality]]
* [[Template:Infobox Palestinian Authority municipality]] (via [[Template:Infobox settlement]])
 
* [[Template:Infobox Pre-Columbian site]]
 
* [[Template:Infobox protected area of Australia]]
 
* [[Template:Infobox Site of Special Scientific Interest]] (UK)
 
* [[Template:Infobox Tibetan Buddhist monastery]]
 
* [[Template:Infobox Town AT]] (Austria)
 
* [[Template:Infobox UK feature]]
 
* [[Template:Infobox UK place]]
 
* [[Template:Infobox UK postcode area]]
 
* [[Template:Infobox Venezuelan municipality]]
 
 
}}
 
}}
  
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
+
<includeonly>{{Sandbox other|
| <!--Categories below this line, please; interwikis at Wikidata-->
+
| <!-- Categories below this line, please; interwikis at Wikidata -->
 
[[Category:Location map templates| ]]
 
[[Category:Location map templates| ]]
[[Category:Graphic templates]]
+
[[Category:Map formatting and function templates]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 11:03, 27 February 2021

Location of Yellowstone in the north-western United States of America

The location map template generates a location map as a composite image, consisting of a map and a location mark. Optionally, a label and caption can be added.

Usage

Map image files are not accessed directly, but by using an auxiliary map definition. For example, if the first unnamed parameter supplied to this template is Japan, then this template uses the entry for Japan in Module:Location map/data/Japan if it exists, otherwise it uses {{Location map Japan}}, one of which contains the data needed to generate the composite image.

Please note

  • Assigning any value to the parameter |caption= causes the map to be displayed as a thumbnail image. If this parameter is not declared, the template will generate a default caption.
  • The coordinates are not checked. If the coordinates specified fall outside the area covered by the map image, the location mark will not display inside the image; however, it may be displayed somewhere else on the page.
  • Do not use px when setting the map image size. Using |width=200px will usually cause a very large map to be displayed. Use |width=200.
  • To create a map with more than one location mark, use either {{Location map+}} or {{Location map many}}.

Blank templates

Blank templates
Decimal degrees Degrees, minutes, seconds With {{Coord}}
(usually for infoboxes)
Wikidata
{{Location map|{{{1}}}
|width      = 
|float      = 
|border     = 
|caption    = 
|alt        = 
|relief     = 
|AlternativeMap= 
|overlay_image = 
|label      = 
|label_size = 
|position   = 
|background = 
|mark       = 
|marksize   = 
|link       = 
|lat_deg    = 
|lon_deg    = 
}}
{{Location map|{{{1}}}
|width      = 
|float      = 
|border     = 
|caption    = 
|alt        = 
|relief     = 
|AlternativeMap= 
|overlay_image = 
|label      = 
|label_size = 
|position   = 
|background = 
|mark       = 
|marksize   = 
|link       = 
|lat_deg    = 
|lat_min    = 
|lat_sec    = 
|lat_dir    = 
|lon_deg    = 
|lon_min    = 
|lon_sec    = 
|lon_dir    = 
}}
{{Location map|{{{1}}}
|width      = 
|float      = 
|border     = 
|caption    = 
|alt        = 
|relief     = 
|AlternativeMap= 
|overlay_image = 
|label      = 
|label_size = 
|position   = 
|background = 
|mark       = 
|marksize   = 
|coordinates= 
}}
{{Location map|{{{1}}}
|width      = 
|float      = 
|border     = 
|caption    = 
|alt        = 
|relief     = 
|AlternativeMap= 
|overlay_image = 
|label      = 
|label_size = 
|position   = 
|background = 
|mark       = 
|marksize   = 
}}

Parameters

Parameters
Parameter kind Parameter Description
Map display {{{1}}} Required – use the name of the map as the first unnamed parameter; for example, specifying England will use the values for England in Module:Location map/data/England if it exists, or {{Location map England}} if it does not. See the examples below. Multiple maps can be shown by providing a list of map names separated by #. For multiple maps, the first is shown by default. A reader can select the others with radio buttons.
width Determines the width of the map in pixels, overriding any default values; do not include px. For example, use |width=300, not |width=300px.
default_width Determines the default width of the map in pixels, intended for use by templates, e.g. place infoboxes; the default value is 240. Do not include px. This value will be multiplied by the defaultscale parameter specified in individual map templates, if it exists, in order to achieve an appropriate size for vertical maps. For example, if |default_width=200 is given, a map of Thailand will be displayed with a width of 200×0.57=114 pixels (as specified in Module:Location map/data/Thailand).
max_width The maximum size of the map in pixels. Intended for use by templates, e.g. place infoboxes. Do not include px.
float Specifies the position of the map on the page; valid values are left, right, center and none. The default is right.
border Specifies the colour of the 1px map border; the default is lightgrey (see web colors). If set to none, no border will be generated. This parameter is seldom used.
caption The text of a caption to be displayed below the map; specifying a caption will cause the map to be displayed with a frame. If |caption= is defined but not assigned a value, the map will not be framed and no caption will be displayed. If |caption= is not defined, the map will not be framed and a default caption will be generated. The default caption is created from the |label= parameter (or the current page name if |label= not defined) and the |name= parameter from the map definition template. Multiple captions can be shown when separated by ## (that's two).
alt Alt text for map; used by screen readers. See WP:ALT.
relief Any non-blank value (1, yes, etc.) will cause the template to display the map specified in the map definition template as image1, which is usually a relief map; see the example at Location map+/relief.
AlternativeMap Allows the use of an alternative map; the image must have the same edge coordinates as the location map template. See the example at Location map+/AlternativeMap.
overlay_image Allows an overlay to be superimposed on the map; this parameter is seldom used. See the example at Location map+/overlay.
Label and mark parameters[note 1] label The text of the label to display next to the identifying mark; a wikilink can be used. You can enclose the label inside of {{nowrap}} if you want to make sure that it stays on a single line. The default (if not specified) is no label, just the marker.
label_size The font size to use for the label, given as a percentage of the normal font size (<100=smaller, >100=larger); the default size is 90. Do not include %. For example, use |label_size=80, not |label_size=80%. If set to 0, the label is only displayed when the user hovers over the mark.
label_width The width to use for the label, given as an em size; the default width is 6. Do not include em. For example, use |label_width=7, not |label_width=7em.
position The position of the label relative to the identifying mark; valid values are left, right, top,bottom and none. This defaults to either left or right, depending on the coordinates of the marker and its position relative to the right border of the map image. When |position=none, any defined label will not be displayed with the mark, but it will be used to create the default caption.
background The background colour to use for the label; see Web colors. The default is no background colour, which shows the map image behind the label.
mark The name of an image file to display as the identifying mark; the default is Red pog.svg (8px). See examples at Commons:Location markers and Commons:Category:Map icons.
marksize The size of the identifying mark in pixels; the default is 8. Do not include px. For example, use |marksize=10, not |marksize=10px.
link Specifies a wikilink which can be followed if the reader clicks on the identifying mark; do not include [[]] (double square brackets). For example, use |link=Yellowstone National Park, not |link=[​[Yellowstone National Park]].
coordinates The coordinates in {{Coord}} format.
Whilst not recommended, coordinates can also be entered in decimal degrees (e.g. 48.067°N 12.863°E); you shouldn't need to do this, though.
lat_deg The degrees of latitude; this value can be specified using decimal degrees, and when this format is used, minutes and seconds should not be specified.
lat_min The minutes of latitude.
lat_sec The seconds of latitude; not usually necessary.
lat_dir N for north (default value), or S for south of the Equator; other values will be disregarded. Not required if using signed decimal degrees, i.e. negative numbers for southern latitude.
lon_deg The degrees of longitude; this value can be specified using decimal degrees, and when this format is used, minutes and seconds should not be specified.
lon_min The minutes of longitude.
lon_sec The seconds of longitude; not usually necessary.
lon_dir E for east (default value), or W for west of the Prime Meridian; other values will be disregarded. Not required if using signed decimal degrees, i.e. negative numbers for western longitude.
  1. If no coordinates are specified, the template will try to get them from the page's Wikidata item.

Available maps

File:Template location map.svg
Location map templates as of 5 Nov 2014. To find the best location map template covering a given place, open the SVG file in a web browser and use arrow keys and zoom function. Hovering over a region shows its name and highlights it. Clicking it loads its page.

There are over 1,000 maps available. To find other maps:

Creating new map definitions

See Creating a new map definition.

Examples

Default width and float, no label, default caption (decimal coordinates)

Note: when a label is not specified, the default caption is "Page name (Map name)", so if this example was viewed on a page named Pag, the default caption would be "Pag (Croatia)". Likewise, on a page named Pag (town), the default caption would be "Pag (town) (Croatia)".

Location map/doc (Croatia)
{{Location map|Croatia
|alt     = Pag is on an island.
|lat_deg = 44.44
|lon_deg = 15.05
}}

Map with the default caption (degrees/minutes)

Note: when a label is specified, the default caption is "Label text (Map name)", seen as "Pag (Croatia)" in this example.

Pag (Croatia)
{{Location map|Croatia
|width = 200
|float = right
|alt = Pag is on an island.
|label = Pag
|position = right
|mark = Green pog.svg <!--green dot-->
|lat_deg = 44 |lat_min = 26 <!-- default: lat_dir = N -->
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
}}

When |position=none, the label text is not displayed next to the mark, but is still used in the default caption and default alt text.

{{Location map|Croatia
|width = 200
|float = right
|label = Pag
|position = none
|mark = Green pog.svg <!--green dot-->
|lat_deg = 44 |lat_min = 26 <!-- default: lat_dir = N -->
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
}}

Mark outside of map border, no caption

{{Location map|Croatia
|width    = 200
|float    = right
|caption  =
|alt      = Rimini in Italy (outside the map)
|lat_deg  = 44.05
|lon_deg  = 12.57 <!--outside maps left border at 13.1-->
|outside  = 1 <!--we're aware the point is outside the map, so suppress the warning category-->
|label    = Rimini
|position = right
}}

Caption, label_size, background, mark, marksize

{{Location map|Italy
|width      = 200
|float      = right
|caption    = Location of Rimini in Italy
|alt        = Map of Italy with mark showing location of Rimini
|label      = Rimini
|label_size = 150 <!--150% of normal size-->
|position   = bottom
|background = orange
|mark       = Orange_pog.svg
|marksize   = 12 <!--size in pixels-->
|lat_deg    = 44.05
|lon_deg    = 12.57
}}

AlternativeMap parameter

{{Location map|Italy
|AlternativeMap = Italy location map.svg
|width   = 200
|float   = right
|caption = Location of Rome in Italy
|alt     = Map of Italy with mark showing location of Rome
|label   = Rome
|lat_deg = 41.9
|lon_deg = 12.5
}}

Relief parameter

Also demonstrates automatic positioning of label to the left due to the far right position of the mark.

Location of Biratnagar Airport in Nepal
{{Location map|Nepal
|relief = yes
|caption = Location of Biratnagar Airport in Nepal
|alt = Biratnagar Airport is located in southeastern Nepal.
|label = Biratnagar
|mark = Airplane silhouette.svg
|marksize = 10
|lat_deg = 26 |lat_min = 28 |lat_sec = 53 |lat_dir = N
|lon_deg = 87 |lon_min = 15 |lon_sec = 50 |lon_dir = E
}}
Location of Biratnagar Airport in Nepal
{{Location map|Nepal
|relief = 
|caption = Location of Biratnagar Airport in Nepal
|alt = Biratnagar Airport is located in southeastern Nepal.
|label = Biratnagar
|mark = Airplane silhouette.svg
|marksize = 10
|lat_deg = 26 |lat_min = 28 |lat_sec = 53 |lat_dir = N
|lon_deg = 87 |lon_min = 15 |lon_sec = 50 |lon_dir = E
}}

User selection of multiple maps

Lockerbie in Scotland, UK
Lockerbie (the United Kingdom)
{{Location map|UK Scotland#UK
|relief = 1
|width = 180
|float = right
|caption = Lockerbie in Scotland, UK
|alt = Lockerbie is in southern Scotland.
|label = Lockerbie
|mark = Blue_pog.svg
|marksize = 9
|lat_deg = 55 |lat_min = 07 |lat_sec = 16 |lat_dir = N
|lon_deg = 03 |lon_min = 21 |lon_sec = 19 |lon_dir = W
}}

Map that crosses 180° meridian

Module:Location map/data/Russia Chukotka Autonomous Okrug is an example of a map that crosses the 180th meridian. To the west of 180° in the Eastern Hemisphere is Pevek, at 170°17′E longitude. To the east of 180° in the Western Hemisphere is Uelen, at 169°48′W longitude.

Lua error in Module:Location_map at line 399: Malformed coordinates value.

{{Location map
| Russia Chukotka Autonomous Okrug
| float       = right
| width       = 250
| caption     = [[Chukotka Autonomous Okrug]]
| label       = Pevek
| position    = bottom
| background  = lightgreen
| mark        = Locator_Dot.png
| marksize    = 7
| coordinates = {{coord|69|42|N|170|17|E}}
}}

Lua error in Module:Location_map at line 399: Malformed coordinates value.

{{Location map
| Russia Chukotka Autonomous Okrug
| float       = right
| width       = 250
| caption     = [[Chukotka Autonomous Okrug]]
| label       = Uelen
| position    = bottom
| background  = lightgreen
| mark        = Locator_Dot.png
| marksize    = 7
| coordinates = {{coord|66|09|N|169|48|W}}
}}

Template data

TemplateData documentation used by VisualEditor and other tools
See the monthly parameter usage report for this template.

TemplateData for Location map

This template places a location mark on a map.

Template parameters

ParameterDescriptionTypeStatus
Map name(s)1

The name of the map to be used; multiple maps can be provided as a list separated by "#".

Stringrequired
Map widthwidth

Determines the width of the map in pixels, overriding any default values; do not include "px". For example, use "width=300", not "width=300px".

Numberoptional
Default widthdefault_width

Determines the default width of the map in pixels, intended for use by templates, e.g. place infoboxes; the default value is 240. Do not include "px". This value will be multiplied by the 'defaultscale' parameter specified in individual map templates, if it exists, in order to achieve an appropriate size for vertical maps.

Numberoptional
Positionfloat

Specifies the position of the map on the page; valid values are "left", "right", "center" and "none". The default is "right".

Stringoptional
Border colorborder

Specifies the colour of the map border; if set to "none", no border will be generated.

Stringoptional
Map captioncaption

The text of a caption to be displayed below the map; if caption is defined but is not assigned a value, the map will not be framed and no caption will be displayed. If caption is not defined, the map will not be framed and a default caption will be generated.

Stringoptional
Alt textalt

Alt text for map; used by screen readers.

Stringoptional
Alternative map from templaterelief

Any non-blank value ("1", "yes", etc.) will cause the template to display the map specified in the map definition template as "image1", which is usually a relief map.

Stringoptional
Alternative map not from templateAlternativeMap

Allows the use of an alternative map; the image must have the same edge coordinates as the location map template.

Stringoptional
Overlay imageoverlay_image

Allows an overlay to be superimposed on the map; this parameter is seldom used.

Stringoptional
Marker labellabel

The text of the label to display next to the identifying mark; a wikilink can be used.

Stringoptional
Label sizelabel_size

The font size to use for the label, given as a percentage of the normal font size; do not include "%".

Numberoptional
Label widthlabel_width

The width to use for the label, given as an em size; do not include "em".

Numberoptional
Label positionposition

The position of the label relative to the identifying mark; valid values are "left", "right", "top", "bottom" and "none". This defaults to either "left" or "right", depending on the coordinates of the marker and its position relative to the right border of the map image. When "position=none", any defined label will not be displayed with the mark, but it will be used to create the default caption.

Stringoptional
Label backgroundbackground

The background colour to use for the label.

Stringoptional
Marker imagemark

The name of an image file to display as the identifying mark.

Stringoptional
Marker sizemarksize

The size of the identifying mark in pixels; do not include "px".

Numberoptional
Marker linklink

Specifies a wikilink which can be followed if the reader clicks on the identifying mark.

Stringoptional
Coordinatescoordinates

Coordinates, usually in {{Coord}} format; however, they can also be typed out in decimal degrees (with no spaces between "°" and "N"/"S"/"E"/"W").

Example
{{Coord|48.067|12.863}}
Stringoptional
Latitude degreeslat_deg

The degrees of latitude; this value can be specified using decimal degrees, and when this format is used, minutes and seconds should not be specified.

Numberrequired
Latitude minuteslat_min

The minutes of latitude.

Numberoptional
Latitude secondslat_sec

The seconds of latitude.

Numberoptional
Latitude directionlat_dir

"N" for north or "S" for south of the Equator; not required if using signed decimal degrees.

Stringoptional
Longitude degreeslon_deg

The degrees of longitude; this value can be specified using decimal degrees, and when this format is used, minutes and seconds should not be specified.

Numberrequired
Longitude minuteslon_min

The minutes of longitude.

Numberoptional
Longitude secondslon_sec

The seconds of longitude.

Numberoptional
Longitude directionlon_dir

"E" for east or "W" for west of the Prime Meridian; not required if using signed decimal degrees.

Stringoptional


See also

Template:Sister project Template:Sister project

For similar examples, see the documentation at Template:Location map+, as well as:

Location map templates

Other templates

Infoboxes incorporating Location map – any country or region

List

Infoboxes incorporating Location map – specific countries or regions