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 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 template. For example, if the first unnamed parameter supplied to this template is "Japan", then this template uses the auxiliary template, {{Location map Japan}} 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. 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 {{Location map+}}.

Blank templates

Location of Yellowstone in the north western United States

Decimal degrees

Degrees, minutes, seconds

{{Location map
| {{{1}}}
| width      = 
| float      = 
| border     = 
| caption    = 
| alt        = 
| relief     = 
| AlternativeMap = 
| label      = 
| label_size = 
| position   = 
| background = 
| mark       = 
| marksize   = 
| link       = 
| lat_deg    = 
| lon_deg    = 
}}

{{Location map
| {{{1}}}
| width      = 
| float      = 
| border     = 
| caption    = 
| alt        = 
| relief     = 
| AlternativeMap = 
| label      = 
| label_size = 
| position   = 
| background = 
| mark       = 
| marksize   = 
| link       = 
| lat_deg    = 
| lat_min    = 
| lat_sec    = 
| lat_dir    = 
| lon_deg    = 
| lon_min    = 
| lon_sec    = 
| lon_dir    = 
}}

Parameters

Map display parameters
Parameter	Description
`{{{1}}}`	Required. Use the name of the map as the first unnamed parameter. For example, specify England to use the values in {{Location map England}}. See the examples below.
`width`	Determines the width of the map in pixels. The default is 240. Do not include `px`, for example: `width=300`, not `width=300px`.
`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 color 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 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. The default caption is created from the `label` parameter (or the current page name if label not defined) and the `name` parameter from map definition template. See the examples below.
`alt`	Alt text for map; used by screen readers.
`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 below.
`AlternativeMap`	Allows the use of an alternative map. The image must have the same edge coordinates as the location map template. See the example below.
`overlay_image`	Allows an overlay to be superimposed on the map. This parameter is seldom used.
Label and mark parameters
Parameter	Description
`label`	The text of the label to display next to the mark. A wiki link can be used. 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 is 90. Do not include `%`, for example: `label_size=80`, not `label_size=80%`.
`label_width`	The width to use for the label, given as an em size. The default is 6. Do not include `em`, for example: `label_width=7`, not `label_width=7em`.
`position`	The position of the label relative to the mark. Valid values are `left`, `right`, `top` and `bottom`. The default is `right`.
`background`	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.
`mark`	The name of an image to display as the mark. The default is Red pog.svg (). See examples at Commons:Location markers and Commons:Category:Map icons.
`marksize`	The size of the mark in pixels. The default is 8. Do not include `px`, for example: `marksize=10`, not `marksize=10px`.
`link`	Specifies a wiki link which will be followed if the reader clicks on the mark. The name of the linked page is displayed when the mouse pointer hovers over the mark.
`lat_deg`	Required. The degrees of latitude. This value can be specified using decimal degrees and when this format is used minutes and seconds should not be specified.
`lat_min`	The minutes of latitude.
`lat_sec`	The seconds of latitude. Usually not necessary.
`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).
`lon_deg`	Required. The degrees of longitude. This value can be specified using decimal degrees and when this format is used minutes and seconds should not be specified.
`lon_min`	The minutes of longitude.
`lon_sec`	The seconds of longitude. Usually not 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 map templates

Category:Location map templates - templates sorted by category
Special:Prefixindex/Template:Location map - another search that might help

Creating new map definition templates

See Creating a new map template.

Examples

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

Location map/doc (Croatia)

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

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

Map with the default caption (degrees/minutes)

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 <!-- lat_dir = N -->
| lon_deg = 15 | lon_min = 3  <!-- lat_dir = E -->
}}

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

Marker/Label outside of Map

Rubicon

Rubicon (Croatia)

{{Location map | Croatia
| width    = 200
| float    = right
| alt      = Rubicon in Italy (outside the map)
| label    = Rubicon
| position = right
| lat_deg  = 44.44
| lon_deg  = 11.85 <!--outside map-->
}}

Map with a custom caption and text background

Imotski

Imotski in Croatia

{{Location map | Croatia
| width      = 200
| float      = right
| caption    = Imotski in Croatia
| alt        = Imotski is in Croatia.
| label      = Imotski
| position   = right
| background = #FFFFDD
| lat_deg    = 43.44
| lon_deg    = 17.21
}}

Map with enlarged marker and label

Pag

Pag Island in Croatia

{{Location map | Croatia
| width      = 200
| float      = right
| caption    = Pag Island in Croatia
| alt        = Pag is on an island
| label      = Pag
| label_size = 200 <!--200% larger-->
| position   = right
| background = #FFFFDD
| marksize   = 14
| lat_deg    = 44.44
| lon_deg    = 15.05
}}

Map with no caption or border

Brčko

{{Location map | Bosnia and Herzegovina
| width    = 200
| float    = right
| caption  =
| alt      = Brčko is in northeast Bosnia.
| label    = Brčko
| position = left
| lat_deg  = 44.87
| lon_deg  = 18.81
}}

Relief parameter

Popocatépetl

Popocatépetl (Mexico)

{{Location map | Mexico
| relief  = 1
| label   = Popocatépetl
| lat_deg = 19 | lat_min =  1 | lat_sec = 20 | lat_dir = N
| lon_deg = 98 | lon_min = 37 | lon_sec = 40 | lon_dir = W
}}