Template:Location map many/doc

Template:Location map many creates a location map as a composite image of an existing map, with multiple markers and optional labels superimposed onto it. This template functions in the style of Template:Location map, but allows multiple markers and labels (rather than just one marker).

See also Template:Location map+, which specifies points as a coded template list of markers/labels.

Usage

The first unnamed parameter (shown as {{{1}}} below) specifies a map definition. If {{{1}}} is Spain, the map image and coordinates are based on the values defined for Spain in Module:Location map/data/Spain if it exists, or in Template:Location map Spain otherwise.

{{Location map many | {{{1}}} | width = | float = | border = | caption = | alt = | relief = | AlternativeMap = <!--first label/marker--> | label1 = <!-- or: label --> | label1_size = <!-- or: label_size --> | position1 = <!-- or: position, pos1, pos --> | background1 = <!-- or: background, bg1, bg --> | mark1 = <!-- or: mark --> | mark1size = <!-- or: marksize --> | link1 = <!-- or: link --> | coordinates1= <!-- {{coord|...}}--><!-- or: coordinates--> <!--second label/marker--> | label2 = | label2_size = | label2_width= | position2 = <!-- or: pos2 --> | background2 = <!-- or: bg2 --> | mark2 = | mark2size = | link2 = | coordinates2= <!-- {{coord| }} --> <!--repeat as needed--> }}

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.
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, 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. Numerical values such as 2 or 3 will display image2 or image3, if those images are defined. 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
Parameter	Description
label1 label2 ...	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.
label1_size label2_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%.
label1_width label2_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.
position1 position2 ...	The position of the label relative to the mark. Valid values are left, right, top and bottom. The default is right.
background1 background2 ...	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.
mark1 mark2 ...	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.
mark1size mark2size ...	The size of the mark in pixels. The default is 8. Do not include px, for example: marksize=10, not marksize=10px.
link1 link2 ...	Specifies a wiki link which will be followed if the reader clicks on the mark. The name of the linked article is displayed when the mouse pointer hovers over the mark.
coordinates1 coordinates2 ...	Required. The coordinates using a {{coord}} template. See the Alternative syntax section below for alternatives.

Note: For brevity, parameters "pos" & "bg" are aliases (for "position" & "background"), with pos2, bg2, pos3, bg3, etc.

Alternative syntax

The recommend input format for the marker coordinates is to use |coordinatesX={{coord|...}}, where X is the marker number. However, when used outside of infoboxes, the template supports splitting the coordinates into individual components using the parameters listed below.

Alternative map display parameters
Parameter	Description
lat1_deg lat2_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.
lat1_min lat2_min ...	The minutes of latitude.
lat1_sec lat2_sec ...	The seconds of latitude. Usually not necessary.
lat1_dir lat2_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).
lon1_deg lon2_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.
lon1_min lon2_min ...	The minutes of longitude.
lon1_sec lon2_sec ...	The seconds of longitude. Usually not necessary.
lon1_dir lon2_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).

Markers

When a marker's mark#size=0, then that marker is skipped and only the related label is displayed, without the marker.

Each mark, mark2, mark3 (etc.) can be another image-symbol, such as Diamond sheer red 20.gif (marksize=20) to show a red diamond on the image: File:Diamond sheer red 20.png or use: Cercle rouge 100%.svg to show a red circle File:Cercle rouge 100%.svg or a larger black diamond: Diamond sheer black 37.gif as sized with a larger marksize=37 or similar number to resize the diamond somewhat: File:Diamond sheer black 37.png

See Wikimedia pointer symbols: commons:Category:Map pointers.

Advisory messages

The degrees of latitude/longitude are validated, to show error messages, but location minutes can be set very large to place markers outside the map (with no warnings). Due to the numerous details of specifying multiple markers/labels, the latitude and longitude are checked to lie within the actual map limits specified in Template:Location_map_<parameter1>. Each marker/label is checked and can list a warning message (under the map), such as:

Latitude#4 (45.68) < map min(53.74).

Processing continues, with that marker actually placed off-map, and all latitude/longitude parameters are checked. Only degrees of latitude/longitude are checked, so a value of 63 minutes would be valid to indicate 1 extra degree + 3 minutes, and setting lon_min=200 could still place a marker off-map (right-side) with no warning message. Also, large markers or long labels can spill over the edges of a map, allowing markers to point inward from outside the map. In such cases, a map could be centered by itself on the page ("float=center") to avoid overlapping the edge markers onto any surrounding article text.

