Template:Location map/doc

This is a documentation subpage for Template:Terminate sentence
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 650,000 pages, or roughly 30247% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Location map

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 <syntaxhighlight lang="text" class="" id="" style="" inline="1">Japan</syntaxhighlight>, 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

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	<syntaxhighlight lang="text" class="" id="" style="" inline="1">{{{1}}}</syntaxhighlight>	Required – use the name of the map as the first unnamed parameter; for example, specifying <syntaxhighlight lang="text" class="" id="" style="" inline="1">England</syntaxhighlight> 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.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">width</syntaxhighlight>	Determines the width of the map in pixels, overriding any default values; do not include `px`. For example, use `\|width=300`, not `\|width=300px`.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">default_width</syntaxhighlight>	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).
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">max_width</syntaxhighlight>	The maximum size of the map in pixels. Intended for use by templates, e.g. place infoboxes. Do not include `px`.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">float</syntaxhighlight>	Specifies the position of the map on the page; valid values are <syntaxhighlight lang="text" class="" id="" style="" inline="1">left</syntaxhighlight>, <syntaxhighlight lang="text" class="" id="" style="" inline="1">right</syntaxhighlight>, <syntaxhighlight lang="text" class="" id="" style="" inline="1">center</syntaxhighlight> and <syntaxhighlight lang="text" class="" id="" style="" inline="1">none</syntaxhighlight>. The default is <syntaxhighlight lang="text" class="" id="" style="" inline="1">right</syntaxhighlight>.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">border</syntaxhighlight>	Specifies the colour of the 1px map border; the default is <syntaxhighlight lang="text" class="" id="" style="" inline="1">lightgrey</syntaxhighlight> (see web colors). If set to <syntaxhighlight lang="text" class="" id="" style="" inline="1">none</syntaxhighlight>, no border will be generated. This parameter is seldom used.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">caption</syntaxhighlight>	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).
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">alt</syntaxhighlight>	Alt text for map; used by screen readers. See WP:ALT.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">relief</syntaxhighlight>	Any non-blank value (<syntaxhighlight lang="text" class="" id="" style="" inline="1">1</syntaxhighlight>, <syntaxhighlight lang="text" class="" id="" style="" inline="1">yes</syntaxhighlight>, etc.) will cause the template to display the map specified in the map definition template as <syntaxhighlight lang="text" class="" id="" style="" inline="1">image1</syntaxhighlight>, which is usually a relief map; see the example at Location map+/relief.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">AlternativeMap</syntaxhighlight>	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.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">overlay_image</syntaxhighlight>	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]}	<syntaxhighlight lang="text" class="" id="" style="" inline="1">label</syntaxhighlight>	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.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">label_size</syntaxhighlight>	label_size=80, not `\|label_size=80%`. If set to <syntaxhighlight lang="text" class="" id="" style="" inline="1">0</syntaxhighlight>, the label is only displayed when the user hovers over the mark.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">label_width</syntaxhighlight>	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`.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">position</syntaxhighlight>	position=none, any defined label will not be displayed with the mark, but it will be used to create the default caption.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">background</syntaxhighlight>	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.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">mark</syntaxhighlight>	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.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">marksize</syntaxhighlight>	marksize=10, not `\|marksize=10px`.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">link</syntaxhighlight>	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]]`.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">coordinates</syntaxhighlight>	The coordinates in {{Coord}} format. Whilst not recommended, coordinates can also be entered in decimal degrees (e.g. <syntaxhighlight lang="text" class="" id="" style="" inline="1">48.067°N 12.863°E</syntaxhighlight>); you shouldn't need to do this, though.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">lat_deg</syntaxhighlight>	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.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">lat_min</syntaxhighlight>	The minutes of latitude.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">lat_sec</syntaxhighlight>	The seconds of latitude; not usually necessary.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">lat_dir</syntaxhighlight>	<syntaxhighlight lang="text" class="" id="" style="" inline="1">N</syntaxhighlight> for north (default value), or <syntaxhighlight lang="text" class="" id="" style="" inline="1">S</syntaxhighlight> for south of the Equator; other values will be disregarded. Not required if using signed decimal degrees, i.e. negative numbers for southern latitude.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">lon_deg</syntaxhighlight>	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.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">lon_min</syntaxhighlight>	The minutes of longitude.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">lon_sec</syntaxhighlight>	The seconds of longitude; not usually necessary.
	<syntaxhighlight lang="text" class="" id="" style="" inline="1">lon_dir</syntaxhighlight>	<syntaxhighlight lang="text" class="" id="" style="" inline="1">E</syntaxhighlight> for east (default value), or <syntaxhighlight lang="text" class="" id="" style="" inline="1">W</syntaxhighlight> 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.

