View source for Template:Location map/doc

{{documentation subpage}}
<!-- DOCUMENTATION -->
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.

== Usage ==
Map image files are not accessed directly but by using an auxiliary map definition template. For example, if the first unnamed parameter supplied to this template is "Japan", then this template uses the auxiliary template, {{tl|Location map Japan}} which contains the data needed to generate the composite image.

;Please note:
* 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 ==

{{Location map
| USA
| relief = 1
| width = 320
| lat = 44.6
| long = -110.5
| caption = Location of Yellowstone in the northwestern United States
}}

{|
! Decimal degrees
!
! Degrees, minutes, seconds
|- 
| valign="top" |
<pre style="overflow: auto; margin-right: 5px;">
{{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>
| width="20px" |
| valign="top" |
<pre style="overflow: auto; margin-right: 5px;">
{{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>
|}

== Parameters ==
{| class="wikitable" style="width:100%;"
! colspan="2" style="background-color:lightblue" | Map display parameters
|-
! Parameter
! Description
|-
| <code>{{{1}}}</code>
| '''Required'''. Use the name of the map as the first unnamed parameter. For example, specify ''England'' to use the values in {{tl|Location map England}}. See the [[#Examples|examples]] below.
|-
| <code>width</code>
| 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>.
|-
| <code>default_width</code>
| 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]]).
|-
| <code>float</code>
| 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>''.
|-
| <code>border</code>
|  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.
|-
| <code>caption</code>
| 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.
|-
| <code>alt</code>
| Alt text for map; used by [[screen reader]]s, see [[WP:ALT]].
|-
| <code>relief</code>
| 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]].
|-
| <code>AlternativeMap</code>
| 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>
| 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
|-
! Parameter
! Description
|-
| <code>label</code>
| 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.
|-
| <code>label_size</code>
| 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>.
|-
| <code>label_width</code>
| 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>.
|-
| <code>position</code>
| 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.
|-
| <code>background</code>
| 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.
|-
| <code>mark</code>
| 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]].
|-
| <code>marksize</code>
| 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>.
|-
| <code>link</code>
| 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.
|-
| <code>lat_deg</code>
| '''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.
|-
| <code>lat_min</code>
| The minutes of latitude.
|-
| <code>lat_sec</code>
| The seconds of latitude. Usually not necessary.
|-
| <code>lat_dir</code>
| 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>lon_deg</code>
| '''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.
|-
| <code>lon_min</code>
| The minutes of longitude.
|-
| <code>lon_sec</code>
| The seconds of longitude. Usually not necessary.
|-
| <code>lon_dir</code>
| 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).
|}

== Available map templates ==
There are over 1000 map templates available. To find other templates:

* [[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
* [[Special:WhatLinksHere/Template:Location map/Info]] - a search that might help
* [[Special:Prefixindex/Template:Location map]] - another search that might help

== Creating new map definition templates ==

See [[Template:Location map/Creating a new map template|Creating a new map template]].

== 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 | 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}}

=== 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.
{{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 -->
}}
<pre style="width: 40em;">
{{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 -->
}}
</pre>
{{clear}}

=== 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 map's left border at 13.1-->
| label    = Rimini
| position = right
}}
<pre style="width: 40em;">
{{Location map | Croatia
| width    = 200
| float    = right
| caption  =
| alt      = Rimini in Italy (outside the map)
| lat_deg  = 44.05
| lon_deg  = 12.57 <!--outside map's left border at 13.1-->
| label    = Rimini
| position = right
}}
</pre>
{{clear}}

=== 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
}}
<pre style="width: 40em;">
{{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
}}
</pre>
{{clear}}

{{anchor|Using Alternative Map}}<!--former section name for links from other pages-->
=== 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
}}
<pre style="width: 40em;">
{{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
}}
</pre>
{{clear}}

