Template:Location map+/sandbox

__EXPECTUNUSEDTEMPLATE__This is the template sandbox page for Template:Location map+ (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 28,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Location map/multi (sandbox)

Bosworth

Berwick

London

York

Plymouth

Poole

Wem

Northumberland

Shrewsbury

Milford Haven

class=notpageimage|

Battle of Bosworth Field

other battles

{{Location map+}} places one or more location marks on a map, with optional labels. It is in the same family of templates as the Location map template and the documentation for that template might be helpful.

Template:Location map+ uses a helper template, {{Location map~}}, one or more times to generate a mark for each location.

Usage

Main template (one per map)	Helper template (one per location to be marked)
Main template (one per map)	Multi-line style
<syntaxhighlight lang="wikitext" style="width:14em; margin-right:2em;"> Lua error in Module:Location_map/multi at line 27: "{{{1}}}" is not a valid name for a location map definition.</syntaxhighlight>
	<syntaxhighlight lang="wikitext" style="width:12em;"> Lua error in Module:Location_map at line 371: "{{{1}}}" is not a valid name for a location map definition.</syntaxhighlight>	<syntaxhighlight lang="wikitext" style="width:12em;"> Lua error in Module:Location_map at line 371: "{{{1}}}" is not a valid name for a location map definition.</syntaxhighlight>	<syntaxhighlight lang="wikitext" style="width:12em;"> Lua error in Module:Location_map at line 371: "{{{1}}}" is not a valid name for a location map definition.</syntaxhighlight>
	Single-line style
	<syntaxhighlight lang="wikitext">Lua error in Module:Location_map at line 371: "{{{1}}}" is not a valid name for a location map definition.</syntaxhighlight> <syntaxhighlight lang="wikitext">Lua error in Module:Location_map at line 371: "{{{1}}}" is not a valid name for a location map definition.</syntaxhighlight><syntaxhighlight lang="wikitext">Lua error in Module:Location_map at line 371: "{{{1}}}" is not a valid name for a location map definition.</syntaxhighlight> Note: in single-line style, parameters order is chosen so that it's easier to maintain vertical alignment in subsequent {{Location map~}} calls (which improves wikicode readability). Parameters that are rarely given values, or those whose values (usually) have constant or only slightly varying lengths (in characters), are placed first; parameters whose values frequently have very different lengths are placed last. See an example below (note the alignment of `\|marksize=` and `\|position=` parameters in the wiki mark-up).

Parameters

Parameters for Location map+
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 or all subpages.
`width`	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`	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 Module:Location map/data/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. Special value: <syntaxhighlight lang="text" class="" style="" inline="1">infobox</syntaxhighlight>.
`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.
`maplink`	Specifies a wiki link that will be followed when clicking the map, by default to the map source file. Can be deactivated with `maplink =`, which can be useful to avoid mis-clicks if there are links associated with markers and labels.
`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. Other numerical values such as <syntaxhighlight lang="text" class="" style="" inline="1">2</syntaxhighlight> or <syntaxhighlight lang="text" class="" style="" inline="1">3</syntaxhighlight> will display <syntaxhighlight lang="text" class="" style="" inline="1">image2</syntaxhighlight> or <syntaxhighlight lang="text" class="" style="" inline="1">image3</syntaxhighlight>, if those images are defined.
`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.
`places`	Specifies one or more place markers using {{Location map~}}.

Parameters for Location map~
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.
Label
`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. Do not use `<div>...</div>` tags to attempt to position the label; use `\|label_size=` and `\|position=` instead.
`label_size`	The font size to use for the label, given as a percentage of the label's (already reduced) normal font size (<100 = smaller, >100 = larger). The default is 91; obey MOS:FONTSIZE if setting to a lower value. Do not include `%`: for example, use `label_size=95`, not `label_size=95%`. If set to 0, the label is displayed only when the user hovers over the mark.
`label_width`	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`.
`position`	The position of the label relative to the mark. Valid values are `left`, `right`, `top` and `bottom`. The default is `right`.
`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
`mark`	The name of an image to display as the mark. The default is Red pog.svg (). More mark images are available, in particular, 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, use `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, use `link=Yellowstone National Park`, not `link=[[Yellowstone National Park]]`.
Coordinates
`lat_deg`	Usual	Required. The degrees of latitude, using decimal degrees. Logically, use negative number for southern latitude.
`lon_deg`	Usual	Required. The degrees of longitude, using decimal degrees. Logically, use negative number for western longitude.
`lat_deg`	Detailed	Required. The degrees of latitude. The minutes and, probably, the seconds must be specified.^{[Note 1]}
`lat_min`		The minutes of latitude.^{[Note 1]} The sign should match that of lat_deg.
`lat_sec`		The seconds of latitude. Usually not necessary.^{[Note 1]} The sign should match that of lat_deg.
`lat_dir`		N if north (default value) or S for south of the Equator. Other values will be disregarded.
`lon_deg`		Required. The degrees of longitude. The minutes and, probably, the seconds must be specified.^{[Note 1]}
`lon_min`		The minutes of longitude.^{[Note 1]} The sign should match that of lon_deg.
`lon_sec`		The seconds of longitude. Usually not necessary.^{[Note 1]} The sign should match that of lon_deg.
`lon_dir`		E for east (default value) or W for west of the Prime Meridian. Other values will be disregarded.
cooordinates	Alternative	The coordinates using {{Coord}} template, e.g. `{{coord\|48.067\|-2.863}}`.

Notes:

^ ^1.0 ^1.1 ^1.2 ^1.3 ^1.4 ^1.5 Appropriate precision should be used. For example, the whole US map, with a 1000‑pixel width, has a resolution of about 5 km/pixel. Only 2 decimal places of precision in decimal degrees format (≈1 km), or whole minutes (≈1.7 km) in DMS format, are required.

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 were available when the list was generated.

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

Examples

This example does not designate the caption parameter. It demonstrates the use of the defaults. Notice that the default caption is the page name followed by the map name in parenthesis and that the label position is automatically adjusted if it is too close to an edge.

Sydney

Melbourne

Location map+/sandbox (Australia)

Sydney

Melbourne

Location map+/sandbox (Australia)

}}</syntaxhighlight>

