Template:Mapbox/sandbox
 | This is the template sandbox page for Template:Mapbox (diff). See also the companion subpage for test cases. |
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 Commons, create a page that is in the
Data:namespace and ends in.map– 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
[edit]{{Mapbox}} utilises Template:Maplink. As a result, usage of the two templates is very similar.
| Type | Code | Notes | Example |
|---|---|---|---|
| Data page on Commons | {{mapbox|from=}} |
specify .map data page in from=, excluding the Data prefix |
|
| Raw GeoJSON data | {{mapbox|raw=}} |
e.g. {{Wikipedia:Map data/Main Roads Western Australia/Forrest Highway}} | |
| Line of a border or a linear feature from OSM | {{mapbox|type=line|id=}} |
id= only required if the Wikidata item isn't linked to the current page |
|
| Shape from OSM | {{mapbox|type=shape|id=}} |
id= only required if the Wikidata item isn't linked to the current page |
|
| Inverted shape from OSM | {{mapbox|type=shape-inverse|id=}} |
id= only required if the Wikidata item isn't linked to the current page |
|
| Point feature from Wikidata coordinates | {{mapbox|type=point|id=}} |
id= only required if the Wikidata item isn't linked to the current page |
|
| Point feature from specified coordinates | {{mapbox|type=point|coord=}} |
Use {{Coord}} template to specify coordinates |
Full parameter set – data page
{{mapbox
|from=
|zoom=
|text=
|text-left=
|above=
|below=
}}
Full parameter set – raw data
{{mapbox
|raw= <!-- preferably {{Wikipedia:Map data/subpage}} -->
|zoom=
|text=
|text-left=
|above=
|below=
}}
Full parameter set – OSM features
{{mapbox
|type=
|id=
|title=
|description=
|stroke-color=
|stroke-width=
|zoom=
|text=
|text-left=
|above=
|below=
}}
Full parameter set – point features/coordinates
{{mapbox
|type=point
|id=
|title=
|description=
|coord=
|marker=
|zoom=
|text=
|text-left=
|above=
|below=
}}
Multiple links
[edit]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.data2 or description2. All parameters support this except for above, below and text-left. Unlike the first link (where it is optional), the text parameter is required for links 2-5.
Parameters
[edit]Parameters affecting the maps
[edit]- type
- 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)
- 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
|from=not set). - from
- The JSON (.map) file from Commons to display (excluding the
Data:prefix) - raw
- raw GeoJSON (preferably transcluded from a subpage of Wikipedia:Map data) as well as <maplink> functionality not available via the other parameters. 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 {{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
marker(plain marker) if not set. - stroke-color
- (or stroke-colour)
- Colour code for the colour used to draw the feature (for features from OSM); default is
#555555( ) - stroke-width
- Width for the lines used to draw the feature (for features from OSM); default is
5 - zoom
- Zoom level, from
1to19(larger numbers zoom in further); will be automatically determined if not set
Parameters affecting the box
[edit]- 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
yesto change the link text from centre-aligned to left-aligned
When to use the raw parameter
[edit]The "raw" parameter allows the same inputs as the full <maplink> 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
[edit]- 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
|raw=parameter). - The following code utilising the
|raw=parameter won't work because the curly brace to close the GeoJSON is adjacent to the curly braces to close the template:
{{Mapbox|raw= {"type": "ExternalData","service": "geoshape","ids": "Q13518258"}}}
- To fix it, put a space before the two template braces or move them to a separate line.
- {{Maplink}}'s multiple features functionality doesn't work; use
|raw=instead.
See also
[edit]- Wikipedia:Maps for Wikipedia, a list of mapping tools available on Wikipedia
- Template:Attached KML
Places a link to a full-page map in a box at the side of the page.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Above | above | Content (such as explanatory text) appearing above the links | String | optional |
| Below | below | Content (such as explanatory text) appearing below the links | String | optional |
| Left-align text | text-left | Set this to "yes" to change the link text from centre-aligned to left-aligned | Unknown | optional |
| Type | type | 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) | String | suggested |
| Wikidata ID | id ids | Wikidata ID (Q-number) that the OSM feature is tagged with. Separate multiple IDs with a comma.
| String | optional |
| From | from | The JSON (.map) page from Commons to display (excluding the Data: prefix)
| Unknown | suggested |
| Title | title | Title of the feature (for features from OSM), displayed when the feature is clicked on.
| String | optional |
| Description | description | Description of the feature (for features from OSM), displayed when the feature is clicked on; optional | String | optional |
| Raw data | raw data | 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. | Unknown | suggested |
| Stroke (line) colour | stroke-color stroke-colour | Colour code for the colour used to draw the feature (for features from OSM).
| Unknown | optional |
| Stroke (line) width | stroke-width | Width for the lines used to draw the feature (for features from OSM)
| Number | optional |
| Coordinates | coord | Coordinates to display for a point feature. Use the {{Coord}} template to specify coordinates.
| Unknown | optional |
| Marker icon | marker | Name of Maki marker image to display at the point feature. See https://www.mediawiki.org/wiki/Maps/Icons for options.
| Unknown | optional |
| Zoom level | zoom | Zoom level, from 1 to 19 (larger numbers zoom in further).
| Number | optional |
| Link text | text | Text to display for the link.
| String | optional |
| Link text (2nd link) | text2 | Text to display for the 2nd link; required if including a 2nd link | String | optional |
| Type (2nd link) | type2 | 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). | String | optional |
| Wikidata ID (2nd link) | id2 ids2 | Wikidata ID (Q-number) that the OSM feature is tagged with. Separate multiple IDs with a comma. | String | optional |
| Title (2nd link) | title2 | Title of the feature used for the 2nd link (for features from OSM), displayed when the feature is clicked on. | String | optional |
| From (2nd link) | from2 | The JSON (.map) page from Commons to display (excluding the Data: prefix)
| Unknown | optional |
| Description (2nd link) | description2 | Description of the feature (for features from OSM), displayed when the feature is clicked on; optional | String | optional |
| Raw data (2nd link) | raw2 data2 | 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. | Unknown | optional |
| Stroke (line) colour (2nd link) | stroke-color2 stroke-colour2 | Colour code for the colour used to draw the feature (for features from OSM).
| Unknown | optional |
| Stroke (line) width (2nd link) | stroke-width2 | Width for the lines used to draw the feature (for features from OSM)
| Number | optional |
| Coordinates (2nd link) | coord2 | Coordinates to display for a point feature. Use the {{Coord}} template to specify coordinates.
| Unknown | optional |
| Marker icon (2nd link) | marker2 | Name of Maki marker image to display at the point feature. See https://www.mediawiki.org/wiki/Maps/Icons for options.
| Unknown | optional |
| Zoom level (2nd link) | zoom2 | Zoom level for the 2nd link, from 1 to 19 (larger numbers zoom in further).
| Number | optional |
| Link text (3rd link) | text3 | Text to display for the 3rd link; required if including a 3rd link | String | optional |
| Type (3rd link) | type3 | 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). | String | optional |
| Wikidata ID (3rd link) | id3 ids3 | Wikidata ID (Q-number) that the OSM feature is tagged with. Separate multiple IDs with a comma. | String | optional |
| Title (3rd link) | title3 | Title of the feature used for the 3rd link (for features from OSM), displayed when the feature is clicked on. | String | optional |
| From (3rd link) | from3 | The JSON (.map) page from Commons to display (excluding the Data: prefix)
| Unknown | optional |
| Description (3rd link) | description3 | Description of the feature (for features from OSM), displayed when the feature is clicked on; optional | String | optional |
| Raw data (3rd link) | raw3 data3 | 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. | Unknown | optional |
| Stroke (line) colour (3rd link) | stroke-color3 stroke-colour3 | Colour code for the colour used to draw the feature (for features from OSM).
| Unknown | optional |
| Stroke (line) width (3rd link) | stroke-width3 | Width for the lines used to draw the feature (for features from OSM)
| Number | optional |
| Coordinates (3rd link) | coord3 | Coordinates to display for a point feature. Use the {{Coord}} template to specify coordinates.
| Unknown | optional |
| Marker icon (3rd link) | marker3 | Name of Maki marker image to display at the point feature. See https://www.mediawiki.org/wiki/Maps/Icons for options.
| Unknown | optional |
| Zoom level (3rd link) | zoom3 | Zoom level for the 3rd link, from 1 to 19 (larger numbers zoom in further).
| Number | optional |
| Link text (4th link) | text4 | Text to display for the 4th link; required if including a 4th link | String | optional |
| Type (4th link) | type4 | 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). | String | optional |
| Wikidata ID (4th link) | id4 ids4 | Wikidata ID (Q-number) that the OSM feature is tagged with. Separate multiple IDs with a comma. | String | optional |
| Title (4th link) | title4 | Title of the feature used for the 4th link (for features from OSM), displayed when the feature is clicked on. | String | optional |
| From (4th link) | from4 | The JSON (.map) page from Commons to display (excluding the Data: prefix)
| Unknown | optional |
| Description (4th link) | description4 | Description of the feature (for features from OSM), displayed when the feature is clicked on; optional | String | optional |
| Raw data (4th link) | raw4 data4 | 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. | Unknown | optional |
| Stroke (line) colour (4th link) | stroke-color4 stroke-colour4 | Colour code for the colour used to draw the feature (for features from OSM).
| Unknown | optional |
| Stroke (line) width (4th link) | stroke-width4 | Width for the lines used to draw the feature (for features from OSM)
| Number | optional |
| Coordinates (4th link) | coord4 | Coordinates to display for a point feature. Use the {{Coord}} template to specify coordinates.
| Unknown | optional |
| Marker image (4th link) | marker4 | Name of Maki marker image to display at the point feature. See https://www.mediawiki.org/wiki/Maps/Icons for options.
| Unknown | optional |
| Zoom level (4th link) | zoom4 | Zoom level for the 4th link, from 1 to 19 (larger numbers zoom in further).
| Number | optional |
| Link text (5th link) | text5 | Text to display for the 5th link; required if including a 5th link | String | optional |
| Type (5th link) | type5 | 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). | String | optional |
| Wikidata ID (5th link) | id5 ids5 | Wikidata ID (Q-number) that the OSM feature is tagged with. Separate multiple IDs with a comma. | String | optional |
| Title (5th link) | title5 | Title of the feature used for the 5th link (for features from OSM), displayed when the feature is clicked on. | String | optional |
| From (5th link) | from5 | The JSON (.map) page from Commons to display (excluding the Data: prefix)
| Unknown | optional |
| Description (5th link) | description5 | Description of the feature (for features from OSM), displayed when the feature is clicked on; optional | String | optional |
| Raw data (5th link) | raw5 data5 | 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. | Unknown | optional |
| Stroke (line) colour (5th link) | stroke-color5 stroke-colour5 | Colour code for the colour used to draw the feature (for features from OSM).
| Unknown | optional |
| Stroke (line) width (5th link) | stroke-width5 | Width for the lines used to draw the feature (for features from OSM)
| Number | optional |
| Coordinates (5th link) | coord5 | Coordinates to display for a point feature. Use the {{Coord}} template to specify coordinates.
| Unknown | optional |
| Marker image (5th link) | marker5 | Name of Maki marker image to display at the point feature. See https://www.mediawiki.org/wiki/Maps/Icons for options.
| Unknown | optional |
| Zoom level (5th link) | zoom5 | Zoom level for the 5th link, from 1 to 19 (larger numbers zoom in further).
| Number | optional |