Template:Location map

From Jaroussky Wiki
Jump to navigation Jump to search
50px Template documentation[view] [edit] [history] [purge]
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

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> 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 <syntaxhighlight lang="text" class="" id="" style="" inline="1">defaultscale</syntaxhighlight> 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).
<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> 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).
<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> 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 <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> The position of the label relative to the identifying mark; 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">top</syntaxhighlight>,<syntaxhighlight lang="text" class="" id="" style="" inline="1">bottom</syntaxhighlight> and <syntaxhighlight lang="text" class="" id="" style="" inline="1">none</syntaxhighlight>. This defaults to either <syntaxhighlight lang="text" class="" id="" style="" inline="1">left</syntaxhighlight> or <syntaxhighlight lang="text" class="" id="" style="" inline="1">right</syntaxhighlight>, 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.
<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 (8px). See examples at Commons:Location markers and Commons:Category:Map icons.
<syntaxhighlight lang="text" class="" id="" style="" inline="1">marksize</syntaxhighlight> The size of the identifying mark in pixels; the default is 8. Do not include px. For example, use |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.
  1. ↑ If no coordinates are specified, the template will try to get them from the page's Wikidata item.

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 1,000 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)".

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.

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.

<syntaxhighlight style=width:40em lang="text" highlight="5">

</syntaxhighlight>

Mark outside of map border, no caption

<syntaxhighlight style=width:40em lang="text" highlight="7-8">

</syntaxhighlight>

Caption, label_size, background, mark, marksize

Location of Rimini in Italy

<syntaxhighlight style=width:40em lang="text" highlight="7,10-11">

Location of Rimini in Italy

</syntaxhighlight>

AlternativeMap parameter

Location of Rome in Italy

<syntaxhighlight style=width:40em lang="text" highlight="2">

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.

Location of Biratnagar Airport in Nepal

<syntaxhighlight style=width:40em lang="text" highlight="2">

Location of Biratnagar Airport in Nepal

</syntaxhighlight>

Location of Biratnagar Airport in Nepal

<syntaxhighlight style=width:40em lang="text" highlight="2">

Location of Biratnagar Airport in Nepal

</syntaxhighlight>

User selection of multiple maps

Lockerbie in Scotland, UK
Lockerbie (the United Kingdom)

<syntaxhighlight style=width:40em lang="text" highlight="1">

Lockerbie in Scotland, UK
Lockerbie (the United Kingdom)

</syntaxhighlight>

Map that crosses 180° meridian

See also: Category:Location map templates crossing the 180th 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 408: 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 408: 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
Click here to see a monthly parameter usage report for this template based on this TemplateData.

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, use "width=300", not "width=300px".

Numberoptional
Default widthdefault_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.

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 colour 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 location 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 identifying 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 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.

Stringoptional
Label backgroundbackground

The background colour to use for the label.

Stringoptional
Marker imagemark

The name of an image file to display as the identifying mark.

Stringoptional
Marker sizemarksize

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

Numberoptional
Marker linklink

Specifies a wikilink which can be followed if the reader clicks on the identifying 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, and 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" for 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, and 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

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
The above documentation is transcluded from Template:Location map/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.
Retrieved from ‘https://jarousskywiki.com/index.php?title=Template:Location_map&oldid=3703’