Template:Location map/doc

From WikiAlpha
Jump to: navigation, search
The below content is licensed according to Creative Commons Attribution-ShareAlike License contrary to the public domain logo at the foot of the page. It originally appeared on http://en.wikipedia.org. The original article might still be accessible here. You may be able to find a list of the article's previous contributors on the talk page.
This is a documentation subpage for Template:Location map.
It contains usage information, categories and other content that is not part of the original template page.
This template is used on 460,000+ pages.
To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them.
30px Uses Lua: {{safesubst:#invoke:list|bulleted}}

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. 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. 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+}} or {{Location map many}}.

Blank templates

Location of Yellowstone in the northwestern United States
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

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 200 * 0.57 = 114 pixels (as specified in Template:Location map Thailand).
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, 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 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%. 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 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,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 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 (8px). 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. Do not include [[]], for example: link=Yellowstone National Park, not link=[[Yellowstone National Park]].
coordinates The coordinates in {{Coord}} format. While 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. 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 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 maps

File:Template location map.svg
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 1000 maps available. To find other maps:

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

[[file:Template:Location map Croatia|240px|Pag is on an island.]]{{#invoke:Location map|mark}}
Location map/doc (Template:Location map 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.

[[file:Template:Location map Croatia|200px|Pag is on an island.]]{{#invoke:Location map|mark}}
{{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.

[[file:Template:Location map Croatia|200px|Pag is located in Template:Location map Croatia]]{{#invoke:Location map|mark}}
{{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

[[file:Template:Location map Croatia|200px|Rimini in Italy (outside the map)]]{{#invoke:Location map|mark}}
{{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-->
| 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

[[file:Template:Location map Italy|200px|Map of Italy with mark showing location of Rimini]]{{#invoke:Location map|mark}}
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

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

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

[[file:Template:Location map Nepal|240px|Biratnagar Airport is located in southeastern Nepal]]{{#invoke:Location map|mark}}
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
}}
[[file:Template:Location map Nepal|240px|Biratnagar Airport is located in southeastern Nepal]]{{#invoke:Location map|mark}}
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

[[file:Template:Location map UK Scotland|180px|Lockerbie is in southern Scotland.]]{{#invoke:Location map|mark}}
Lockerbie in Scotland, UK 
{{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

See Category:Location map templates crossing 180th meridian
[[file:Template:Location map Fiji|180px|Suva is located in Template:Location map Fiji]]{{#invoke:Location map|mark}}
{{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

This is the TemplateData documentation for this template used by VisualEditor and other tools.

See the monthly error report for this template.

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: \"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, 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 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." }, "coordinates": { "label": "Coordinates", "description": "Coordinates, usually in Template:Coord/input/nolat{{#coordinates:|||||||| | |name= }} 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 / 48.067; 12.863{{#coordinates:48.067|12.863||||||| | |name= }}", "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>

See also

Wikimedia Commons has media related to Location markers.
Wikimedia Commons has media related to Location map/doc.


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

Template:Location map/doc/See also infobox templates

Infoboxes incorporating Location map - specific countries or regions


Retrieved from "http://en.wikialpha.org/mediawiki/index.php?title=Template:Location_map/doc&oldid=186060"