Jump to content

Template:Location map/doc: Difference between revisions

Coordinates: 54°05′56″N 22°55′43″E / 54.09889°N 22.92861°E / 54.09889; 22.92861
From escforumwiki
Santos (talk | contribs)
m 1 revision imported
 
Santos (talk | contribs)
m 1 revision imported
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{High-risk| 507000+ }}
{{High-use| 599433 }}
{{TOC right}}
{{Lua|Module:Location map}}
{{Lua|Module:Location map}}
This [[:Category:Location map templates|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==
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 <u>any</u> 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>''' when setting the map image size.  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 either {{tl|Location map+}} or {{tl|Location map many}}.
==Blank templates==
{{Location map|USA
{{Location map|USA
|relief= 1
|relief= 1
Line 23: Line 10:
}}
}}


{|
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.
!Decimal degrees
 
!
==Usage==
!Degrees, minutes, seconds
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, which contains the data needed to generate the composite image.
!
 
!With {{tl|Coord}}<small><br>(usually for infoboxes)</small>
===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.
![[Wikidata]]
*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}}.
 
==Blank templates==
 
{| class="wikitable"
|+ Blank templates
|-
|-
|style=vertical-align:top|
! scope="col" | Decimal degrees
<pre style="overflow:auto; margin-right:5px">
! scope="col" | Degrees, minutes, seconds
! scope="col" | With {{tl|Coord}}<small><br>(usually for infoboxes)</small>
! scope="col" | [[Wikidata]]
|-
|style="vertical-align:top;"|
<syntaxhighlight lang="wikitext">
{{Location map|{{{1}}}
{{Location map|{{{1}}}
|width      =  
|width      =  
Line 53: Line 52:
|lon_deg    =  
|lon_deg    =  
}}
}}
</pre>
</syntaxhighlight>
|style=width:20px|
|style="vertical-align:top;"|
|style=vertical-align:top|
<syntaxhighlight lang="wikitext">
<pre style="overflow:auto; margin-right:5px">
{{Location map|{{{1}}}
{{Location map|{{{1}}}
|width      =  
|width      =  
Line 82: Line 80:
|lon_dir    =  
|lon_dir    =  
}}
}}
</pre>
</syntaxhighlight>
|style=width:20px|
|style="vertical-align:top;"|
|style=vertical-align:top|
<syntaxhighlight lang="wikitext">
<pre style="overflow:auto; margin-right:5px">
{{Location map|{{{1}}}
{{Location map|{{{1}}}
|width      =  
|width      =  
Line 103: Line 100:
|coordinates=  
|coordinates=  
}}
}}
</pre>
</syntaxhighlight>
|style=width:20px|
|style="vertical-align:top;"|
|style=vertical-align:top|
<syntaxhighlight lang="wikitext">
<pre style="overflow:auto; margin-right:5px">
{{Location map|{{{1}}}
{{Location map|{{{1}}}
|width      =  
|width      =  
Line 123: Line 119:
|marksize  =  
|marksize  =  
}}
}}
</pre>
</syntaxhighlight>
|}
|}


==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!!description
! scope="col" | Parameter kind
! 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 {{tld|Location map England}} otherwise. See the [[#Examples|examples]] below. Multiple maps can be shown by providing a list of map names separated by <tt>#</tt>. For multiple maps, the first is shown by default, a reader can select the others with radio buttons.
|{{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]]. 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 200x0.57 = 114 pixels (as specified in [[Module:Location map/data/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>max_width</code>
|{{code|max_width}}
|The maximum size of the map in pixels, intended for use by templates, e.g. place infoboxes. Do not include <code>px</code>.
|The maximum size of the map in pixels. Intended for use by templates, e.g. place infoboxes. Do not include {{kbd|px}}.
|-
|-
|<code>float</code>
|{{code|float}}
|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>.
|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>border</code>
|{{code|border}}
|Specifies the colour 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 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. Special value: {{code|infobox}}.
|-
|-
|<code>caption</code>
|{{code|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 <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.
|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>alt</code>
|{{code|alt}}
|Alt text for map; used by [[screen reader]]s, see [[WP:ALT]].
|Alt text for map; used by [[screen reader]]s. See [[WP:ALT]].
|-
|-
|<code>relief</code>
|{{code|relief}}
|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]].
|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]]. Other numerical values such as {{code|2}} or {{code|3}} will display {{code|image2}} or {{code|image3}}, if those images are defined.
|-
|-
|<code>AlternativeMap</code>
|{{code|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 [[Template:Location map+/AlternativeMap|Location map+/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 [[Template:Location map+/AlternativeMap|Location map+/AlternativeMap]].
|-
|-
|<code>overlay_image</code>
|{{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]].
|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]].
|-
|-
!colspan=2 style=background-color:lightblue|label and mark parameters<br><small>if no coordinates are specified, the template will try to get them from the page's [[Wikidata]] item</small>
| 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>
|{{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.
|-
|-
!parameter!!description
|{{code|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 {{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</code>
|{{code|label_width}}
|The text of the label to display next to the identifying mark; a [[Wiki markup|wikilink]] can be used. The default, if not specified is no label, just the marker.
|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_size</code>
|{{code|position}}
|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 <code>%</code>, for example: <code>label_size=80</code>, not <code>label_size=80%</code>. If set to 0, the label is only displayed when the user hovers over the mark.
|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>label_width</code>
|{{code|background}}
|The width to use for the label, given as an [[Em (typography)#CSS|em size]]; the default width is 6.  Do not include <code>em</code>, for example: <code>label_width=7</code>, not <code>label_width=7em</code>.
|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>position</code>
|{{code|mark}}
|The position of the label relative to the identifying mark; valid values are <code>left</code>, <code>right</code>, <code>top</code>,<code>bottom</code> and <code>none</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.  When <code>position=none</code>, any defined label will not be displayed with the mark, but it will be used to create the default caption.
|-
|<code>background</code>
|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>mark</code>
|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]].
|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>marksize</code>
|{{code|marksize}}
|The size of the identifying 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>.
|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>link</code>
|{{code|link}}
|Specifies a [[Wiki markup|wikilink]] which can be followed if the reader clicks on the identifying mark; do not include <code>[[]]</code> (double square brackets), for example: <code>link=Yellowstone National Park</code>, not <code>link=[&#91;Yellowstone National Park&#93;]</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>coordinates</code>
|{{code|coordinates}}
|The coordinates in {{tl|Coord}} format<small>whilst ''not'' recommended, if you want to waste time, you can also enter them in decimal degrees (e.g. <code>48.067°N 12.863°E</code>); you shouldn't need to, though.</small>
|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}}
|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; not usually 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}}
|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; not usually 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 [[IERS Reference Meridian|Prime Meridian]]; o_ther 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.
|}
|}
<references group="note"/>


==Available maps==
==Available maps==
[[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.]]
[[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 1,000 maps available. To find other maps:
There are over 1,000 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
*[[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
*[[Template:Location map/List]] - some of the items listed here are redirects, and a few templates may not function as expected
*[[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
:* [[Template:Location map/List/sorted]] - a list sorted geographically, which may be more useful
*[[Special:WhatLinksHere/Template:Location map/Info]] - a search that might help
*[[:Category:Location map templates]] templates sorted by category
*[[Special:Prefixindex/Template:Location map]] - another search that might help
*[[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==
==Creating new map definitions==
Line 235: Line 234:
==Examples==
==Examples==
===Default width and float, no label, default caption (decimal coordinates)===
===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)".
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
{{Location map|Croatia
|alt    = Pag is on an island.
|alt    = Pag is on an island.
Line 241: Line 240:
|lon_deg = 15.05
|lon_deg = 15.05
}}
}}
<pre style=width:40em>
<syntaxhighlight lang="wikitext" style=width:40em>
{{Location map|Croatia
{{Location map|Croatia
|alt    = Pag is on an island.
|alt    = Pag is on an island.
Line 247: Line 246:
|lon_deg = 15.05
|lon_deg = 15.05
}}
}}
</pre>
</syntaxhighlight>
{{clear}}
{{clear}}


Line 262: Line 261:
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
}}
}}
<pre style=width:40em>
<syntaxhighlight lang="wikitext" style=width:40em>
{{Location map|Croatia
{{Location map|Croatia
|width = 200
|width = 200
Line 273: Line 272:
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
}}
}}
</pre>
</syntaxhighlight>
{{clear}}
{{clear}}


Line 286: Line 285:
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
}}
}}
<pre style=width:40em>
<syntaxhighlight style=width:40em lang="wikitext" highlight="5">
{{Location map|Croatia
{{Location map|Croatia
|width = 200
|width = 200
Line 296: Line 295:
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
|lon_deg = 15 |lon_min = 3  <!-- default: lon_dir = E -->
}}
}}
</pre>
</syntaxhighlight>
{{clear}}
{{clear}}


Line 311: Line 310:
|position = right
|position = right
}}
}}
<pre style=width:60em>
<syntaxhighlight style=width:40em lang="wikitext" highlight="7-8">
{{Location map|Croatia
{{Location map|Croatia
|width    = 200
|width    = 200
Line 323: Line 322:
|position = right
|position = right
}}
}}
</pre>
</syntaxhighlight>
{{clear}}
{{clear}}


Line 333: Line 332:
|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 = 130 <!--130% of normal size-->
|position  = bottom
|position  = right
|background = orange
|background = #ffaa00aa <!--with opacity-->
|mark      = Orange_pog.svg
|mark      = Orange_pog.svg
|marksize  = 12 <!--size in pixels-->
|marksize  = 12 <!--size in pixels-->
Line 341: Line 340:
|lon_deg    = 12.578
|lon_deg    = 12.578
}}
}}
<pre style=width:40em>
<syntaxhighlight style=width:40em lang="wikitext" highlight="7,10-11">
{{Location map|Italy
{{Location map|Italy
|width      = 200
|width      = 200
Line 348: Line 347:
|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 = 130 <!--130% of normal size-->
|position  = bottom
|position  = bottom
|background = orange
|background = #ffaa00aa <!--with opacity-->
|mark      = Orange_pog.svg
|mark      = Orange_pog.svg
|marksize  = 12 <!--size in pixels-->
|marksize  = 12 <!--size in pixels-->
Line 356: Line 355:
|lon_deg    = 12.57
|lon_deg    = 12.57
}}
}}
</pre>
</syntaxhighlight>
{{clear}}
{{clear}}


Line 363: Line 362:
===AlternativeMap parameter===
===AlternativeMap parameter===
{{Location map|Italy
{{Location map|Italy
|AlternativeMap = Italy location map.svg
|AlternativeMap = Italy relief location map.jpg
|width  = 200
|width  = 200
|float  = right
|float  = right
Line 372: Line 371:
|lon_deg = 12.5
|lon_deg = 12.5
}}
}}
<pre style=width:40em>
<syntaxhighlight style=width:40em lang="wikitext" highlight="2">
{{Location map|Italy
{{Location map|Italy
|AlternativeMap = Italy location map.svg
|AlternativeMap = Italy relief location map.jpg
|width  = 200
|width  = 200
|float  = right
|float  = right
Line 383: Line 382:
|lon_deg = 12.5
|lon_deg = 12.5
}}
}}
</pre>
</syntaxhighlight>
{{clear}}
{{clear}}


Line 389: Line 388:


===Relief parameter===
===Relief parameter===
Also demonstrates automatic positioning of label to the left, due to far right position of mark.
When {{para|relief}} has no value, the module defined {{code|image}} is shown. Numerical values {{code|1}} to {{code|99}} will show {{code|image1}} to {{code|image99}}. Any other value will show {{code|image1}}.
{{Location map|Nepal
 
The following example also demonstrates automatic positioning of label to the left due to the far right position of the mark.
{{Location map|Africa
|relief = yes
|relief = yes
|caption = Location of Biratnagar Airport in Nepal
|caption = Location of [[Beyla]] in Africa
|alt = Biratnagar Airport is located in southeastern Nepal
|label = Bandar Beyla
|label = Biratnagar
|label_width = 9
|mark = Airplane silhouette.svg
|lat = 9.5
|marksize = 10
|long = 50.8
|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>
<syntaxhighlight style=width:40em lang="wikitext" highlight="2">
{{Location map|Nepal
{{Location map|Africa
|relief = yes
|relief = yes
|caption = Location of Biratnagar Airport in Nepal
|caption = Location of [[Beyla]] in Africa
|alt = Biratnagar Airport is located in southeastern Nepal
|label = Bandar Beyla
|label = Biratnagar
|label_width = 9
|mark = Airplane silhouette.svg
|lat = 9.5
|marksize = 10
|long = 50.8
|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>
</syntaxhighlight>
{{clear}}
{{clear}}


{{Location map|Nepal
The second relief map from [[Module:Location map/data/Africa]] can be used by setting {{para|relief|2}}
|relief =  
{{Location map|Africa
|caption = Location of Biratnagar Airport in Nepal
|relief = 2
|alt = Biratnagar Airport is located in southeastern Nepal
|caption = Location of Beyla on a simulated [[land cover]] map of Africa
|label = Biratnagar
|label = Bandar Beyla
|mark = Airplane silhouette.svg
|label_width = 9
|marksize = 10
|lat = 9.5
|lat_deg = 26 |lat_min = 28 |lat_sec = 53 |lat_dir = N
|long = 50.8
|lon_deg = 87 |lon_min = 15 |lon_sec = 50 |lon_dir = E
}}
}}
<pre style=width:40em>
<syntaxhighlight style=width:40em lang="wikitext" highlight="2">
{{Location map|Nepal
{{Location map|Africa
|relief =  
|relief = 2
|caption = Location of Biratnagar Airport in Nepal
|caption = Location of Beyla on a simulated [[land cover]] map of Africa
|alt = Biratnagar Airport is located in southeastern Nepal
|label = Bandar Beyla
|label = Biratnagar
|label_width = 9
|mark = Airplane silhouette.svg
|lat = 9.5
|marksize = 10
|long = 50.8
|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>
</syntaxhighlight>
{{clear}}
{{clear}}


Line 453: Line 447:
|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 style=width:40em>
<syntaxhighlight style=width:40em lang="wikitext" highlight="1">
{{Location map|UK Scotland#UK
{{Location map|UK Scotland#UK
|relief = 1
|relief = 1
Line 466: Line 460:
|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>
</syntaxhighlight>
 
{{Clear}}
====Multiple selectable maps in floating box====
 
Template such as [[Template:Infobox settlement]] display the selectable radio buttons underneath the location map.
The following code utilizes [[Template:Stack]] to achieve a similar result.
 
{{stack begin}}
<div style="background:white; border:1px solid rgb(0, 0, 0); padding:2px; align:center; text-align:left; width:260; position:relative;">
{{Location map|Poland#Podlaskie Voivodeship#Europe#Baltic Sea#NATO
|relief        = Yes
|width        = 260
|default_width =
|float        =
|caption      = The [[Suwałki Gap]] is named after the city of [[Suwałki]] (marked by the blue dot).
|alt          = The city of Suwałki
|label        = Suwałki
|link          = Suwałki
|position      =
|mark          = Blue_pog.svg
|marksize      = 6
|coordinates  = {{coord|54|05|56|N|22|55|43|E|region:PL_type:city|display=inline,title}}
|border        = infobox
|background    =
}}
</div>
{{stack end}}
<syntaxhighlight style=width:70em lang="wikitext" highlight="1-2, 19-20">
{{stack begin}}
<div style="background:white; border:1px solid rgb(0, 0, 0); padding:2px; align:center; text-align:left; width:260; position:relative;">
{{Location map|Poland#Podlaskie Voivodeship#Europe#Baltic Sea#NATO
|relief        = Yes
|width        = 260
|default_width =
|float        =
|caption      = The [[Suwałki Gap]] is named after the city of [[Suwałki]] (marked by the blue dot).
|alt          = The city of Suwałki
|label        = Suwałki
|link          = Suwałki
|position      =
|mark          = Blue_pog.svg
|marksize      = 6
|coordinates  = {{coord|54|05|56|N|22|55|43|E|region:PL_type:city|display=inline,title}}
|border        = infobox
|background    =
}}
</div>
{{stack end}}
</syntaxhighlight>


===Map that crosses 180° meridian===
===Map that crosses 180° meridian===
:See [[:Category:Location map templates crossing 180th meridian]]
{{Category see also|Location map modules crossing the 180th meridian}}
{{Location map|Fiji
 
|width     = 180
[[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.
|float     = right
 
|label     = Suva
{{Location map
|position   = right
| Russia Chukotka Autonomous Okrug
|background = yellow
| float      = right
|mark       = Locator_Dot.png
| width       = 250
|marksize   = 7
| caption    = [[Chukotka Autonomous Okrug]]
|lat_deg = 18 |lat_min = 8 |lat_sec = 0 |lat_dir = S
| label      = Pevek
|lon_deg = 178 |lon_min = 26 |lon_sec = 0 |lon_dir = E
| position    = bottom
| background  = lightgreen
| mark        = Locator_Dot.png
| marksize    = 7
| coordinates = {{coord|69|42|N|170|17|E}}
}}
<syntaxhighlight lang="wikitext" style="width: 30em">
{{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}}
}}
</syntaxhighlight>
{{clear}}
 
{{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}}
}}
}}
<pre style=width:40em>
<syntaxhighlight lang="wikitext" 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>
</syntaxhighlight>
{{clear}}
{{clear}}


==Template data==
==Template data==
{{TemplateData header}}
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
<templatedata>
{
{
Line 506: Line 583:
"type": "string",
"type": "string",
"required": true,
"required": true,
"description": "The name of the map to be used; multiple maps can be provided as a list separated by #"
"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\".",
"suggestedvalues": [
"left",
"right",
"center",
"none"
],
"default": "right"
},
},
"border": {
"border": {
"label": "Border color",
"label": "Frame style",
"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 frame when the parameter caption is used. If set to \"none\", no border will be generated.",
"suggestedvalues": [
"none",
"infobox",
"LightGray"
]
},
},
"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 541: Line 630:
"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. If more than one relief map is defined, \"2\" will display \"image2\", and so on."
},
},
"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": {
Line 556: Line 645:
"label": "Marker label",
"label": "Marker label",
"type": "string",
"type": "string",
"description": "The text of the label to display next to the mark; a wikilink 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": {
Line 571: Line 660:
"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, 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."
"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 wikilink 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 597: Line 686:
"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 612: Line 701:
"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 618: Line 707:
"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 633: Line 722:
"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": {
"coordinates": {
"label": "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).",
"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}}",
"example": "{{Coord|48.067|12.863}}",
"type": "string"
"type": "string"
Line 673: Line 762:
}
}
</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 nine (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 thirty (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 fifty (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|
{{hidden|style=border:#aaa 1px solid| headerstyle = text-align:left; padding-left:0.5em; background:#EEE;|List|
*[[Template:Infobox Australian place]]
*[[Template:Infobox Australian place]]
*[[Template:Infobox Belgium Municipality]]
*[[Template:Infobox Belgium Municipality]]
Line 705: Line 798:
*[[Template:Infobox German location]]
*[[Template:Infobox German location]]
*[[Template:Infobox Greek Dimos]]
*[[Template:Infobox Greek Dimos]]
*[[Template:Infobox Hungarian settlement]]
*[[Template:Infobox Israel municipality]]
*[[Template:Infobox Israel village]]
*[[Template:Infobox Israel village]]
*[[Template:Infobox Italian comune]]
*[[Template:Infobox Italian comune]]
*[[Template:Infobox London station]]
*[[Template:Infobox London station]]
*[[Template:Infobox NRHP]] (USA)
*[[Template:Infobox NRHP]] (USA)
*[[Template:Infobox Palestine municipality]] (via [[Template:Infobox settlement]])
*[[Template:Infobox Pennsylvania historic site]] (USA)
*[[Template:Infobox Pennsylvania historic site]] (USA)
*[[Template:Infobox Site of Special Scientific Interest]] (UK)
*[[Template:Infobox Site of Special Scientific Interest]] (UK)
*[[Template:Infobox Tibetan Buddhist monastery]]
*[[Template:Infobox Tibetan Buddhist monastery]]
*[[Template:Infobox Town AT]] (Austria)
*[[Template:Infobox UK feature]]
*[[Template:Infobox UK place]]
*[[Template:Infobox UK place]]
*[[Template:Infobox UK postcode area]]
*[[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:Map formatting and function templates]]
[[Category:Map formatting and function templates]]
}}</includeonly>
}}</includeonly>

Latest revision as of 13:54, 8 March 2025

Location map/doc is located in the United States
Location map/doc
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, 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. 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. Special value: infobox.
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. Other numerical values such as 2 or 3 will display image2 or image3, if those images are defined.
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 (). 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

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)".

Pag is on an island.
Pag is on an island.
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 is on an island.
Pag is on an island.
Pag
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.

Pag is located in Croatia
Pag
Pag (Croatia)
{{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

Rimini in Italy (outside the map)
Rimini in Italy (outside the map)
Rimini
{{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

Map of Italy with mark showing location of Rimini
Map of Italy with mark showing location of Rimini
Rimini
Location of Rimini in Italy
{{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 = 130 <!--130% of normal size-->
|position   = bottom
|background = #ffaa00aa <!--with opacity-->
|mark       = Orange_pog.svg
|marksize   = 12 <!--size in pixels-->
|lat_deg    = 44.05
|lon_deg    = 12.57
}}

AlternativeMap parameter

Map of Italy with mark showing location of Rome
Map of Italy with mark showing location of Rome
Rome
Location of Rome in Italy
{{Location map|Italy
|AlternativeMap = Italy relief location map.jpg
|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

When |relief= has no value, the module defined image is shown. Numerical values 1 to 99 will show image1 to image99. Any other value will show image1.

The following example also demonstrates automatic positioning of label to the left due to the far right position of the mark.

Bandar Beyla is located in Africa
Bandar Beyla
Bandar Beyla
Location of Beyla in Africa
{{Location map|Africa
|relief = yes
|caption = Location of [[Beyla]] in Africa
|label = Bandar Beyla
|label_width = 9
|lat = 9.5
|long = 50.8
}}

The second relief map from Module:Location map/data/Africa can be used by setting |relief=2

Bandar Beyla is located in Africa
Bandar Beyla
Bandar Beyla
Location of Beyla on a simulated land cover map of Africa
{{Location map|Africa
|relief = 2
|caption = Location of Beyla on a simulated [[land cover]] map of Africa 
|label = Bandar Beyla
|label_width = 9
|lat = 9.5
|long = 50.8
}}

User selection of multiple maps

Lockerbie is in southern Scotland.
Lockerbie is in southern Scotland.
Lockerbie
Lockerbie in Scotland, UK
{{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
}}

Multiple selectable maps in floating box

Template such as Template:Infobox settlement display the selectable radio buttons underneath the location map. The following code utilizes Template:Stack to achieve a similar result.

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

{{stack begin}}
<div style="background:white; border:1px solid rgb(0, 0, 0); padding:2px; align:center; text-align:left; width:260; position:relative;">
{{Location map|Poland#Podlaskie Voivodeship#Europe#Baltic Sea#NATO
|relief        = Yes
|width         = 260
|default_width = 
|float         = 
|caption       = The [[Suwałki Gap]] is named after the city of [[Suwałki]] (marked by the blue dot).
|alt           = The city of Suwałki
|label         = Suwałki
|link          = Suwałki
|position      = 
|mark          = Blue_pog.svg
|marksize      = 6
|coordinates   = {{coord|54|05|56|N|22|55|43|E|region:PL_type:city|display=inline,title}}
|border        = infobox
|background    = 
}}
</div>
{{stack end}}

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.

{{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}}
}}
{{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 a monthly parameter usage report for Template:Location map in articles based on its TemplateData.

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".

Suggested values
left right center none
Default
right
Stringoptional
Frame styleborder

Specifies the colour of the map frame when the parameter caption is used. If set to "none", no border will be generated.

Suggested values
none infobox LightGray
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. If more than one relief map is defined, "2" will display "image2", and so on.

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

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


MediaWiki spam blocked by CleanTalk.