Template:Location map~

File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]

This template is used on approximately 22,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.

File:Lua-Logo.svg

This template uses Lua:

Module:Location map

Map of England showing the locations of towns and battles. Bosworth is in the centre, northwest of London.

Bosworth

File:Battle icon active (crossed swords).svg Battle of Bosworth Field File:Battle icon (crossed swords).svg 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

{{Location map+
| {{{1}}}
| width          =
| float          =
| border         =
| caption        =
| alt            =
| relief         =
| AlternativeMap =
| overlay_image  =
| places         =
}}

{{Location map~
| {{{1}}}
| label       =
| label_size  =
| label_width =
| position    =
| background  =
| mark        =
| marksize    =
| link        =
| lat_deg     =
| lon_deg     =
}}

{{Location map~
| {{{1}}}
| label       =
| label_size  =
| label_width =
| position    =
| background  =
| mark        =
| marksize    =
| link        =
| lat_deg     =
| lat_min     =
| lat_sec     =
| lat_dir     =
| lon_deg     =
| lon_min     =
| lon_sec     =
| lon_dir     =
}}

{{Location map~
| {{{1}}}
| label       =
| label_size  =
| label_width =
| position    =
| background  =
| mark        =
| marksize    =
| link        =
| coordinates =
}}

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: `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.
`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.
`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; do set lower than 91, per MOS:FONTSIZE. Do not include `%`, for example: `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 (File:Red pog.svg). See examples 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: `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: `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:

^ ^a ^b ^c ^d ^e ^f Appropriate precision should be used. For example, the whole US map, with a 1000-pixel width, has a resolution of about 5km/pixel. Only 2 decimal places of precision in decimal degrees (~1km), or whole minutes (~1.7km) 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 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.

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.

Location map~ is located in Australia

Sydney

Lua error in Module:Location_map at line 408: Malformed coordinates value.

Location map~ (Australia)

{{Location map+ | Australia
| places =
  {{Location map~ | Australia
    | label = Sydney
    | lat_deg = -33.86
    | lon_deg = 151.21 }}
  {{Location map~ | Australia
    | label = Melbourne
    | coordinates = {{coord|-37.81|144.96}}
  }}
}}
}}

This example uses a designated but empty caption. It demonstrates coordinates using decimal degrees and a 10px mark with a link.

Location map~ is located in France

Paris

Marseille

{{Location map+ | France
| caption =
| places =
  {{Location map~ | France
    | label = Paris
    | position = top
    | marksize = 10
    | link = Paris
    | lat_deg = 48.8567
    | lon_deg = 2.3508
  }}
  {{Location map~ | France
    | label = Marseille
    | position = top
    | marksize = 10
    | link = Marseille
    | lat_deg = 43.2964
    | lon_deg = 5.3610
  }}
}}

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.

Location map~ is located in the United States

New York

San Francisco

class=notpageimage|

Some cites in the United States

{{Location map+ | USA
| width = 300
| caption = Some cites in the United States
| relief = 1
| places =
  {{Location map~ | USA
    | label = [[New York City|New York]]
    | position =
    | background = white
    | mark = Cyan pog.svg
    | alt = alt text for New York City
    | link = New York City
    | lat_deg = 40 | lat_min = 43 | lat_dir = N
    | lon_deg = 74 | lon_min = 0  | lon_dir = W
  }}
  {{Location map~| USA
    | label = [[San Francisco]]
    | position =
    | background = white
    | mark = Purple pog.svg
    | alt = alt text for San Francisco
    | link = San Francisco
    | lat_deg = 37  | lat_min = 46 | lat_dir = N
    | lon_deg = 122 | lon_min = 25 | lon_dir = W
  }}
}}

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

Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Location map~

A helper template for Template:Location map+. Creates a single place marker on a map.

Template parameters
Parameter		Description	Type	Status
Map name	`1`	Must be the same as specified in the parent Location map +. For example, specifying England will use the values for England in Module:Location map/data/England if it exists, or {{Location map England}} otherwise.	String	required
Label	`label`	The label to display; may be wikilinked. Default No label displayed by default, just a marker.	Content	suggested
Label font size	`label_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 %. If set to zero, the label is only shown on hovering over the marker.	Number	optional
Label position	`position`	Label position relative to the marker. May be left, right, top, or bottom. Default Default is "right".	Unknown	optional
Label background color	`background`	A background color for the label. Default The label has no background color; the text appears directly on top of the map. Example "white"	Unknown	optional
Marker image	`mark`	The name of an image to display as the mark. See examples at Commons:Location markers and Commons:Category:Map icons. Default The default is Red pog.svg, a red spot. Example Cyan pog.svg	File	optional
Marker image size	`marksize`	The size, in pixels, of the marker image. Specify as "10", not "10px" Default 8 Example 10	Number	optional
Marker link	`link`	The name of a page to go to when the link is clicked. Do not wrap in [[square brackets]]. Example Yellowstone National Park	Page name	suggested
Latitude (degrees)	`lat_deg`	The location of the marker. If using decimal degrees, do not specify minutes or seconds. If using signed (positive North, negative South) decimal degrees, do not specify direction. Example -10.34	Number	required
Latitude (minutes)	`lat_min`	The location of the marker. If using decimal degrees, do not specify this value.	Number	optional
Latitude (seconds)	`lat_sec`	The location of the marker. If using decimal degrees, do not specify this value.	Number	optional
Latitude (North/South)	`lat_dir`	"N" for North (default), "S" for South. Do not use any other value. If latitude (degrees) uses negative values for South, this value is not needed. Default North.	String	optional
Longitude (degrees)	`lon_deg`	The location of the marker. If using decimal degrees, do not specify minutes or seconds. If using signed (positive East, negative West) decimal degrees, do not specify direction. Example -10.34	Number	required
Longitude (minutes)	`lon_min`	The location of the marker. If using decimal degrees, do not specify this value.	Number	optional
Longitude (seconds)	`lon_sec`	The location of the marker. If using decimal degrees, do not specify this value.	Number	optional
Longitude (East/West)	`lon_dir`	"E" for East (default), "W" for West. Do not use any other value. If latitude (degrees) uses negative values for West, this value is not needed. Default East.	String	optional