Wikiversity

Template:Location map/doc

< Template:Location map

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

edit

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 {{Location map Japan}} otherwise, one of 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

edit
Location map/doc is located in the US
Location map/doc
Location of Yellowstone in the north-western United States of America
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

edit
map display parameters
parameter description
{{{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 {{Location map England}} otherwise. 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: 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 200x0.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 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, 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
if no coordinates are specified, the template will try to get them from the page's Wikidata item
parameter description
label The text of the label to display next to the identifying mark; a wikilink 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 size is 90. Do not include %, for example: 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: 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: 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: link=Yellowstone National Park, not link=[[Yellowstone National Park]].
coordinates The coordinates in {{Coord}} format; whilst not recommended, if you want to waste time, you can also enter them in decimal degrees (e.g. 48.067°N 12.863°E); you shouldn't need to, 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 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 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; o_ther values will be disregarded. Not required if using signed decimal degrees, i.e. negative numbers for western longitude.

Available maps

edit
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

edit

See Creating a new map definition.

Examples

edit

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

edit

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)

edit

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

edit
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

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

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

edit

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

Biratnagar Airport is located in southeastern Nepal
Biratnagar Airport is located in southeastern Nepal
Biratnagar
Location of Biratnagar Airport in Nepal
{{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
}}
Biratnagar Airport is located in southeastern Nepal
Biratnagar Airport is located in southeastern Nepal
Biratnagar
Location of Biratnagar Airport in Nepal
{{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

edit
Lockerbie is in southern Scotland.
Lockerbie is in southern Scotland.
Lockerbie
Lockerbie in Scotland, UK
Lockerbie is in southern Scotland.
Lockerbie is in southern Scotland.
Lockerbie
Lockerbie (the United Kingdom)
{{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
}}

Map that crosses 180° meridian

edit
See Category:Location map templates crossing 180th meridian
Suva is located in Fiji
Suva
Suva
Suva (Fiji)
{{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
}}

Template data

edit
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

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: "300", not "300px".

Numberoptional
Default widthdefault_width

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.

Numberoptional
Positionfloat

Specifies the position of the map on the page; valid values are left, right, center and none. The default is right.

Stringoptional
Border colorborder

Specifies the color of the map border; if set to none, no border will be generated.

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.

Stringoptional
Alternative map not from templateAlternativeMap

Allows the use of an alternative map; the image must have the same edge coordinates as the 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 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 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 color to use for the label.

Stringoptional
Marker imagemark

The name of an image to display as the marker.

Stringoptional
Marker sizemarksize

The size of the mark in pixels; do not include "px".

Numberoptional
Marker linklink

Specifies a wikilink which will be followed if the reader clicks on the 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. 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 if 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. 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

edit
Wikimedia Commons has media related to Location markers.
Wikimedia Commons has media related to Map pointers.
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
List


Retrieved from "https://en.wikiversity.org/w/index.php?title=Template:Location_map/doc&oldid=1964533"