Template:Location map/doc
This is a documentation subpage for Template:Location map It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 724,000 pages, or roughly 2954% 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: |
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
Decimal degrees | Degrees, minutes, seconds | With {{Coord}} (usually for infoboxes) |
Wikidata |
---|---|---|---|
{{Location map|{{{0}}} |width = |float = |border = |caption = |alt = |relief = |AlternativeMap= |overlay_image = |label = |label_size = |position = |background = |mark = |marksize = |link = |lat_deg = |lon_deg = }} |
{{Location map|{{{0}}} |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|{{{0}}} |width = |float = |border = |caption = |alt = |relief = |AlternativeMap= |overlay_image = |label = |label_size = |position = |background = |mark = |marksize = |coordinates= }} |
{{Location map|{{{0}}} |width = |float = |border = |caption = |alt = |relief = |AlternativeMap= |overlay_image = |label = |label_size = |position = |background = |mark = |marksize = }} |
Parameters
Parameter kind | Parameter | Description |
---|---|---|
Map display | {{{1}}}
|
Required – use the name of the map as the first unnamed parameter; for example, specifying England will use the values for England in Module:Location map/data/England if it exists, or Lua error in Module:Template_link_general at line 144: attempt to concatenate local 'titlePart' (a nil value). if it does not. See the examples below. Multiple maps can be shown by providing a list of map names separated by #. For multiple maps, the first is shown by default. A reader can select the others with radio buttons.
|
width
|
Determines the width of the map in pixels, overriding any default values; do not include px. For example, use |width=300 , not |width=300px .
| |
default_width
|
Determines the default width of the map in pixels, intended for use by templates, e.g. place infoboxes; the default value is 240. Do not include px. This value will be multiplied by the defaultscale parameter specified in individual map templates, if it exists, in order to achieve an appropriate size for vertical maps. For example, if |default_width=200 is given, a map of Thailand will be displayed with a width of 200×0.57=114 pixels (as specified in Module:Location map/data/Thailand).
| |
max_width
|
The maximum size of the map in pixels. Intended for use by templates, e.g. place infoboxes. Do not include px. | |
float
|
Specifies the position of the map on the page; valid values are left , right , center and none . The default is right .
| |
border
|
Specifies the colour of the 1px map border; the default is lightgrey (see web colors). If set to none , no border will be generated. This parameter is seldom used.
| |
caption
|
The text of a caption to be displayed below the map; specifying a caption will cause the map to be displayed with a frame. If |caption= is defined but not assigned a value, the map will not be framed and no caption will be displayed. If |caption= is not defined, the map will not be framed and a default caption will be generated. The default caption is created from the |label= parameter (or the current page name if |label= not defined) and the |name= parameter from the map definition template. Multiple captions can be shown when separated by ## (that's two).
| |
alt
|
Alt text for map; used by screen readers. See WP:ALT. | |
relief
|
Any non-blank value (1 , yes , etc.) will cause the template to display the map specified in the map definition template as image1 , which is usually a relief map; see the example at Location map+/relief.
| |
AlternativeMap
|
Allows the use of an alternative map; the image must have the same edge coordinates as the location map template. See the example at Location map+/AlternativeMap. | |
overlay_image
|
Allows an overlay to be superimposed on the map; this parameter is seldom used. See the example at Location map+/overlay. | |
Label and mark parameters[note 1] | label
|
The text of the label to display next to the identifying mark; a wikilink can be used. You can enclose the label inside of {{nowrap}} if you want to make sure that it stays on a single line. The default (if not specified) is no label, just the marker. |
label_size
|
The font size to use for the label, given as a percentage of the normal font size (<100=smaller, >100=larger); the default size is 90. Do not include %. For example, use |label_size=80 , not |label_size=80% . If set to 0 , the label is only displayed when the user hovers over the mark.
| |
label_width
|
The width to use for the label, given as an em size; the default width is 6. Do not include em. For example, use |label_width=7 , not |label_width=7em .
| |
position
|
The position of the label relative to the identifying mark; valid values are left , right , top ,bottom and none . This defaults to either left or right , depending on the coordinates of the marker and its position relative to the right border of the map image. When |position=none , any defined label will not be displayed with the mark, but it will be used to create the default caption.
| |
background
|
The background colour to use for the label; see Web colors. The default is no background colour, which shows the map image behind the label. | |
mark
|
The name of an image file to display as the identifying mark; the default is Red pog.svg (). 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.
|
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
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 }}
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 -->
}}
When |position=none
, the label text is not displayed next to the mark, but is still used in the default caption and default alt text.
{{Location map|Croatia
|width = 200
|float = right
|label = Pag
|position = none
|mark = Green pog.svg <!--green dot-->
|lat_deg = 44 |lat_min = 26 <!-- default: lat_dir = N -->
|lon_deg = 15 |lon_min = 3 <!-- default: lon_dir = E -->
}}
{{Location map|Croatia
|width = 200
|float = right
|caption =
|alt = Rimini in Italy (outside the map)
|lat_deg = 44.05
|lon_deg = 12.57 <!--outside maps left border at 13.1-->
|outside = 1 <!--we're aware the point is outside the map, so suppress the warning category-->
|label = Rimini
|position = right
}}
Caption, label_size, background, mark, marksize
{{Location map|Italy
|width = 200
|float = right
|caption = Location of Rimini in Italy
|alt = Map of Italy with mark showing location of Rimini
|label = Rimini
|label_size = 150 <!--150% of normal size-->
|position = bottom
|background = orange
|mark = Orange_pog.svg
|marksize = 12 <!--size in pixels-->
|lat_deg = 44.05
|lon_deg = 12.57
}}
AlternativeMap parameter
{{Location map|Italy
|AlternativeMap = Italy location map.svg
|width = 200
|float = right
|caption = Location of Rome in Italy
|alt = Map of Italy with mark showing location of Rome
|label = Rome
|lat_deg = 41.9
|lon_deg = 12.5
}}
Relief parameter
Also demonstrates automatic positioning of label to the left due to the far right position of the mark.
{{Location map|Nepal
|relief = yes
|caption = Location of Biratnagar Airport in Nepal
|alt = Biratnagar Airport is located in southeastern Nepal.
|label = Biratnagar
|mark = Airplane silhouette.svg
|marksize = 10
|lat_deg = 26 |lat_min = 28 |lat_sec = 53 |lat_dir = N
|lon_deg = 87 |lon_min = 15 |lon_sec = 50 |lon_dir = E
}}
{{Location map|Nepal
|relief =
|caption = Location of Biratnagar Airport in Nepal
|alt = Biratnagar Airport is located in southeastern Nepal.
|label = Biratnagar
|mark = Airplane silhouette.svg
|marksize = 10
|lat_deg = 26 |lat_min = 28 |lat_sec = 53 |lat_dir = N
|lon_deg = 87 |lon_min = 15 |lon_sec = 50 |lon_dir = E
}}
User selection of multiple maps
{{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.
Lua error in Module:Location_map at line 411: Malformed coordinates value.
{{Location map | Russia Chukotka Autonomous Okrug | float = right | width = 250 | caption = [[Chukotka Autonomous Okrug]] | label = Pevek | position = bottom | background = lightgreen | mark = Locator_Dot.png | marksize = 7 | coordinates = {{coord|69|42|N|170|17|E}} }}
Lua error in Module:Location_map at line 411: Malformed coordinates value.
{{Location map | Russia Chukotka Autonomous Okrug | float = right | width = 250 | caption = [[Chukotka Autonomous Okrug]] | label = Uelen | position = bottom | background = lightgreen | mark = Locator_Dot.png | marksize = 7 | coordinates = {{coord|66|09|N|169|48|W}} }}
Template data
TemplateData documentation used by VisualEditor and other tools
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
See 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.
|
See also
- 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:
- 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 nine (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 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:Superimpose2, to place up to fifty (50) image layers over one another
Infoboxes incorporating Location map – any country or region Template:Location map/doc/See also infobox templates
Infoboxes incorporating Location map – specific countries or regions
- Template:Infobox Australian place
- Template:Infobox Belgium Municipality
- Template:Infobox European Parliament constituency
- Template:Infobox frazione (Italy)
- Template:Infobox French commune
- Template:Infobox German location
- Template:Infobox Greek Dimos
- Template:Infobox Israel village
- Template:Infobox Italian comune
- Template:Infobox London station
- Template:Infobox NRHP (USA)
- Template:Infobox Pennsylvania historic site (USA)
- Template:Infobox Site of Special Scientific Interest (UK)
- Template:Infobox Tibetan Buddhist monastery
- Template:Infobox UK place
- Template:Infobox UK postcode area