Available maps

Location maps can be found using these sources:

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.

List of templates - 1050 templates available when the list was generated.

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

Map with label "Pag" and "Anytown" (degrees)

Recommended syntax

{{Location map many | Croatia
| width = 280
| float = right
| label = Pag
  | marksize = 8
  | pos = right
  | bg = yellow
  | coordinates = {{coord|44|26|N|15|3|E}}
| label2 = Anytown
  | mark2 = Black pog-sized x.svg
  | mark2size = 18
  | pos2 = bottom
  | coordinates2 = {{coord|46|30|N|18|0|E}}
}}

Alternative syntax

{{Location map many | Croatia
| width = 280
| float = right
| label = Pag
  | marksize = 8
  | pos = right
  | bg = yellow
  | lat_deg = 44 | lat_min = 26
  | lon_deg = 15 | lon_min = 3
| label2 = Anytown
  | mark2 = Black pog-sized x.svg
  | mark2size = 18
  | pos2 = bottom
  | lat2_deg = 46 | lat2_min = 30
  | lon2_deg = 18 | lon2_min = 0
}}

Map with 3 labels (decimal), alternative relief maps

Using relief maps from Module:Location map/data/Croatia

{{Location map many | Croatia
| width = 260
| relief= yeah
| float = right
| label = Pag
  | pos = right
  | marksize = 8
  | coordinates = {{coord|44.44|15.05}}
| label2 = Anytown
  | pos2 = left
  | bg2 = #fff8
  | mark2size = 8
  | coordinates2 = {{coord|45.86|17.50}}
| label3 = Anytown2
  | pos3 = top
  | bg3 = #afa8
  | coordinates3 = {{coord|46.23|18.43}}
}}

{{Location map many | Croatia
| width = 260
| relief= 3
| float = right
| label = Pag
  | pos = left
  | bg = #ffaa
  | marksize = 12
  | coordinates = {{coord|44.44|15.05}}
| label2 = Anytown
  | pos2 = right
  | bg2 = #fff8
  | mark2size = 8
  | coordinates2 = {{coord|45.86|17.50}}
| label3 = Anytown 2
  | pos3 = left
  | bg3 = #afa8
  | coordinates3 = {{coord|46.23|18.43}}
}}

Example map with red diamond

{{Location map many | 100x100
| AlternativeMap = LocationJamaica.svg
| float = right
| width = 250
| caption = Site of '''Hispaniola'''
| label = Hispaniola
  | position = left
  | background = #CCDDFF
  | marksize = 1
  | coordinates = {{coord|38.2|69.3}}
| label2 =
  | mark2 =Diamond_sheer_red_37.png
  | mark2size = 42
  | coordinates2 = {{coord|52.2|73.9}}
| label3 = Cuba
  | pos3 = left
  | mark3size = 1
  | coordinates3 = {{coord|59.2|68.0}}
}}

Map with some labels outside map

{{Location map many | Croatia
| width = 260
| float = right
| label = Pag | position=right
  | marksize = 8
  | coordinates = {{coord|44.44|15.05}}
| label2 = Anytown
  | pos2 = bottom
  | bg2 = yellow
  | coordinates2 = {{coord|47.40|12.80}}
  | outside2 = 1 <!-- we know this point is outside the map, so don't warn about it -->
| label3 = Anytown2
  | pos3 = top
  | bg3 = lightgreen
  | coordinates3 = {{coord|41.98|18.43}}
  | outside3 = 1 <!-- we know this point is outside the map, so don't warn about it -->
| label4 = North Croatia
  | pos4 = left
  | bg4 = lightgreen
  | mark4size = 0
  | coordinates4 = {{coord|46.22|17.7}}
}}

Map with 9 markers (decimal)

