Mahan: ۱ نسخه واردشده

2017-12-26T14:25:43Z

۱ نسخه واردشده

→ نسخهٔ قدیمی‌تر		نسخهٔ ‏۲۶ دسامبر ۲۰۱۷، ساعت ۱۶:۲۵
(بدون تفاوت)

Mahan در ‏۶ مهٔ ۲۰۱۴، ساعت ۰۷:۱۵

2014-05-06T07:15:38Z

صفحهٔ تازه

{{Documentation subpage}}

{{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 [[Iranpedia: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 [[IP: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>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. 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 to on a map. These examples use {{tl|Infobox park}} which uses this template as a back end.
{{Infobox map/Map display methods}}

===Display any image===
Another option allows the display of any image without a location mark.

{{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==
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 parameters 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 [[Iranpedia: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]].

==TemplateData==
<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": "string/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"
}
}
}
</templatedata>

== جستارهای وابسته ==
* {{الگو|روی نقشه}}
* {{الگو|Superimpose}}

<includeonly>


</includeonly>

الگو:جعبه اطلاعات نقشه/توضیحات - تاریخچهٔ نسخه‌ها

Mahan: ۱ نسخه واردشده

Mahan در ‏۶ مهٔ ۲۰۱۴، ساعت ۰۷:۱۵