ਫਰਮਾ:Mapbox/doc ਲਈ ਸਰੋਤ ਵੇਖੋ

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Uses Wikidata|P625}}
{{Sister project
|image=[[File:Openstreetmap logo.svg|40x40px]]
|text=This template uses the [[OpenStreetMap]] tag:
*'''''[https://wiki.openstreetmap.org/wiki/Key:wikidata wikidata]''''' (see [https://wiki.openstreetmap.org/wiki/Talk:Key:wikidata talk]; [https://taginfo.openstreetmap.org/keys/wikidata taginfo])
}}
This template adds a box to the right of the page, which includes a link to an interactive full-screen OpenStreetMap map that displays additional data – either from:
*data stored in GeoJSON format on Commons;
*line/polygon features in OpenStreetMap;
*coordinates, either supplied or from Wikidata;
*raw GeoJSON, preferably transcluded from another page.

Note:
*GeoJSON files cannot currently be directly uploaded. Instead, on [[c:|Commons]], create a page that is in the <code>Data:</code> namespace and ends in <code>.map</code> – see [[mw:Help:Map Data]] for further information.
*To make OpenStreetMap (OSM) features available, add the Wikidata key to the OSM relation (and wait 1 or 2 days) – see [[mw:Help:Extension:Kartographer#External_data]] and [[mw:Help:Extension:Kartographer/OSM]] for further information.

==Usage==
<nowiki>{{Mapbox}}</nowiki> utilises [[Template:Maplink]]. As a result, usage of the two templates is very similar.

{| class="wikitable"
|+Basic usage
|-
! Type !! Code !! Notes !! Example
|-
|Data page on Commons || <code><nowiki>{{mapbox|from=}}</nowiki></code> || specify .map data page in <code>from=</code>, excluding the Data prefix || {{mapbox|from=ecos.fws.gov/Endangered habitat 58938/Plethodon neomexicanus.map|text=Data page example}}
|-
|Raw GeoJSON data || <code><nowiki>{{mapbox|raw=}}</nowiki></code> || e.g. <nowiki>{{</nowiki>[[Wikipedia:Map data/Main Roads Western Australia/Forrest Highway]]<nowiki>}}</nowiki> || {{mapbox|raw={{Wikipedia:Map data/Main Roads Western Australia/Forrest Highway}}|text=Raw GeoJSON data}}
|-
| Line of a border or a linear feature from OSM || <code><nowiki>{{mapbox|type=line|id=}}</nowiki></code> || <code>id=</code> only required if the Wikidata item isn't linked to the current page || {{mapbox|type=line|id=Q1094308|text=Line example}}
|-
| Shape from OSM || <code><nowiki>{{mapbox|type=shape|id=}}</nowiki></code> || <code>id=</code> only required if the Wikidata item isn't linked to the current page || {{mapbox|type=shape|id=Q1094308|text=Shape example}}
|-
| Inverted shape from OSM || <code><nowiki>{{mapbox|type=shape-inverse|id=}}</nowiki></code> || <code>id=</code> only required if the Wikidata item isn't linked to the current page || {{mapbox|type=shape-inverse|id=Q1094308|text=Inverted shape example}}
|-
| Point feature from Wikidata coordinates || <code><nowiki>{{mapbox|type=point|id=}}</nowiki></code> || <code>id=</code> only required if the Wikidata item isn't linked to the current page || {{mapbox|type=point|id=Q1094308|text=Point example (Wikidata)}}
|-
| Point feature from specified coordinates  || <code><nowiki>{{mapbox|type=point|coord=}}</nowiki></code> || Use {{tl|Coord}} template to specify coordinates || {{mapbox|type=point|coord={{coord|-15.695|17.460}}|text=Point example (specified)}}
|}

Full parameter set – data page
<pre>
{{mapbox
|from=
|zoom=
|text=
|text-left=
|above=
|below=
}}
</pre>

Full parameter set – raw data
<pre>
{{mapbox
|raw= <!-- preferably {{Wikipedia:Map data/subpage}} -->
|zoom=
|text=
|text-left=
|above=
|below=
}}
</pre>

Full parameter set – OSM features
<pre>
{{mapbox
|type=
|id=
|title=
|description=
|stroke-color=
|stroke-width=
|zoom=
|text=
|text-left=
|above=
|below=
}}
</pre>

Full parameter set – point features/coordinates
<pre>
{{mapbox
|type=point
|id=
|title=
|description=
|coord=
|marker=
|zoom=
|text=
|text-left=
|above=
|below=
}}
</pre>

===Multiple links===
Up to five links can be included within the one box by adding "2", "3", "4" or "5" to the end of the parameter name - e.g.<code>data2</code> or <code>description2</code>. All parameters support this except for <code>above</code>, <code>below</code> and <code>text-left</code>. Unlike the first link (where it is optional), the <code>text</code> parameter is required for links 2-5.

==Parameters==
===Parameters affecting the maps===
;type
:Type of data. Valid values are:
::<code>line</code> – a geoline feature from OSM (e.g. a road)
::<code>shape</code> – a geoshape feature from OSM (e.g. a state or province)
::<code>shape-inverse</code> – a geomask feature from OSM (the inverse of a geoshape - allows an unobstructed view of the map beneath)
::<code>data</code> – a geoJSON data page on Commons (parameter is optional in this case)
::<code>point</code> – a point feature (coordinates)
;id
:''(or '''ids''')''
:Wikidata id (Q-number) that the OSM feature is tagged with. Separate multiple ids with a comma. Defaults to the current page's Wikidata id (if {{para|from}} not set).
;from
:The JSON (.map) file from Commons to display (excluding the <code>Data:</code> prefix)
;raw
:raw GeoJSON (preferably transcluded from a subpage of [[Wikipedia:Map data]]) as well as <nowiki><maplink></nowiki> functionality not available via the other parameters. [[#When to use the raw parameter|See below]] for more information.
;title
:Title of the feature (for features from OSM), displayed when the feature is clicked on; default is the page title
;description
:Description of the feature (for features from OSM), displayed when the feature is clicked on; optional
;coord
:Coordinates to display for a point feature. Use {{tl|Coord}} template to specify coordinates. If not set, coordinates will be retrieved from Wikidata.
;marker
:Name of Maki marker image to display at the point feature. See [[mw:Maps/Icons]] for options. Defaults to <code>marker</code> (plain marker) if not set.<!--
;marker-color
:''(or '''marker-colour''')''
:Colour code ([[Web colors#Hex triplet|Hex triplet]]) specifying marker background colour. Default is <code>#5E74F3</code> ({{Color box|#5E74F3}})-->
;stroke-color
:''(or '''stroke-colour''')''
:Colour code for the colour used to draw the feature (for features from OSM); default is <code>#555555</code> ({{Color box|#555555}})
;stroke-width
:Width for the lines used to draw the feature (for features from OSM); default is <code>5</code>
;zoom
:Zoom level, from <code>1</code> to <code>19</code> (larger numbers zoom in further); will be automatically determined if not set

===Parameters affecting the box===
;above
:Content (such as explanatory text) appearing above the links
;below
:Content (such as explanatory text) appearing below the links
;text
:Text to display for the link; default is "View map"
;text-left
:Set this to <code>yes</code> to change the link text from centre-aligned to left-aligned

== When to use the raw parameter ==
The "raw" parameter allows the same inputs as the full <nowiki><maplink></nowiki> function. It allows you to:
*Use GeoJSON data directly
*Use a combination of data sources together (direct GeoJSON, external data from Wikimedia Commons and external data from OpenStreetMap) 
*Have more options for directly styling data (data from Commons will inherit the styling specified in the .map page)
*Include multiple pieces of external data from Wikimedia Commons
*Use Wikidata queries to obtain information for the map
*Use templates - if a map includes direct GeoJSON or many components, placing the data in a template will avoid cluttering the article text

==Gotchas==
*When retrieving lines or shapes from OSM, you can't style the fill colour or the opacity level of fills or strokes (unless you use the {{para|raw}} parameter).
*The following code utilising the {{para|raw}} parameter won't work because the curly brace to close the GeoJSON is adjacent to the curly braces to close the template:
<pre>{{Mapbox|raw= {"type": "ExternalData","service": "geoshape","ids": "Q13518258"}}}</pre>
:To fix it, put a space before the two template braces or move them to a separate line.
*{{tl|Maplink}}'s multiple features functionality doesn't work; use {{para|raw}} instead.

== See also ==
*[[Wikipedia:Maps for Wikipedia]], a list of mapping tools available on Wikipedia
*[[Template:Attached KML]]

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Coordinates templates]]
[[Category:Map templates]]
}}</includeonly>
<templatedata>
{
	"params": {
		"above": {
			"label": "Above",
			"description": "    Content (such as explanatory text) appearing above the links",
			"type": "string"
		},
		"below": {
			"label": "Below",
			"description": "Content (such as explanatory text) appearing below the links",
			"type": "string"
		},
		"text-left": {
			"label": "Left-align text",
			"description": "Set this to \"yes\" to change the link text from centre-aligned to left-aligned"
		},
		"type": {
			"label": "Type",
			"description": "Type of data. Valid values are: \"line\" – a geoline feature from OSM (e.g. a road), \"shape\" – a geoshape feature from OSM (e.g. a state or province), \"shape-inverse\" – a geomask feature from OSM (the inverse of a geoshape - allows an unobstructed view of the map beneath), \"data\" – a geoJSON data page on Commons (parameter is optional in this case), \"point\" – a point feature (coordinates)",
			"type": "string",
			"suggested": true
		},
		"id": {
			"aliases": [
				"ids"
			],
			"label": "Wikidata ID",
			"description": "Wikidata ID (Q-number) that the OSM feature is tagged with. Separate multiple IDs with a comma.",
			"type": "string",
			"default": "The current page's Wikidata id (if |from= not set)."
		},
		"from": {
			"label": "From",
			"description": "The JSON (.map) page from Commons to display (excluding the Data: prefix)",
			"example": "Inner West Light Rail.map",
			"suggested": true
		},
		"title": {
			"label": "Title",
			"description": "Title of the feature (for features from OSM), displayed when the feature is clicked on.",
			"type": "string",
			"default": "The title of the page using the template."
		},
		"description": {
			"label": "Description",
			"description": "Description of the feature (for features from OSM), displayed when the feature is clicked on; optional",
			"type": "string"
		},
		"raw": {
			"aliases": [
				"data"
			],
			"label": "Raw data",
			"description": "Raw GeoJSON (preferably transcluded from a subpage of Wikipedia:Map data) as well as <maplink> functionality not available via the other parameters. See the \"When to use the raw parameter\" section of the documentation for more information.",
			"suggested": true
		},
		"stroke-color": {
			"aliases": [
				"stroke-colour"
			],
			"label": "Stroke (line) colour",
			"description": "Colour code for the colour used to draw the feature (for features from OSM).",
			"default": "#555555"
		},
		"stroke-width": {
			"label": "Stroke (line) width",
			"description": "    Width for the lines used to draw the feature (for features from OSM)",
			"type": "number",
			"default": "5"
		},
		"coord": {
			"label": "Coordinates",
			"description": "Coordinates to display for a point feature. Use the {{Coord}} template to specify coordinates.",
			"default": "If not set, coordinates will be retrieved from Wikidata."
		},
		"marker": {
			"label": "Marker icon",
			"description": "Name of Maki marker image to display at the point feature. See https://www.mediawiki.org/wiki/Maps/Icons for options.",
			"default": "No icon"
		},
		"zoom": {
			"label": "Zoom level",
			"description": "Zoom level, from 1 to 19 (larger numbers zoom in further).",
			"type": "number",
			"default": "Automatically calculated."
		},
		"text": {
			"label": "Link text",
			"description": "Text to display for the link.",
			"default": "View map.",
			"type": "string"
		},
		"text2": {
			"label": "Link text (2nd link)",
			"description": "Text to display for the 2nd link; required if including a 2nd link",
			"type": "string"
		},
		"type2": {
			"label": "Type (2nd link)",
			"description": "Type of data for the 2nd link. Valid values are: \"line\" – a geoline feature from OSM (e.g. a road), \"shape\" – a geoshape feature from OSM (e.g. a state or province), \"shape-inverse\" – a geomask feature from OSM (the inverse of a geoshape - allows an unobstructed view of the map beneath), \"data\" – a geoJSON data page on Commons (parameter is optional in this case), \"point\" – a point feature (coordinates).",
			"type": "string"
		},
		"id2": {
			"aliases": [
				"ids2"
			],
			"label": "Wikidata ID (2nd link)",
			"description": "Wikidata ID (Q-number) that the OSM feature is tagged with. Separate multiple IDs with a comma.",
			"type": "string"
		},
		"title2": {
			"label": "Title (2nd link)",
			"description": "Title of the feature used for the 2nd link (for features from OSM), displayed when the feature is clicked on.",
			"type": "string"
		},
		"from2": {
			"label": "From (2nd link)",
			"description": "The JSON (.map) page from Commons to display (excluding the Data: prefix)",
			"example": "Inner West Light Rail.map"
		},
		"description2": {
			"label": "Description (2nd link)",
			"description": "Description of the feature (for features from OSM), displayed when the feature is clicked on; optional",
			"type": "string"
		},
		"raw2": {
			"aliases": [
				"data2"
			],
			"label": "Raw data (2nd link)",
			"description": "Raw GeoJSON for the 2nd link (preferably transcluded from a subpage of Wikipedia:Map data) as well as <maplink> functionality not available via the other parameters. See the \"When to use the raw parameter\" section of the documentation for more information."
		},
		"stroke-color2": {
			"aliases": [
				"stroke-colour2"
			],
			"label": "Stroke (line) colour (2nd link)",
			"description": "Colour code for the colour used to draw the feature (for features from OSM).",
			"default": "#555555"
		},
		"stroke-width2": {
			"label": "Stroke (line) width (2nd link)",
			"description": "    Width for the lines used to draw the feature (for features from OSM)",
			"type": "number",
			"default": "5"
		},
		"coord2": {
			"label": "Coordinates (2nd link)",
			"description": "Coordinates to display for a point feature. Use the {{Coord}} template to specify coordinates.",
			"default": "If not set, coordinates will be retrieved from Wikidata."
		},
		"marker2": {
			"label": "Marker icon (2nd link)",
			"description": "Name of Maki marker image to display at the point feature. See https://www.mediawiki.org/wiki/Maps/Icons for options.",
			"default": "No icon"
		},
		"zoom2": {
			"label": "Zoom level (2nd link)",
			"description": "Zoom level for the 2nd link, from 1 to 19 (larger numbers zoom in further).",
			"type": "number",
			"default": "Automatically calculated"
		},
		"text3": {
			"label": "Link text (3rd link)",
			"description": "Text to display for the 3rd link; required if including a 3rd link",
			"type": "string"
		},
		"type3": {
			"label": "Type (3rd link)",
			"description": "Type of data for the 3rd link. Valid values are: \"line\" – a geoline feature from OSM (e.g. a road), \"shape\" – a geoshape feature from OSM (e.g. a state or province), \"shape-inverse\" – a geomask feature from OSM (the inverse of a geoshape - allows an unobstructed view of the map beneath), \"data\" – a geoJSON data page on Commons (parameter is optional in this case), \"point\" – a point feature (coordinates).",
			"type": "string"
		},
		"id3": {
			"aliases": [
				"ids3"
			],
			"label": "Wikidata ID (3rd link)",
			"description": "Wikidata ID (Q-number) that the OSM feature is tagged with. Separate multiple IDs with a comma.",
			"type": "string"
		},
		"title3": {
			"label": "Title (3rd link)",
			"description": "Title of the feature used for the 3rd link (for features from OSM), displayed when the feature is clicked on.",
			"type": "string"
		},
		"from3": {
			"label": "From (3rd link)",
			"description": "The JSON (.map) page from Commons to display (excluding the Data: prefix)",
			"example": "Inner West Light Rail.map"
		},
		"description3": {
			"label": "Description (3rd link)",
			"description": "Description of the feature (for features from OSM), displayed when the feature is clicked on; optional",
			"type": "string"
		},
		"raw3": {
			"aliases": [
				"data3"
			],
			"label": "Raw data (3rd link)",
			"description": "Raw GeoJSON for the 3rd link (preferably transcluded from a subpage of Wikipedia:Map data) as well as <maplink> functionality not available via the other parameters. See the \"When to use the raw parameter\" section of the documentation for more information."
		},
		"stroke-color3": {
			"aliases": [
				"stroke-colour3"
			],
			"label": "Stroke (line) colour (3rd link)",
			"description": "Colour code for the colour used to draw the feature (for features from OSM).",
			"default": "#555555"
		},
		"stroke-width3": {
			"label": "Stroke (line) width (3rd link)",
			"description": "Width for the lines used to draw the feature (for features from OSM)",
			"type": "number",
			"default": "5"
		},
		"coord3": {
			"label": "Coordinates (3rd link)",
			"description": "Coordinates to display for a point feature. Use the {{Coord}} template to specify coordinates.",
			"default": "If not set, coordinates will be retrieved from Wikidata."
		},
		"marker3": {
			"label": "Marker icon (3rd link)",
			"description": "Name of Maki marker image to display at the point feature. See https://www.mediawiki.org/wiki/Maps/Icons for options.",
			"default": "No icon"
		},
		"zoom3": {
			"label": "Zoom level (3rd link)",
			"description": "Zoom level for the 3rd link, from 1 to 19 (larger numbers zoom in further).",
			"type": "number",
			"default": "Automatically calculated"
		},
		"text4": {
			"label": "Link text (4th link)",
			"description": "Text to display for the 4th link; required if including a 4th link",
			"type": "string"
		},
		"type4": {
			"label": "Type (4th link)",
			"description": "Type of data for the 4th link. Valid values are: \"line\" – a geoline feature from OSM (e.g. a road), \"shape\" – a geoshape feature from OSM (e.g. a state or province), \"shape-inverse\" – a geomask feature from OSM (the inverse of a geoshape - allows an unobstructed view of the map beneath), \"data\" – a geoJSON data page on Commons (parameter is optional in this case), \"point\" – a point feature (coordinates).",
			"type": "string"
		},
		"id4": {
			"aliases": [
				"ids4"
			],
			"label": "Wikidata ID (4th link)",
			"description": "Wikidata ID (Q-number) that the OSM feature is tagged with. Separate multiple IDs with a comma.",
			"type": "string"
		},
		"title4": {
			"label": "Title (4th link)",
			"description": "Title of the feature used for the 4th link (for features from OSM), displayed when the feature is clicked on.",
			"type": "string"
		},
		"from4": {
			"label": "From (4th link)",
			"description": "The JSON (.map) page from Commons to display (excluding the Data: prefix)",
			"example": "Inner West Light Rail.map"
		},
		"description4": {
			"label": "Description (4th link)",
			"description": "Description of the feature (for features from OSM), displayed when the feature is clicked on; optional",
			"type": "string"
		},
		"raw4": {
			"aliases": [
				"data4"
			],
			"label": "Raw data (4th link)",
			"description": "Raw GeoJSON for the 4th link (preferably transcluded from a subpage of Wikipedia:Map data) as well as <maplink> functionality not available via the other parameters. See the \"When to use the raw parameter\" section of the documentation for more information."
		},
		"stroke-color4": {
			"aliases": [
				"stroke-colour4"
			],
			"label": "Stroke (line) colour (4th link)",
			"description": "Colour code for the colour used to draw the feature (for features from OSM).",
			"default": "#555555"
		},
		"stroke-width4": {
			"label": "Stroke (line) width (4th link)",
			"description": "Width for the lines used to draw the feature (for features from OSM)",
			"type": "number",
			"default": "5"
		},
		"coord4": {
			"label": "Coordinates (4th link)",
			"description": "Coordinates to display for a point feature. Use the {{Coord}} template to specify coordinates.",
			"default": "If not set, coordinates will be retrieved from Wikidata."
		},
		"marker4": {
			"label": "Marker image (4th link)",
			"description": "Name of Maki marker image to display at the point feature. See https://www.mediawiki.org/wiki/Maps/Icons for options.",
			"default": "No icon"
		},
		"zoom4": {
			"label": "Zoom level (4th link)",
			"description": "Zoom level for the 4th link, from 1 to 19 (larger numbers zoom in further).",
			"type": "number",
			"default": "Automatically calculated"
		},
		"text5": {
			"label": "Link text (5th link)",
			"description": "Text to display for the 5th link; required if including a 5th link",
			"type": "string"
		},
		"type5": {
			"label": "Type (5th link)",
			"description": "Type of data for the 5th link. Valid values are: \"line\" – a geoline feature from OSM (e.g. a road), \"shape\" – a geoshape feature from OSM (e.g. a state or province), \"shape-inverse\" – a geomask feature from OSM (the inverse of a geoshape - allows an unobstructed view of the map beneath), \"data\" – a geoJSON data page on Commons (parameter is optional in this case), \"point\" – a point feature (coordinates).",
			"type": "string"
		},
		"id5": {
			"aliases": [
				"ids5"
			],
			"label": "Wikidata ID (5th link)",
			"description": "Wikidata ID (Q-number) that the OSM feature is tagged with. Separate multiple IDs with a comma.",
			"type": "string"
		},
		"title5": {
			"label": "Title (5th link)",
			"description": "Title of the feature used for the 5th link (for features from OSM), displayed when the feature is clicked on.",
			"type": "string"
		},
		"from5": {
			"label": "From (5th link)",
			"description": "The JSON (.map) page from Commons to display (excluding the Data: prefix)",
			"example": "Inner West Light Rail.map"
		},
		"description5": {
			"label": "Description (5th link)",
			"description": "Description of the feature (for features from OSM), displayed when the feature is clicked on; optional",
			"type": "string"
		},
		"raw5": {
			"aliases": [
				"data5"
			],
			"label": "Raw data (5th link)",
			"description": "Raw GeoJSON for the 5th link (preferably transcluded from a subpage of Wikipedia:Map data) as well as <maplink> functionality not available via the other parameters. See the \"When to use the raw parameter\" section of the documentation for more information."
		},
		"stroke-color5": {
			"aliases": [
				"stroke-colour5"
			],
			"label": "Stroke (line) colour (5th link)",
			"description": "Colour code for the colour used to draw the feature (for features from OSM).",
			"default": "#555555"
		},
		"stroke-width5": {
			"label": "Stroke (line) width (5th link)",
			"description": "Width for the lines used to draw the feature (for features from OSM)",
			"type": "number",
			"default": "5"
		},
		"coord5": {
			"label": "Coordinates (5th link)",
			"description": "Coordinates to display for a point feature. Use the {{Coord}} template to specify coordinates.",
			"default": "If not set, coordinates will be retrieved from Wikidata."
		},
		"marker5": {
			"label": "Marker image (5th link)",
			"description": "Name of Maki marker image to display at the point feature. See https://www.mediawiki.org/wiki/Maps/Icons for options.",
			"default": "No icon"
		},
		"zoom5": {
			"label": "Zoom level (5th link)",
			"description": "Zoom level for the 5th link, from 1 to 19 (larger numbers zoom in further).",
			"type": "number",
			"default": "Automatically calculated"
		}
	},
	"description": "Places a link to a full-page map in a box at the side of the page."
}
</templatedata>