{{Location map many | Croatia
| width = 260
| float = right
| label = Pag
  | position = right
  | coordinates = {{coord|44.44|15.05}}
| label2 = Anytown
  | label2_size = 110
  | pos2 = bottom
  | background2 = #ffff8877
  | coordinates2 = {{coord|45.86|17.50}}
| label3 = Anytown2
  | label3_size = 110
  | pos3 = top
  | background3 = #8f87
  | coordinates3 = {{coord|46.23|18.43}}
| mark4 =Diamond_sheer_black_20.png
  | mark4size = 19
  | label4 = 44.0 (latitude)
  | coordinates4 = {{coord|44.00|13.5}}
| mark5 =Diamond_sheer_black_20.png
  | mark5size = 20
  | label5 = 44.5
  | coordinates5 = {{coord|44.50|13.5}}
| mark6 =Diamond_sheer_black_20.png
  | mark6size = 20
  | label6 = 45.0
  | coordinates6 = {{coord|45.00|13.5}}
| mark7 =Diamond_sheer_black_20.png
  | mark7size = 20
  | label7 = 45.5
  | coordinates7 = {{coord|45.50|13.5}}
| mark8 =Diamond_sheer_black_20.png
  | mark8size = 20
  | label8 = 46.0
  | coordinates8 = {{coord|46.00|13.5}}
| label9 = ''CROATIA''
  | mark9size = <!--label only-->1
  | label9_size = 165
  | coordinates9 = {{coord|42.60|14.4}}
}}

Map with a custom label and text background

{{Location map many | Croatia
| width = 280
| float = right
| caption = Imotski in Croatia
| label = Imotski
| position = right
| background = #FFFFDD
| coordinates = {{coord|43.44|17.21}}
}}

Map with enlarged marker and label

{{Location map many | Croatia
| width = 260
| float = right
| caption = Pag Island in Croatia
| label = Pag
| label_size = 200
| position = right
| marksize = 14
| background = #FFFFDD
| coordinates = {{coord|44.44|15.05}}
}}

Map with no caption

{{Location map many | Bosnia
| width = 150
| float = right
| caption =
| label = Brčko
| position = left
| coordinates = {{coord|44.87|18.81}}
}}

Western Hemisphere

{{Location map many | United Kingdom
| width = 180
| float = right
| caption = Lockerbie in Scotland
| label = Lockerbie
| position = right
| coordinates = {{coord|55|07|16|N|3|21|19|W}}
}}

Map that crosses 180° meridian

See also: Category:Location map modules 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.

{{Location map many
| Russia Chukotka Autonomous Okrug
| float        = right
| width        = 250
| caption      = [[Chukotka Autonomous Okrug]]
| label1       = Pevek
| coordinates1 = {{coord|69|42|N|170|17|E}}
| label2       = Uelen
| coordinates2 = {{coord|66|09|N|169|48|W}}
}}

Marker examples

See Wikimedia pointer symbols: commons:Category:Map pointers.

Implementation notes

The map with markers/labels is implemented as nested HTML divisions. The map-image is in an HTML division, containing each point as a percent-locator division containing a marker-image sub-division plus a label sub-division. Each point is calculated (for a percent-locator division) with X or Y coordinate "XX.X%" or "YY.Y%" as follows:

• The div-tag is ‎<div>
• For placing latitude, the calculation is:

  XX.X% = 100 * (top - (lat_deg + latmin/60 +latsec/3600) ) / (top - bottom)

  If lat_deg is empty, the combined decimal latitude is used from "lat".

  If lat_dir is "S" (south), the latitude is multiplied by -1.

  (Note latitude is positioned in reverse, from top of map downward.)

• For placing longitude, the calculation is:

  YY.Y% = 100 * ( (lon_deg + lonmin/60 +lonsec/3600) - left ) / (right - left)

  If lon_deg is empty, the combined decimal longitude is used as "long".

  If lon_dir is "W" (west), the longitude is multiplied by -1.

• The div-tag is ended as "height: 0; width: 0; margin: 0; padding: 0;">.
• Within that division the marker/label sub-divisions are coded as:

  ‎<div>.

• For label position, the options are shifted as:

  when position:left, adds left: -6.5em; text-align: right;

  when position:right, adds left: 0.5em; text-align: left;"

  when position:top, adds top:-2.65em; left:-3em; text-align: center;"

  when position:bottom, adds top:-0.15em; left: -3em; text-align: center;" to div-tag.

See also

• OODA WIKI:Maps for OODA WIKI, a list of mapping tools available on OODA WIKI
• {{Location map}} - Placing one marker/label by latitude/longitude.
• {{Location map+}} - Placing unlimited list of markers/labels.
• Commons:Category:Map pointers - List of the many Wikimedia Commons pointer symbols.
• {{OSM Location map}} - OpenStreetMap map with an "interactive fullscreen" version. Allows for labels, numbered dots, a heading, caption, mini-locator map and overlays.
• {{Overlay}} - Allows image number, textual number, or color tag overlays to be positioned over an image to indicate particular features in the image.