{{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.
{{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
}}
<pre style="width: 40em;">
{{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
}}
</pre>
{{clear}}

{{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
}}
<pre style="width: 40em;">
{{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
}}
</pre>
{{clear}}

{{anchor|Alternative style of map}}<!--former section name for links from other pages-->
=== Same coordinates on different maps ===
{{Location map | UK Scotland
| 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
}}
<pre style="width: 40em;">
{{Location map | UK Scotland
| 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
}}
</pre>
{{clear}}

{{Location map | United Kingdom
| 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
}}
<pre style="width: 40em;">
{{Location map | United Kingdom
| 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
}}
</pre>
{{clear}}

=== Map that crosses 180° meridian ===
:See [[:Category:Location map templates crossing 180th meridian]]
{{Location map | Fiji
| width      = 180
| float      = right
| label      = Suva
| position   = right
| background = yellow
| mark       = Locator_Dot.png
| marksize   = 7
| lat_deg =  18 | lat_min =  8 | lat_sec = 0 | lat_dir = S
| lon_deg = 178 | lon_min = 26 | lon_sec = 0 | lon_dir = E
}}
<pre style="width: 40em;">
{{Location map | Fiji
| width      = 180
| float      = right
| label      = Suva
| position   = right
| background = yellow
| mark       = Locator_Dot.png
| marksize   = 7
| lat_deg =  18 | lat_min =  8 | lat_sec = 0 | lat_dir = S
| lon_deg = 178 | lon_min = 26 | lon_sec = 0 | lon_dir = E
}}
</pre>
{{clear}}
== Template data ==
{{TemplateDataHeader}}
<templatedata>
{
	"description": "This template places a location mark on a map.",
	"params": {
		"1": {
			"label": "Map template name",
			"type": "string",
			"required": true,
			"description": "The name of the map template to be used"
		},
		"width": {
			"label": "Map width",
			"type": "number",
			"description": "Determines the width of the map in pixels, overriding any default values. Do not include \"px\", for example: \"300\", not \"300px\"."
		},
		"default_width": {
			"label": "Default width",
			"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."
		},
		"float": {
			"label": "Position",
			"type": "string",
			"description": "Specifies the position of the map on the page. Valid values are left, right, center and none. The default is right."
		},
		"border": {
			"label": "Border color",
			"type": "string",
			"description": "Specifies the color of the map border. If set to none, no border will be generated. "
		},
		"caption": {
			"label": "Map caption",
			"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."
		},
		"alt": {
			"label": "Alt text",
			"type": "string",
			"description": "Alt text for map; used by screen readers."
		},
		"relief": {
			"label": "Alternative map from template",
			"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."
		},
		"AlternativeMap": {
			"label": "Alternative map not from template",
			"type": "string",
			"description": "Allows the use of an alternative map. The image must have the same edge coordinates as the map template."
		},
		"overlay_image": {
			"label": "Overlay image",
			"type": "string",
			"description": "Allows an overlay to be superimposed on the map. This parameter is seldom used."
		},
		"label": {
			"label": "Marker label",
			"type": "string",
			"description": "The text of the label to display next to the mark. A wiki link can be used."
		},
		"label_size": {
			"label": "Label size",
			"type": "number",
			"description": "The font size to use for the label, given as a percentage of the normal font size. Do not include \"%\"."
		},
		"label_width": {
			"label": "Label width",
			"type": "number",
			"description": "The width to use for the label, given as an em size. Do not include \"em\"."
		},
		"position": {
			"label": "Label position",
			"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."
		},
		"background": {
			"label": "Label background",
			"type": "string",
			"description": "The background color to use for the label."
		},
		"mark": {
			"label": "Marker image",
			"type": "string",
			"description": "The name of an image to display as the marker."
		},
		"marksize": {
			"label": "Marker size",
			"type": "number",
			"description": "The size of the mark in pixels. Do not include \"px\"."
		},
		"link": {
			"label": "Marker link",
			"type": "string",
			"description": "Specifies a wiki link which will be followed if the reader clicks on the mark."
		},
		"lat_deg": {
			"label": "Latitude degrees",
			"type": "number",
			"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."
		},
		"lat_min": {
			"label": "Latitude minutes",
			"type": "number",
			"description": "The minutes of latitude."
		},
		"lat_sec": {
			"label": "Latitude seconds",
			"type": "number",
			"description": "The seconds of latitude."
		},
		"lat_dir": {
			"label": "Latitude direction",
			"type": "string",
			"description": "N if north  or S for south of the Equator. Not required if using signed decimal degrees."
		},
		"lon_deg": {
			"label": "Longitude degrees",
			"type": "number",
			"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."
		},
		"lon_min": {
			"label": "Longitude minutes",
			"type": "number",
			"description": "The minutes of longitude."
		},
		"lon_sec": {
			"label": "Longitude seconds",
			"type": "number",
			"description": "The seconds of longitude."
		},
		"lon_dir": {
			"label": "Longitude direction",
			"type": "string",
			"description": "E for east or W for west of the Prime Meridian. Not required if using signed decimal degrees."
		}
	}
}
</templatedata>

== See also ==
{{Commons|Location markers}}
{{Commons category|Map pointers}}

;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+/AlternativeMap]], an example using the ''AlternativeMap'' parameter
* [[Template:Location map+/overlay]], an example using the ''overlay_image'' parameter

;Location map templates
* [[Template:Location map many]], to display up to 9 markers and labels
* [[Template:Location map+]], to display unlimited number of markers and labels

;Other templates
* [[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:Superimpose]], supports simple layer superimposition.
* [[Template:Superimpose2]], to place up to 50 image layers over one another

; Infoboxes incorporating Location map - any country or region
{{Location map/doc/See also infobox templates}}

; Infoboxes incorporating Location map - specific countries or regions
{{Collapsible list | framestyle = border 1px; | titlestyle = text-align:left;background-color:lightgrey; |
* [[Template:Infobox Belgium Municipality]]
* [[Template:Infobox closed London station]] (UK)
* [[Template:Infobox European Parliament constituency]]
* [[Template:Infobox former Arab villages in Palestine]]
* [[Template:Infobox frazione]] (Italy)
* [[Template:Infobox French commune]]
* [[Template:Infobox German location]]
* [[Template:Infobox Greek Dimos]]
* [[Template:Infobox Holiday Camp]] (UK)
* [[Template:Infobox Hungarian settlement]]
* [[Template:Infobox Israel municipality]]
* [[Template:Infobox Italian comune]]
* [[Template:Infobox Kibbutz]] (Israel)
* [[Template:Infobox London station]]
* [[Template:Infobox Mandir]] (India)
* [[Template:Infobox motorway services]] (UK)
* [[Template:Infobox NRHP]] (USA)
* [[Template:Infobox PAhistoric]] (USA)
* [[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>
[[Category:Location map templates| ]]
[[Category:Graphic templates]]
</includeonly>