Изворни код странице Шаблон:Infobox map/док

{{Documentation subpage}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{ombox
| type = content
| text = This template will generate an error message and garbage if it is transcluded with {{param|map}} undefined. This reduces [[m:Help:Expansion depth|expansion depth]] which is critical in many infoboxes that transclude this template.
}}
{{ombox
| type = notice
| text = The parameters {{param|label_x}} and {{param|label_y}} are deprecated. They will remain functional for a time.
}}

This [[Help:Templates/Helper templates|helper template]] provides a way to display a map in an [[Wikipedia:WikiProject Infoboxes|Infobox]]. Optionally a location marker can be included.

==Usage==

===Parameter descriptions===
{| class="wikitable" style="width: 97%;"
! style="width: 14%" | Field name || Description
|-
|<code>map</code> || The name of the map to be displayed. This is the only required parameter.
|-
|<code>map_width</code> || The width of the map image to be displayed. For example, <code>map_width=220</code> and not <code>map_width=220px</code>.
|-
|<code>default_width</code> || When this template is used in another template, e.g. an infobox, the default width of the map image preferred by the infobox should be specified here. For example, <code>map_width=220</code>. When used with location maps, this value may be modified by a certain value if specified in the location map template. The default value is 220px.
|-
|<code>relief</code> || Selects a relief map when assigned any value. This only works when the geographical coordinates method is used and then only for a few maps. See [[#Map display methods|Map display methods]].
|-
|<code>map_alt</code> || Alt text for the map. A visually impaired reader who uses a [[screen reader]] will have access to this text. See [[WP:ALT]].
|-
|<code>map_caption</code> || The caption that appears below the map if one is required.
|-
|<code>mark</code> || The image file that will be used to mark the location on the map. The default is [[:file:Red pog.svg|Red pog.svg]]. See [[#Marks|below]].
|-
|<code>mark_width</code> || The width of the marker image to be displayed. For example, <code>mark_width=8</code> and not <code>mark_width=8px</code>. The default width is 8px.
|-
|<code>label</code> || A text message that will be displayed next to the marker.
|-
|<code>label_position</code> || The position of a label with respect to the marker. Valid values are <code>left</code>, <code>right</code>, <code>top</code>, <code>bottom</code> and <code>none</code>.
|-
|<code>background</code> || The background color for the label. If no value is assigned the background will be transparent. See [[Web colors]].
|-
|<code>coordinates</code> || The coordinates of the location in {{tl|Coord}} format. <small>While ''not'' recommended, if you want to waste time you can also enter them in decimal degrees (e.g. <code>48.067°N 12.863°E</code>). You shouldn't need to, though.</small>
|-
|<code>lat</code><br/><code>long</code> || Specifies the latitude and longitude of the location when the geographical coordinates method is used. This value may be specified as a [[Decimal degrees|signed decimal degree]].
|-
|<code>lat_deg</code><br/><code>lat_min</code><br/><code>lat_sec</code><br/><code>lat_dir</code><br/>
<code>lon_deg</code><br/><code>lon_min</code><br/><code>lon_sec</code><br/><code>lon_dir</code><br/>
|Specifies the latitude and longitude of the location when the geographical coordinates method is used. This value may be specified in dms+hemisphere format.
|-
|<code>x</code><br/><code>y</code> || Specifies the position of the location marker. The coordinates of the marker in [[pixel]]s based on a map width of 1000 pixels. The template will scale these values for proper display. See [[#Display a marker on any map image using the x and y parameters|below]].
|-
|<code>x%</code><br/><code>y%</code> || Specifies the position of the location marker. <code>x%</code> specifies the percentage of the distance across the image from the left edge and <code>y%</code> specifies the percentage of the distance down from the top edge. See [[#Display a marker on any map image using the x% and y% parameters|below]].
|}

== Map display methods ==
There are three methods which can display a mark on a map. These examples use {{tl|Infobox park}} which uses this template as a back end.
{{Infobox map/Map display methods|converted=1}}

===Legacy parameters===
Although [[Help:Coordinates in infoboxes|deprecated in infoboxes in August 2016]], it is still possible in this template to use the {{para|lat_d}}, {{para|lat_m}}, {{para|lat_s}}, {{para|lat_NS}}, {{para|long_d}}, {{para|long_m}}, {{para|long_s}} and {{para|long_NS}} parameters (for latitude degrees, minutes, seconds and direction; and longitude degrees, minutes, seconds and direction respectively).

===Display any image===
An image ''can'' be displayed without a location mark, but this is rather pointless in most cases because a normal infobox image parameter can usually be used instead.

{{Infobox
| above  = Average regional brazil nut output (kg/ha)
| image2 = {{Infobox map
           | map         = Braziloutput.png
           | map_alt     = A world map showing regions that produce Brazil nuts.
           | map_caption =
           | map_width   = 200
           }}
}}

<pre style="overflow:auto; font-size: 90%;">
{{Infobox
| above =
| image2 = {{Infobox map
           | map         = Braziloutput.png
           | map_alt     = A world map showing regions that produce Brazil nuts.
           | map_caption =
           | map_width   = 200
           }}
}}</pre>

{{Infobox map/marks}}

==Geographical coordinates==
To display coordinates in the Infobox two methods can be used. The template {{tl|Infobox coord}} can be used to display coordinates entered using the method discussed above. If the X,Y method is used to display a marker then the template {{tl|coord}} can be used. For examples of coordinate entry see [[Template:Infobox map/coordinate examples|coordinate examples]].

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"map": {
			"label": "Map",
			"type": "string",
			"required": true,
			"description": "The name of the map to be displayed",
			"aliases": [
				""
			]
		},
		"map_width": {
			"label": "Map Width",
			"type": "number",
			"required": false,
			"description": "The width of the map image to be displayed."
		},
		"default_width": {
			"label": "Default Width",
			"type": "number",
			"required": false,
			"description": "When this template is used in another template, the default width is given using this parameter"
		},
		"relief": {
			"label": "Relief",
			"type": "string",
			"required": false,
			"description": "Selects a relief map when assigned any value"
		},
		"map_alt": {
			"label": "Map Alternative Text",
			"type": "string",
			"required": false,
			"description": "Alternative text to be displayed if the map isnt displayed for whatever reasons"
		},
		"map_caption": {
			"label": "Map Caption",
			"type": "string",
			"required": false,
			"description": "Caption for the map"
		},
		"mark": {
			"label": "Mark",
			"type": "wiki-page-name",
			"required": false,
			"description": "The image file that will be used to mark the location on the map"
		},
		"mark_width": {
			"label": "Mark Width",
			"type": "number",
			"required": false,
			"description": "The width of the marker image to be displayed"
		},
		"label": {
			"label": "Label",
			"type": "string",
			"required": false,
			"description": "A text message that will be displayed next to the marker."
		},
		"label_position": {
			"label": "Label Position",
			"type": "string",
			"required": false,
			"description": "The position of a label with respect to the marker"
		},
		"lat": {
			"label": "Latitude",
			"type": "number",
			"required": false,
			"description": "Latitude of the map"
		},
		"long": {
			"label": "Longitude",
			"type": "number",
			"required": false,
			"description": "Longitude of the map"
		},
		"x": {
			"label": "X",
			"type": "number",
			"required": false,
			"description": "Specifies the position of x location marker"
		},
		"y": {
			"label": "Y",
			"type": "number",
			"required": false,
			"description": "Specifies the position of y location marker"
		},
		"x%": {
			"label": "X%",
			"type": "number",
			"required": false,
			"description": "x% specifies the percentage of the distance across the image from the left edge"
		},
		"y%": {
			"label": "Y%",
			"type": "number",
			"required": false,
			"description": "y% specifies the percentage of the distance down from the top edge"
		}
	},
	"format": "block"
}
</templatedata>

== See also ==
* {{tl|Location map}}
* {{tl|Superimpose}}
* [[:Category:Pages using Template:Infobox map needing attention]] (hidden tracking/maintenance category)

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Geography infobox subtemplates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>