Template:Location map/doc

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 Japan, then this template uses the entry for the Comonwealth in Module:Location map/data/Commonwealth if it exists, which contains the data needed to generate the composite image.

Please note

 * Assigning 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 200px will usually cause a very large map to be displayed. Use 200.
 * To create a map with more than one location mark, use either Location map+ or Location map many.

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.

When none, the label text is not displayed next to the mark, but is still used in the default caption and default alt text.

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

Multiple selectable maps in floating box
Template such as Template:Infobox settlement display the selectable radio buttons underneath the location map. The following code utilizes Template:Stack to achieve a similar result.



Map that crosses 180° 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.

Template data
{	"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, use \"width=300\", not \"width=300px\"." },		"default_width": { "label": "Default width", "type": "number", "description": "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." },		"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\".", "suggestedvalues": [ "left", "right", "center", "none" ],			"default": "right" },		"border": { "label": "Border color", "type": "string", "description": "Specifies the colour 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 location 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 identifying mark; a wikilink 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 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": { "label": "Label background", "type": "string", "description": "The background colour to use for the label." },		"mark": { "label": "Marker image", "type": "string", "description": "The name of an image file to display as the identifying mark." },		"marksize": { "label": "Marker size", "type": "number", "description": "The size of the identifying mark in pixels; do not include \"px\"." },		"link": { "label": "Marker link", "type": "string", "description": "Specifies a wikilink which can be followed if the reader clicks on the identifying mark." },		"lat_deg": { "label": "Latitude degrees", "type": "number", "required": true, "description": "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": { "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\" for 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, and 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 °N, °W format; however, they can also be typed out in decimal degrees (with no spaces between \"°\" and \"N\"/\"S\"/\"E\"/\"W\").", "example": "48.067°N, 12.863°W", "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" ] }