View source for Template:Location map+/doc

{{Documentation subpage}}
{{high-use| 15079 }}
{{Lua|{{#ifeq:{{BASEPAGENAME}}|Location map~|Module:Location map|Module:Location map/multi}}}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

{{Location map+|England|width=300|AlternativeMap=England_locator_map_with_North_East_England_highlighted.svg|alt=Map of England showing the locations of towns and battles. Bosworth is in the centre, northwest of London.|float=right|caption=[[File:Battle icon active (crossed swords).svg|16px|link=]] [[Battle of Bosworth Field]] [[File:Battle icon (crossed swords).svg|14px|link=]] other battles |places=
  {{Location map~ |England |label='''[[Battle of Bosworth Field|Bosworth]]'''  |position=right |lat=52.591265 |long=-1.410327 |mark=Battle_icon_active_(crossed_swords).svg |marksize=18 |link=Battle of Bosworth Field}}
  {{Location map~ |England |label=[[Battle of Blore Heath|Blore Heath]]  |position=top |lat=52.913611 |long=-2.424722 |mark=Battle_icon_(crossed_swords).svg |marksize=16 |link=Battle of Blore Heath}}
  {{Location map~ |England |label=[[Battle of Barnet|Barnet]]  |position=top |lat=51.662233 |long=-0.200039 |mark=Battle_icon_(crossed_swords).svg |marksize=16 |link=Battle of Barnet}}
  {{Location map~ |England |label=[[Battle of Stoke Field|East Stoke]]  |position=top |lat=53.029058 |long=-0.892586 |mark=Battle_icon_(crossed_swords).svg |marksize=16 |link=Battle of Stoke Field}}
  {{Location map~ |England |label=[[Battle of Tewkesbury|Tewkesbury]]  |position=top |lat=51.986389 |long=-2.161389 |mark=Battle_icon_(crossed_swords).svg |marksize=16 |link=Battle of Tewkesbury}}
  {{Location map~ |England |label=Berwick  |position=bottom |lat=55.771 |long=-2.007 |mark=Steel pog.svg |marksize=6}}
  {{Location map~ |England |label=London  |position=bottom |lat=51.507778 |long=-0.128056 |mark=Steel pog.svg |marksize=6}}
  {{Location map~ |England |label=York  |position=bottom |lat=53.958333 |long=-1.096667 |mark=Steel pog.svg |marksize=6}}
  {{Location map~ |England |label=Plymouth  |position=bottom |lat=50.371397 |long=-4.142431 |mark=Steel pog.svg |marksize=6}}
  {{Location map~ |England |label=Poole  |position=bottom |lat=50.71942 |long=-1.98113 |mark=Steel pog.svg |marksize=6}}
  {{Location map~ |England |label=Wem  |position=left |lat=52.8555 |long=-2.7211 |mark=Steel pog.svg |marksize=6}}
  {{Location map~ |England |label=Northumberland  |position=right |lat=55.1 |long=-1.68 |mark=Steel pog.svg |marksize=1}}
  {{Location map~ |England |label=Shrewsbury  |position=bottom |lat=52.7077 |long=-2.7541 |mark=Steel pog.svg |marksize=6}}
  {{Location map~ |England |label=Milford Haven  |position=bottom |lat=51.71418 |long=-5.04274 |mark=Steel pog.svg |marksize=6}}
}}

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

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

{| class="wikitable"
! rowspan=2 | Main template (one per map) !! colspan=3 | Helper template (one per location to be marked)
|-
! colspan=3 | Multi-line style
|- style="vertical-align:top"
| rowspan=4 | <syntaxhighlight lang="wikitext" style="width:14em; margin-right:2em;">
{{Location map+
| {{{1}}}
| width          =
| float          =
| border         =
| caption        =
| alt            =
| maplink        =
| relief         =
| AlternativeMap =
| overlay_image  =
| places         =
}}</syntaxhighlight>
|- style="vertical-align:top"
|<syntaxhighlight lang="wikitext" style="width:12em;">
{{Location map~
| {{{1}}}
| label       =
| label_size  =
| label_width =
| position    =
| background  =
| mark        =
| marksize    =
| link        =
| lat_deg     =
| lon_deg     =
}}</syntaxhighlight>
|<syntaxhighlight lang="wikitext" style="width:12em;">
{{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     =
}}</syntaxhighlight>
|<syntaxhighlight lang="wikitext" style="width:12em;">
{{Location map~
| {{{1}}}
| label       =
| label_size  =
| label_width =
| position    =
| background  =
| mark        =
| marksize    =
| link        =
| coordinates =
}}</syntaxhighlight>
|- style="vertical-align:top"
! colspan=3 | Single-line style
|- style="vertical-align:top"
| colspan=3 |<!--
--><syntaxhighlight lang="wikitext">{{Location map~ |{{{1}}} |label_size= |label_width= |background= |marksize= |mark= |lat_deg= |lon_deg= |position= |label= |link=}}</syntaxhighlight>
<!--
--><syntaxhighlight lang="wikitext">{{Location map~ |{{{1}}} |label_size= |label_width= |background= |marksize= |mark=  |lat_deg= |lat_min= |lat_sec= |lat_dir= |lon_deg= |lon_min= |lon_sec= |lon_dir= |position= |label= |link=}}</syntaxhighlight><!--
--><syntaxhighlight lang="wikitext">{{Location map~ |{{{1}}} |label_size= |label_width= |background= |marksize= |mark= |coordinates= |position= |label= |link=}}</syntaxhighlight>
'''Note''': in single-line style, parameters order is chosen so that it's easier to maintain vertical alignment in subsequent {{t|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 [[#single-line Location map~|example]] below (note the alignment of {{para|marksize}} and {{para|position}} parameters in the wiki mark-up).
|}

{{clear}}

== Parameters ==
{| class="wikitable" style="width:100%;"
|+ Parameters for Location map+
! Parameter
! Description
|-
| <code>{{{1}}}</code>
| 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 {{tld|Location map England}} otherwise. See the [[#Examples|examples]] below or [[Special:PrefixIndex/Module:Location_map/data/|all subpages]].
|-
| <code>width</code>
| Determines the width of the map in [[pixel]]s, overriding any default values. Do not include <code>px</code>: for example, use <code>width=300</code>, not <code>width=300px</code>.
|-
| <code>default_width</code>
| 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 <code>px</code>. This value will be multiplied by the <code>defaultscale</code> parameter specified in individual map templates, if it exists, in order to achieve an appropriate size for vertical maps. For example, if <code>default_width=200</code> is given, a map of Thailand will be displayed with a width of 200×0.57&nbsp;= 114&nbsp;pixels (as specified in [[Module:Location map/data/Thailand]]).
|-
| <code>float</code>
| Specifies the position of the map on the page. Valid values are <code>left</code>, <code>right</code>, <code>center</code> and <code>none</code>. The default is <code>right</code>.
|-
| <code>border</code>
|  Specifies the color of the 1px map border. The default is ''lightgrey'' (see [[web colors]]). If set to <code>none</code>, no border will be generated. This parameter is seldom used. Special value: {{code|infobox}}.
|-
| <code>caption</code>
| 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 <code>caption</code> is defined but is not assigned a value, the map will not be framed and no caption will be displayed. If <code>caption</code> is not defined, the map will not be framed and a default caption will be generated. The default caption is created from the <code>label</code> parameter (or the current page name if label not defined) and the <code>name</code> parameter from map definition template. See the [[#Examples|examples]] below.
|-
| <code>alt</code>
| Alt text for map; used by [[screen reader]]s, see [[WP:ALT]].
|-
| <code>maplink</code>
| Specifies a [[Wiki markup|wiki link]] that will be followed when clicking the map, by default to the map source file. Can be deactivated with <code>maplink =</code>, which can be useful to avoid mis-clicks if there are links associated with markers and labels.
|-
| <code>relief</code>
| Any non-blank value (1, yes, etc.) will cause the template to display the map specified in the map definition template as <code>image1</code>, which is usually a [[Relief mapping (computer graphics)|relief map]]. See the example at [[Template:Location map+/relief|Location map+/relief]].  Other numerical values such as {{code|2}} or {{code|3}} will display {{code|image2}} or {{code|image3}}, if those images are defined.
|-
| <code>AlternativeMap</code>
| Allows the use of an alternative map. The image must have the same edge coordinates as the location map template. See the example at [[Template:Location map+/AlternativeMap|Location map+/AlternativeMap]].
|-
| <code>overlay_image</code>
| Allows an overlay to be superimposed on the map. This parameter is seldom used. See the example at [[Template:Location map+/overlay|Location map+/overlay]].
|-
| <code>places</code>
| Specifies one or more place markers using {{tl|Location map~}}.
|}

{| class="wikitable" style="width:100%;"
|+ Parameters for Location map~
! Parameter
! colspan="2" |Description
|-
| <code>{{{1}}}</code>
| colspan="2" |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 {{tld|Location map England}} otherwise. See the [[#Examples|examples]] below.
|-
| colspan="3" |'''Label'''
|-
| <code>label</code>
| colspan="2" |The text of the label to display next to the mark. A [[Wiki markup|wiki link]] can be used. The default if not specified is no label, just the marker. {{red|Do not use {{tag|div}} tags to attempt to position the label; use {{para|label_size}} and {{para|position}} instead.}}
|-
| <code>label_size</code>
| colspan="2" |The font size to use for the label, given as a percentage of the label's (already reduced) normal font size (<100&nbsp;= smaller, >100&nbsp;= larger). The default is 91; obey [[MOS:FONTSIZE]] if setting to a lower value. Do not include <code>%</code>: for example, use <code>label_size=95</code>, not <code>label_size=95%</code>. If set to&nbsp;0, the label is displayed only when the user hovers over the mark.
|-
| <code>label_width</code>
| colspan="2" |The width to use for the label, given as an [[Em (typography)#CSS|em&nbsp;size]]; the default width is&nbsp;6. Do not include {{kbd|em}}: for example, use {{para|label_width|7}}, not {{para|label_width|7em}}.
|-
| <code>position</code>
| colspan="2" |The position of the label relative to the mark. Valid values are <code>left</code>, <code>right</code>, <code>top</code> and <code>bottom</code>. The default is <code>right</code>.
|-
| <code>background</code>
| colspan="2" |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.
|-
| colspan="3" |'''Mark'''
|-
| <code>mark</code>
| colspan="2" |The name of an image to display as the mark. The default is [[:File:Red pog.svg|Red pog.svg]] ([[File:Red pog.svg|8px]]). More mark images are available, in particular, at [[Commons:Location markers]] and [[Commons:Category:Map icons]].
|-
| <code>marksize</code>
| colspan="2" |The size of the mark in [[pixel]]s. The default is&nbsp;8. Do not include <code>px</code>: for example, use <code>marksize=10</code>, not <code>marksize=10px</code>.
|-
| <code>link</code>
| colspan="2" |Specifies a [[Wiki markup|wiki link]] which will be followed if the reader clicks on the mark. Do not include <code>[[]]</code>: for example, use <code>link=Yellowstone National Park</code>, not <code>link=[&#91;Yellowstone National Park&#93;]</code>.
|-
| colspan="3" |'''Coordinates'''
|-
|<code>lat_deg</code>
| rowspan="2" |Usual
|Required. The degrees of [[latitude]], using [[decimal degrees]]. Logically, use negative number for southern latitude.
|-
|<code>lon_deg</code>
|Required. The degrees of [[longitude]], using decimal degrees. Logically, use negative number for western longitude.
|-
|<code>lat_deg</code>
| rowspan="8" |Detailed
| Required. The degrees of [[latitude]]. The minutes and, probably, the seconds must be specified.<ref group="Note" name="precision" />
|-
| <code>lat_min</code>
| The minutes of latitude.<ref group=Note name="precision" /> The sign should match that of lat_deg.
|-
| <code>lat_sec</code>
| The seconds of latitude. Usually not necessary.<ref group=Note name="precision" /> The sign should match that of lat_deg.
|-
| <code>lat_dir</code>
| N if north (default value) or S for south of the [[Equator]]. Other values will be disregarded.
|-
| <code>lon_deg</code>
| Required. The degrees of [[longitude]]. The minutes and, probably, the seconds must be specified.<ref group=Note name="precision" />
|-
| <code>lon_min</code>
| The minutes of longitude.<ref group=Note name="precision" /> The sign should match that of lon_deg.
|-
| <code>lon_sec</code>
| The seconds of longitude. Usually not necessary.<ref group=Note name="precision" /> The sign should match that of lon_deg.
|-
| <code>lon_dir</code>
| E for east (default value) or W for west of the [[IERS Reference Meridian|Prime Meridian]]. Other values will be disregarded.
|-
|cooordinates
|Alternative
|The coordinates using {{tl|Coord}} template, e.g. <code><nowiki>{{coord|48.067|-2.863}}</nowiki></code>.
|}

Notes:
{{Reflist
| group = Note
| refs =
<ref group=Note name="precision">Appropriate precision should be used. For example, the whole US map, with a 1000{{nbhyph}}pixel width, has a resolution of about 5&nbsp;km/pixel. Only 2 decimal places of precision in decimal degrees format (≈1&nbsp;km), or whole minutes (≈1.7&nbsp;km) in DMS format, are required.</ref>
}}

== 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.
:[[Template:Location map/List|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 <code>caption</code> 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+ | 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}}
  }}
}}
<syntaxhighlight lang="wikitext" style="width:35em;">
{{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}}
  }}
}}
}}</syntaxhighlight>

{{clear}}

{{anchor|single-line Location map~}}This example uses a designated but empty <code>caption</code>. It demonstrates coordinates using [[decimal degrees]], a&nbsp;10px mark with a link, and {{tl|Location map~}} entries listed in single-line style.

{{Location map+ | France
| caption =
| places =
  {{Location map~ |France |marksize=10 |lat_deg=48.8567 |lon_deg=2.3508 |position=top    |label=Paris     |link=Paris    }}
  {{Location map~ |France |marksize= 9 |lat_deg=43.2964 |lon_deg=5.3610 |position=bottom |label=Marseille |link=Marseille}}
}}
<syntaxhighlight lang="wikitext" style="width:75em;">
{{Location map+ | France
| caption =
| places =
  {{Location map~ |France |marksize=10 |lat_deg=48.8567 |lon_deg=2.3508 |position=top    |label=Paris     |link=Paris    }}
  {{Location map~ |France |marksize= 9 |lat_deg=43.2964 |lon_deg=5.3610 |position=bottom |label=Marseille |link=Marseille}}
}}
</syntaxhighlight>
{{clear}}

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

{{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
  }}
}}
<syntaxhighlight lang="wikitext" style="width:35em;">
{{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
  }}
}}
</syntaxhighlight>

