Template:Location map many/doc

This is a documentation subpage for Template:Location map many
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:Location map/multi

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 Lua error in Module:Template_link_general at line 144: attempt to concatenate local 'titlePart' (a nil value). 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. 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=Lua error in Module:Template_link_general at line 144: attempt to concatenate local 'titlePart' (a nil value)., 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: or use: Cercle rouge 100%.svg to show a red circle 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:

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 Lua error in Module:Location_map at line 411: Malformed coordinates value.

{{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_Anywhere
  | mark2 = Rouge-Admin JollyRoger.svg
  | mark2size = 45
  | pos2 = top
  | bg2 = white
  | coordinates2 = {{coord|46|30|N|17|30|E}}
}}

Alternative syntax

Pag

Anytown_Anywhere

Location map many/doc (Croatia)

{{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_Anywhere
  | mark2 = Rouge-Admin JollyRoger.svg
  | mark2size = 45
  | pos2 = top
  | bg2 = white
  | lat2_deg = 46 | lat2_min = 30
  | lon2_deg = 17 | lon2_min = 30
}}

Map with 3 labels (decimal)

Recommended syntax Lua error in Module:Location_map at line 411: Malformed coordinates value.

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

Alternative syntax

Pag

Anytown

Anytown2

Location map many/doc (Croatia)

{{Location map many | Croatia
| width = 260
| float = right
| label = Pag
  | pos = right
  | marksize = 8
  | lat_deg = 44.44
  | lon_deg = 15.05
| label2 = Anytown
  | pos2 = bottom
  | bg2 = yellow
  | mark2size = 8
  | lat2_deg = 45.86
  | lon2_deg = 17.50
| label3 = Anytown2
  | pos3 = top
  | bg3 = lightgreen
  | lat3_deg = 46.23
  | lon3_deg = 18.43
}}