This example uses a designated but empty caption. It demonstrates coordinates using decimal degrees, a 10px mark with a link, and {{Location map~}} entries listed in single-line style.

Paris

Marseille

Paris

Marseille

</syntaxhighlight>

This example uses caption with an assigned value. It demonstrates coordinates in degree, minute, second format, a relief map, label background color and linked labels.

New York

San Francisco

class=notpageimage|

Some cites in the United States

New York

San Francisco

class=notpageimage|

Some cites in the United States

</syntaxhighlight>

Also see the examples for {{Location map}} and {{Location map many}}, as well as:

Template:Location map+/relief, an example using the relief parameter
Template:Location map+/AlternativeMap, an example using the AlternativeMap parameter
Template:Location map+/overlay, an example using the overlay_image parameter

Template data

TemplateData documentation used by VisualEditor and other tools

See a monthly parameter usage report for Template:Location map+ in articles based on its TemplateData.

TemplateData for Location map+

This template places one or more location marks on a map.

Template parameters[Edit template data]
Parameter		Description	Type	Status
Map name	`1`	The name of the map to be used	String	required
Map width	`width`	Determines the width of the map in pixels, overriding any default values. Do not include "px", for example: "300", not "300px".	Number	optional
Default width	`default_width`	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.	Number	optional
Position	`float`	Specifies the position of the map on the page. Valid values are left, right, center and none. The default is right.	String	optional
Frame style	`border`	Specifies the color of the map frame when the parameter caption is used. If set to none, no border will be generated. Suggested values `none` `infobox` `LightGray`	String	optional
Map caption	`caption`	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.	String	optional
Alt text	`alt`	Alt text for map; used by screen readers.	String	optional
Alternative map from template	`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. If more than one relief map is defined, "2" will display "image2", and so on.	String	optional
Alternative map not from template	`AlternativeMap`	Allows the use of an alternative map. The image must have the same edge coordinates as the map template.	String	optional
Overlay image	`overlay_image`	Allows an overlay to be superimposed on the map. This parameter is seldom used.	String	optional
Place markers	`places`	Specifies one or more place markers using Location map~.	String	required