↑ If no coordinates are specified, the template will try to get them from the page's Wikidata item.

Available 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
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 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

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 (Croatia)

Pag (Croatia)

</syntaxhighlight>

Mark outside of map border, no caption

Rimini

Rimini

</syntaxhighlight>

Caption, label_size, background, mark, marksize

Rimini

Location of Rimini in Italy

Rimini

Location of Rimini in Italy

</syntaxhighlight>

AlternativeMap parameter

Rome

Location of Rome in Italy

Rome

Location of Rome in Italy

</syntaxhighlight>

Relief parameter

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

Biratnagar

Location of Biratnagar Airport in Nepal

Biratnagar

Location of Biratnagar Airport in Nepal

</syntaxhighlight>

Biratnagar

Location of Biratnagar Airport in Nepal

Biratnagar

Location of Biratnagar Airport in Nepal

</syntaxhighlight>

User selection of multiple maps

Lockerbie

Lockerbie in Scotland, UK

Lockerbie

Lockerbie (the United Kingdom)

Lockerbie

Lockerbie in Scotland, UK

Lockerbie

Lockerbie (the United Kingdom)

</syntaxhighlight>

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.

Pevek

Chukotka Autonomous Okrug

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

Uelen

Chukotka Autonomous Okrug

{{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

Click here to see a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Location map

<templatedata> { "description": "This template places a location mark on a map.", "params": { "1": { "label": "Map name(s)", "type": "string", "required": true, "description": "The name of the map to be used; multiple maps can be provided as a list separated by \"#\"." }, "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, use \"width=300\", not \"width=300px\"." }, "default_width": { "label": "Default width", "type": "number", "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": { "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 colour 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 location 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 identifying mark; a wikilink 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 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": { "label": "Label background", "type": "string", "description": "The background colour to use for the label." }, "mark": { "label": "Marker image", "type": "string", "description": "The name of an image file to display as the identifying mark." }, "marksize": { "label": "Marker size", "type": "number", "description": "The size of the identifying mark in pixels; do not include \"px\"." }, "link": { "label": "Marker link", "type": "string", "description": "Specifies a wikilink which can be followed if the reader clicks on the identifying mark." }, "lat_deg": { "label": "Latitude degrees", "type": "number", "required": true, "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": { "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\" for 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, and 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." }, "coordinates": { "label": "Coordinates",

"description": "Coordinates, usually in Coordinates: Missing latitude

⧼validator-fatal-error⧽

format; however, they can also be typed out in decimal degrees (with no spaces between \"°\" and \"N\"/\"S\"/\"E\"/\"W\").", "example": "48°04′01″N 12°51′47″E / 48.067°N 12.863°E

⧼validator-fatal-error⧽

",

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

Template:Location map/doc

Contents

Usage

Please note

Blank templates

Parameters

Available maps

Creating new map definitions

Examples

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

Map with the default caption (degrees/minutes)

Mark outside of map border, no caption

Caption, label_size, background, mark, marksize

AlternativeMap parameter

Relief parameter

User selection of multiple maps

Map that crosses 180° meridian

Template data

See also

Navigation menu