មើលកូដរបស់ ទំព័រគំរូ:Infobox map/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

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>. The default width 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. This only works when the geographical coordinates method is used. See [[#Geographical coordinates method|below]].
|-
|<code>label_position</code> || The position of a label with respect to the marker. This works with the "coordinates method described below. 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>lat</code><br/><code>long</code> || Specifies the latitude and longitude of the location when the geographical coordinates method is used. This value must be specified as a [[Decimal degrees|signed decimal degree]]. See [[#Geographical coordinates|below]].
|-
|<code>x</code><br/><code>y</code> || Specifies the position of the location marker when the X,Y method for map display is used. 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 [[#X,Y coordinate method|below]].
|}

== Map display methods ==
Any image of a map showing the location of the protected area can be used. There are two methods which can display a location mark to on a map.

=== Geographical coordinates method ===
A marker can be superimposed if one of a set of special map templates are used. If a valid map name from one of these templates is supplied the template will attempt to use this method. To display a marker, the geographic coordinates must be supplied using the parameters <code>lat</code>, and <code>long</code>. The marker will not be displayed if the {{tl|coord}} template is used. See the documentation for {{tl|Location map}}. The parameters for this template map to a subset of the parameters for Location map.

A tool which generates lists of maps can be found [[Special:PrefixIndex/Template:Location_map|here]]. All of the names begin with the words "Location map" followed by the area covered. The value you need to assign to the parameter, <code>map</code>, is the area name. The map template for the for Alberta, Canada is [[Template:Location map Canada Alberta|Location map Canada Alberta]]. In this case specify <code>map=Canada Alberta</code>. For example:

{{Infobox
| above = Dry Island Buffalo Jump Provincial Park
| image2 = {{Infobox map
           | map         = Canada Alberta
           | map_alt     = Located in south central Alberta, which is in western Canada.
           | map_caption = Location of Dry Island Buffalo Jump in Alberta, Canada
           | map_width   = 200
           | label       = Dry Island Buffalo Jump
           | lat         = 51.9438889
           | long        = -112.9636110
           }}
}}

<pre style="overflow:auto; font-size: 90%;">
{{Infobox
| above = Dry Island Buffalo Jump Provincial Park
| image2 = {{Infobox map
           | map         = Canada Alberta
           | map_alt     = Located in south central Alberta, which is in western Canada.
           | map_caption = Location of Dry Island Buffalo Jump in Alberta, Canada
           | map_width   = 200
           | label       = Dry Island Buffalo Jump
           | lat         = 51.9438889
           | long        = -112.9636110
           }}
}}</pre>

The label is optional. By default it is usually displayed to the left of the mark.
{{clear}}
Many of the maps for large areas in this set of templates use [[equirectangular projection]]. Large scale maps, using this projection, look different than those with which most are familiar. However, there are some large area maps that that use a familiar [[map projection]]. A list of some of the map templates that do not use equirectangular projection can be found [[Template:Infobox protected area/large area maps|here]].

<div style="overflow:auto">
{| style="background-color: transparent;" align="center"
|+ '''Three examples of maps of the United States'''
|-
| style="text-align:center" | '''[[:Template:Location map USA|USA]]'''<br/>Equirectangular projection
| style="text-align:center" | '''[[:Template:Location map USA2|USA2]]'''<br/>Equidistant conic projection
| style="text-align:center" | '''[[:Template:Location map USA relief|USA relief]]'''<br/>Equidistant conic projection using shaded relief
|- valign=top
| [[File:USA location map.svg|300px]]
| [[File:Usa edcp location map.svg|300px]]
| [[File:Usa edcp relief location map.png|300px]]
|}
</div>
{{clear}}
=== X,Y coordinate method ===
The values to assign to the x and y parameters are determined using a map image with a width of 1000 [[pixel]]s. Using the upper left hand corner as the origin determine the pixel coordinates for the mark. Probably the easiest way is to download the file to your computer and use [[graphics software]] to scale the image. Two of the many programs that can perform this task are [[GIMP]] and [[XnView]]; both are [[freeware]]. This template scales these values so that the mark will appear in the proper location on a map image of any size.

:<code>x</code> is the pixel offset of the mark from the left edge of the map image based on a image 1000px wide.
:<code>y</code> is the pixel offset of the mark from the top edge of the map image based on a image 1000px wide.

Any size map image can be displayed by setting <code>map_width</code> to a different value.

{{Infobox
| above = Old Faithful
| image2 = {{Infobox map
           | map         = Old Faithful area.png
           | map_alt     = Map shows Old faithful is near other geysers, a visitor center and lodging.
           | map_caption =
           | map_width   = 200
           | x           = 679
           | y           = 630
           }}
}}

<pre style="overflow:auto; font-size: 90%;">
{{Infobox
| above = Old Faithful
| image2 = {{Infobox map
           | map         = Old Faithful area.png
           | map_alt     = Map shows Old faithful is near other geysers, a visitor center and lodging.
           | map_caption =
           | map_width   = 200
           | x           = 679
           | y           = 630
           }}
}}</pre>

Old Faithful is located at <code>x=679</code> pixels from the left of the map image 1000 pixels wide and <code>y=630</code> pixels from the top. You can experiment by pasting this example code into a [[Wikipedia:Sandbox|sandbox]] and substituting your own values.

Note that the mark will be centered over the location and that this differs from the output generated by {{tl|Superimpose}}.
{{clear}}
===Compatibility method===
This method exists for backwards compatibility when updating older templates. The parameters are <tt>pixel_x</tt> and <tt>pixel_y</tt> and correspond to the <tt>x</tt> and <tt>y</tt> parameters of the template Superimpose. These values should be derived using and image with the same dimensions as the image to be displayed in the infobox. See the {{tl|Superimpose}} for additional details. Using a map image of the size to be displayed:

:<tt>pixel_x</tt> is the pixel offset for the left edge of the marker image from the left edge of the map image.
:<tt>pixel_y</tt> is the pixel offset for the top edge of the marker image from the top edge of the map image.

The origin of the marker image will be displayed at the coordinates specified. To center the marker subtract half the width of the marker from <tt>pixel_x</tt> and half the height of the marker from <tt>pixel_y</tt>.

This method is not recommend. Changing the size of the map image without adjusting the marker coordinates will generate unintended output.

===Display any map image===
A third option allows the display of any map image without a location mark being added.

{{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 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>

==Marks==
A mark can be any image file. The default mark is [[:File:Red pog.svg|Red pog.svg]] and it works well because it is easy to pick up visually on most maps. Some examples are below. Click on an image to see the file description page.

{| style="background-color:transparent;"
| style="padding:8px;" | [[File:Red pog.svg|30px]]
| style="padding:8px;" | [[File:Blue pog.svg|30px]]
| style="padding:8px;" | [[File:Cyan pog.svg|30px]]
| style="padding:8px;" | [[File:DeepPink pog.svg|30px]]
| style="padding:8px;" | [[File:Gold pog.svg|30px]]
| style="padding:8px;" | [[File:Green pog.svg|30px]]
| style="padding:8px;" | [[File:Lightgreen pog.svg|30px]]
| style="padding:8px;" | [[File:Orange pog.svg|30px]]
| style="padding:8px;" | [[File:Pink pog.svg|30px]]
| style="padding:8px;" | [[File:Purple pog.svg|30px]]
| style="padding:8px;" | [[File:SpringGreen pog.svg|30px]]
| style="padding:8px;" | [[File:Steel pog.svg|30px]]
| style="padding:8px;" | [[File:Turquoise pog.svg|30px]]
| style="padding:8px;" | [[File:White pog.svg|30px]]
|}

See [[commons:Location markers|Location markers]] for other examples. Currently, using <code>mark_width=n</code> for an n > 8 is not advised when using the "geographical coordinates method" with a label.

==Geographical coordinates==
The template {{tl|decdeg}} can be used to allow additional parameters for the entry of geographical coordinates. The template can be used with or without named parameters. If the unnamed option is used all parameter must be supplied but they can be void. The following markup can be used to allow the template user to enter coordinates. These parameters names are recommended by [[Wikipedia:WikiProject Geographical coordinates#Creating new templates|WikiProject Geographical coordinates]].

<pre style="overflow:auto; font-size: 90%; width: 50em;">
| lat  = {{decdeg|{{{lat_d|}}}|{{{lat_m|}}}|{{{lat_s|}}}|{{{lat_NS|}}} }}
| long = {{decdeg|{{{long_d|}}}|{{{long_m|}}}|{{{long_s|}}}|{{{long_EW|}}} }}</pre>

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]].

== See also ==
* {{tl|Location map}}
* {{tl|Superimpose}}

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->

</includeonly>