Also see the examples for {{tl|Location map}} and {{tl|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 ==
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"description": "This template places one or more location marks on a map.",
	"params": {
		"1": {
			"label": "Map name",
			"type": "string",
			"required": true,
			"description": "The name of the map to be used"
		},
		"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: \"300\", not \"300px\"."
		},
		"default_width": {
			"label": "Default width",
			"type": "number",
			"description": "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."
		},
		"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."
		},
		"border": {
			"label": "Frame style",
			"type": "string",
			"description": "Specifies the color of the map frame when the parameter caption is used. If set to none, no border will be generated. ",
			"suggestedvalues": [
				"none",
				"infobox",
				"LightGray"
			]
		},
		"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. If more than one relief map is defined, \"2\" will display \"image2\", and so on."
		},
		"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 map template."
		},
		"overlay_image": {
			"label": "Overlay image",
			"type": "string",
			"description": "Allows an overlay to be superimposed on the map. This parameter is seldom used."
		},
		"places": {
			"label": "Place markers",
			"type": "string",
			"required": true,
			"description": "Specifies one or more place markers using Location map~."
		}
	}
}

</templatedata>
{{Collapse bottom}}

== See also ==
* [[Wikipedia:Maps for Wikipedia]] - A list of mapping tools available on Wikipedia
* {{tl|Location map}} - For displaying one mark using latitude and longitude.
* {{tl|Location map many}} - For displaying multiple marks using latitude and longitude.
* [[:Commons:Category:Map pointers]] - List of the many Wikimedia Commons pointer symbols.
* {{tl|OSM Location map}} - OpenStreetMap map with an "interactive fullscreen" version. Allows for labels, numbered dots, a heading, caption, mini-locator map and overlays.
* {{tl|Overlay}} - Allows image numbered, textual number, or color tag overlays to be positioned over an image to indicate particular features in the image.
* {{tl|CSS crop}} - Wrapper template that allows cropping the map.

<includeonly>{{Sandbox other|
| <!--Categories below this line, please; interwikis at Wikidata-->
[[Category:Location map templates| ]]
[[Category:Graphics templates]]

}}</includeonly>