Template:Maplink/doc

This is a documentation subpage for Template:Maplink.
It contains usage information, categories and other content that is not part of the original template page.

This template is used on approximately 25,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Mapframe (sandbox)

This template adds a link, or frame, which will display map data – either from:

data stored in GeoJSON format on Wikipedia or Commons
line/polygon features in OpenStreetMap.
coordinates, either supplied or from Wikidata
raw GeoJSON, preferably transcluded from another page

Note:

If you have a very large/slow map, you should use the mapframe extension tag directly instead of this template, as was done in Special:Diff/970846012. The reason for this is that using the template to call the extension tag will result in the map rendering counting as Lua time, which may result in time exceeded errors.
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.

Uses

This template is intended for points as well as linear or polygon features, including (but not limited to):

Roads
Rivers
Subway or train lines
Ship courses
Flight paths
Explorers journeys
Animal habitats
Countries and their subdivisions

and more... This template can also be used to display point features on a map, i.e. coordinates.

Usage

Basic usage

<maplink text="Data page">{"properties":{"stroke-width":6,"stroke":"#ff0000","title":"Maplink/doc"},"type":"ExternalData","title":"ecos.fws.gov/Endangered habitat 58938/Plethodon neomexicanus.map","service":"page"}</maplink> on Commons (e.g. Data:ecos.fws.gov/Endangered habitat 58938/Plethodon neomexicanus.map):
{{maplink|from=}} (specify .map data page in from=, excluding Data prefix)
<maplink text="Raw GeoJSON data">{{Wikipedia:Map data/Main Roads Western Australia/Forrest Highway}}</maplink> (e.g. {{Wikipedia:Map data/Main Roads Western Australia/Forrest Highway}}):
{{maplink|raw=}} (specify raw GeoJSON, preferably transcluded from a subpage of Wikipedia:Map data)
<maplink text="Line of a border or a linear feature">{"properties":{"stroke-width":6,"stroke":"#ff0000","title":"Maplink/doc"},"type":"ExternalData","service":"geoline"}</maplink> from OSM:
{{maplink|type=line|id=}} (Wikidata id only required if another article's Wikidata page is to be used)
<maplink text="Shape">{"properties":{"stroke-width":6,"stroke":"#ff0000","title":"Maplink/doc"},"type":"ExternalData","service":"geoshape"}</maplink> from OSM:
{{maplink|type=shape|id=}} (Wikidata id only required if another article's Wikidata page is to be used)
<maplink text="Inverted shape">{"properties":{"stroke-width":6,"stroke":"#ff0000","title":"Maplink/doc"},"type":"ExternalData","service":"geomask"}</maplink> from OSM:
{{maplink|type=shape-inverse|id=}} (Wikidata id only required if another article's Wikidata page is to be used)
Lua error: Coordinates must be specified on Wikidata or in |coord=. (coordinates):
...from Wikidata:
{{maplink|type=point|id=}} (Wikidata id only required if another article's Wikidata page is to be used)

...from specified coordinates:
{{maplink|type=point|coord=}} (specify coordinates using {{Coord}} template)
<maplink text="All named coordinates">[

{"type":"Feature","geometry":{"coordinates":[-2.05932,52.50435],"type":"Point"},"properties":{"description":"52.50435°N 2.05932°W","title":"Approx. tunnel mid-point","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.04948,52.51534],"type":"Point"},"properties":{"description":"52.51534°N 2.04948°W","title":"Northern tunnel portal","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.06916,52.49335],"type":"Point"},"properties":{"description":"52.49335°N 2.06916°W","title":"Southern tunnel portal","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.04331,52.52204],"type":"Point"},"properties":{"description":"52.52204°N 2.04331°W","title":"Dudley Port Junction","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.0476,52.51758],"type":"Point"},"properties":{"description":"52.51758°N 2.04760°W","title":"Groveland Bridge","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.04843,52.5164],"type":"Point"},"properties":{"description":"52.51640°N 2.04843°W","title":"Tividale Aqueduct","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.04948,52.51534],"type":"Point"},"properties":{"description":"52.51534°N 2.04948°W","title":"Northern tunnel portal","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.052015,52.512436],"type":"Point"},"properties":{"description":"52.512436°N 2.052015°W","title":"Netherton Tunnel Air Vent No. 16","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.054329,52.50986],"type":"Point"},"properties":{"description":"52.50986°N 2.054329°W","title":"Netherton Tunnel Air Vent No. 14","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.05518,52.5085],"type":"Point"},"properties":{"description":"52.50850°N 2.05518°W","title":"Aston Road air vent","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.05708,52.50697],"type":"Point"},"properties":{"description":"52.50697°N 2.05708°W","title":"Regent Road air vent","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.05932,52.50435],"type":"Point"},"properties":{"description":"52.50435°N 2.05932°W","title":"Approx. tunnel mid-point","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.059364,52.504191],"type":"Point"},"properties":{"description":"52.504191°N 2.059364°W","title":"Air vent No. 8","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.061764,52.501551],"type":"Point"},"properties":{"description":"52.501551°N 2.061764°W","title":"Air vent No. 6","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.064032,52.499036],"type":"Point"},"properties":{"description":"52.499036°N 2.064032°W","title":"Air vent No. 4","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.066459,52.496345],"type":"Point"},"properties":{"description":"52.496345°N 2.066459°W","title":"Air vent No. 2","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.06916,52.49335],"type":"Point"},"properties":{"description":"52.49335°N 2.06916°W","title":"Southern tunnel portal","marker-color":"5E74F3"}}, {"type":"Feature","geometry":{"coordinates":[-2.07019,52.49157],"type":"Point"},"properties":{"description":"52.49157°N 2.07019°W","title":"Windmill End Junction","marker-color":"5E74F3"}} ]</maplink> from a page or section ({{coord}} templates using the |name= parameter)

...from the current page: {{maplink|type=named}} or {{maplink|type=named|from=#Section}}

...from another page: {{maplink|type=named|from=Other page}} or {{maplink|type=named|from=Other page#Section}}
Lua error: Coordinates must be specified on Wikidata or in |coord=. (centred on a point's coordinates):
...from Wikidata:
{{maplink|type=circle|radius=|id=}} (Wikidata id only required if another article's Wikidata page is to be used)

...from specified coordinates:
{{maplink|type=circle|radius=|coord=}} (specify coordinates using {{Coord}} template)
To show in a frame, add the parameter |frame=yes: {{maplink|frame=yes|frame-align=left|type=line|id=Q1094308|text=Mapframe example}}.
<mapframe height="200" text="Mapframe example" align="left" width="300">{"properties":{"stroke-width":6,"stroke":"#ff0000","title":"Maplink/doc"},"type":"ExternalData","service":"geoline","ids":"Q1094308"}</mapframe>

Additional parameters are available to customise the displayed map, such as |plain=yes to remove the outer frame: {{maplink|frame=yes|frame-align=left|plain=yes|type=line|id={{get QID|Várkerület}}|frame-width=200|frame-height=250|frame-long=19.1009|frame-lat=47.5001|zoom=9}}.
<mapframe zoom="9" frameless="1" align="left" height="250" latitude="47.5001" longitude="19.1009" width="200">{"properties":{"stroke-width":6,"stroke":"#ff0000","title":"Maplink/doc"},"type":"ExternalData","service":"geoline"}</mapframe>

Overlays can also be displayed on top of the map: {{maplink|frame=yes|frame-align=left|frame-width=400|frame-height=300|type=point|id=Q8688|marker=airport|zoom=12 |text=San Francisco International Airport |overlay={{Graph:Street map with marks|width=110|height=90|lat=37.8|lon=-121.8|zoom=6|{ "lat": 37.618, "lon": -122.375 }| minimap=false}}
Lua error: Coordinates must be specified on Wikidata or in |coord=.

Parameter set – data page

{{maplink
|display=
|from=
|zoom=
|text=
|icon=
}}

Parameter set – raw data

{{maplink
|display=
|raw= <!-- preferably {{Wikipedia:Map data/subpage}} -->
|zoom=
|text=
|icon=
}}

Parameter set – geoline/geoshape

{{maplink
|display=
|type=
|id=
|title=
|description=
|stroke-color=
|stroke-width=
|zoom=
|text=
|icon=
}}

Parameter set – point features/coordinates

{{maplink
|display=
|type=point
|id=
|title=
|description=
|coord=
|marker=
|zoom=
|text=
|icon=
}}

Parameter set – circles

{{maplink
|display=
|type=circle
|radius=  <!-- in metres, alternative parameters available for other units --> 
|id=
|title=
|description=
|coord=
|marker=
|zoom=
|text=
|icon=
}}

Parameters

For overall display

display

How the template is displayed. Valid values are:

inline - Only displays the inline link (you can forego this, as it is the default)

title - Only displays the title link

inline,title - Displays the inline link as well as the title link

title,inline - Same as above

text: Text to display for the link (or caption if using mapframe); default is "Map"
icon: Set to "no" to turn off the icon that appears next to the link
zoom: Zoom level, from 1 to 19 (larger numbers zoom in further); default is automatically determined by the map, unless the only feature is a single point.

Mapframe parameters (only work with inline display)

frame

Set to "yes" to show a map frame instead of a link

plain: Set to "yes" to show just the map without the surrounding frame, and without a caption (text parameter will be ignored)
frame-align: Alignment with respect to the page: left, center, or right; default is right
frame-width: Width of the map frame, default is 300
frame-height: Height of the map frame, default is 200
frame-coordinates: (or frame-coord); Optional - alternate coordinates for initial placement of map. Use {{Coord}} template to specify coordinates (e.g. |frame-coordinates={{tl|Coord|12.34|S|56.78|W}}). If not set, coordinates will be retrieved from Wikidata.
frame-latitude: (or frame-lat); (ignored if |frame-coordinates= or |frame-coord= is set); Optional - alternate latitude coordinate for initial placement of map.
frame-longitude: (or frame-long); (ignored if |frame-coordinates= or |frame-coord= is set); Optional - alternate longitude coordinate for initial placement of map.

Note: If frame latitude and longitude are not set by parameters, then frame coordinates can be determined automatically, either:

Based on the line and shape objects (if any have been specified), or
From the point feature specified in |coord= (if set), or
Retrieved from Wikidata (if available – for either the item specified in |id= parameter, or for the page the template is placed on)

overlay

An image, or another map, to be displayed on top the map. E.g.

|overlay=[[File:Example.svg|140x140px]] or; |overlay={{maplink|frame=yes|plain=yes|frame-width=100|frame-height=100|type=shape|id={{get QID|French submarine Ariane (1914)}}|frame-align=center}} or; |overlay={{Graph:Street map with marks|width=100|height=100|lat=37.8|lon=-122.4|zoom=6|{ "lat": 37.8, "lon": -122.4 }|minimap=false}}; (see Template:Maplink/testcases/overlays to view examples)
overlay-horizontal-alignment: Horizontal alignment of overlay, either left or right; default is right
overlay-vertical-alignment: Vertical alignment of overlay, either top or bottom; default is bottom
overlay-horizontal-offset and overlay-vertical-offset: Optional – number of pixels to offset the overlay in from the edge of the map, e.g. 10 for a 10 pixel gap
overlay-border: CSS style for the border, e.g. 3px solid black; default is 1px solid white. The colour can be any web color name or hex code.

Raw GeoJSON

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.

For each feature

Multiple features can be displayed on a single map. For each additional feature, add a sequential number to the end of the parameter name. For example, the second uses parameters like |type2=, |id2=, etc., the third feature |type3=, |id3=, etc., and so on. Higher numbers are drawn on top.

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)

named – all named coordinates in an page or section ({{coord}} templates with |name= parameter)

circle – a circle centred on a point's coordinates

id

(or ids)

Wikidata id (Q-number) of the point feature, Wikidata id that the OSM line/shape feature is tagged with. Separate multiple ids with a comma. Defaults to the current page's Wikidata id (if |from= not set).

from

Source of map data:

If type is data or omitted: The JSON (.map) file from Commons to display (excluding the Data: prefix)
If type is named: Page name, or name#section, to get named coordinates from. If omitted, or specified as just #section, then current page will be used.

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
stroke-color: (or stroke-colour); Color code for the color used to draw the feature (for features from OSM); default is #ff0000 (red)
stroke-width: Width for the lines used to draw the feature (for features from OSM); default is 6
stroke-opacity: Opacity for the lines used to draw the feature (for features from OSM) – a number between 0 (fully transparent) and 1 (fully opaque); default is 1
fill: Color code for the fill color of the feature (for shape or shape-inverse features from OSM); default is #000000 (black). Note that a semi-transparent version of the specified color will be used by default, allowing the map below to still be seen.
fill-opacity: Opacity for the fill color of the feature (for shape or shape-inverse features from OSM) – a number between 0 (fully transparent) and 1 (fully opaque); default is 0.5
coord: Coordinates to display for a point feature. Use {{Coord}} template to specify coordinates (e.g. |coord={{Coord|12.34|S|56.78|W}}). 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. If not set, a plain marker will be shown without an image.
marker-color: (or marker-colour); Color code (Hex triplet) specifying marker background color. Default is 5E74F3 ( )
marker-size: Size of the marker. Can be small, medium (default) or large.
radius: (or radius_m), or alternative parameters radius_km, or radius_mi, or radius_ft; Radius of the circle. In metres by default, or in kilometers or miles or feet if the alternative parameters are used.
edges: Number of edges used to construct the circle. Default is 32. Higher numbers will result in a smoother circle but use more Lua processing resources.

TemplateData

<templatedata> { "params": { "display": { "description": "How the template is displayed", "suggestedvalues": [ "inline", "title", "inline,title" ], "default": "inline" }, "text": { "description": "Text to display for the link (or caption if using mapframe)", "type": "line", "default": "Map" }, "icon": { "description": "Set to \"no\" to turn off the icon that appears next to the link", "type": "boolean" }, "zoom": { "description": "Zoom level, from 1 to 19 (larger numbers zoom in further); default is automatically determined by the map, unless the only feature is a single point.", "type": "number" } }, "description": "Adds a link, or frame, which will display map data" } </templatedata>

Multiple map switcher

An option for Template:Switcher-style switching of multiple mapframes, where specified parameters like zoom, or frame coordinates, or a shape's item id are switched between different values. When using, ensure the number of values in each list are the same.

Instructions:

Add parameter switch to specify labels for the different options: a list separated by either,, or ; if the labels contain commas, or ### if the labels contain semi-colons. Each label will be displayed with a prefix of "Show ".
Example: |switch=zoomed out, zoomed mid, zoomed in
For each parameter that is to be switched, set its value to SWITCH: followed by a list of values to switch between, again separated by , or ; or ###
Example: |zoom=SWITCH:4,9,14

Parameters frame, plain, and text should not be switched
Make sure each list has the same number of entries. The position of value in a SWITCH: list corresponds to the same position in the list of labels set in |switch=.

Example: Lua error: Coordinates must be specified on Wikidata or in |coord=.

{{mapframe|frame=yes|type=point|id={{Get QID|French submarine Ariane (1914)}}|text=Boston|zoom=SWITCH:4,9,14|switch=zoomed out, zoomed mid, zoomed in}}

Examples and tips

Multiple features

Multiple features allow you to:

Use external data from both Wikimedia Commons and OpenStreetMap together
Apply different styles to different external data features from OpenStreetMap
Include multiple links to external data from Wikimedia Commons

<mapframe height="200" text="Map" width="300">[ {"properties":{"stroke-width":6,"stroke":"#ff0000","title":"Shape","description":"Description of shape"},"type":"ExternalData","service":"geoshape","ids":"Q3495894"}, {"properties":{"stroke-width":6,"stroke":"#ff0000","title":"Line","description":"Description of line"},"type":"ExternalData","service":"geoline","ids":"Q1318331"}, {"type":"Feature","geometry":{"coordinates":[116,-32],"type":"Point"},"properties":{"description":"Description of point","title":"Point","marker-color":"5E74F3"}} ]</mapframe>

{{Maplink|frame=yes
|type=shape|id=Q3495894|title=Shape|description=Description of shape
|type2=line|id2=Q1318331|title2=Line|description2=Description of line
|type3=point|coord3={{coord|32|S|116|E}}|title3=Point|description3=Description of point
}}

Lua error: Coordinates must be specified on Wikidata or in |coord=.

{{Maplink|frame=yes|plain=yes|frame-width=250|frame-height=280|zoom=6|frame-lat=29.185|frame-long=76.225
|type=shape-inverse|id=Q1174|title=Haryana
|type2=point|id2=Q200663|stroke-width=3|title2=Faridabad
}}

Infoboxes

Mapframes can be included in infoboxes. Using |plain=yes to remove the outer frame is recommended.

For simple cases with a single feature, {{infobox mapframe}} can be used instead (see that template's documentation for details). Lua error: invalid frame ID.

{{Infobox Australian road
| location = {{maplink |type=line |frame=yes |plain=yes |frame-align=center |frame-lat=-31.8262 |frame-long=115.7877 |zoom=9}}
  ...  (other parameters omitted)  ...
}}

The raw parameter

The "raw" parameter allows the same inputs as the full <maplink> function. It allows you to:

Use GeoJSON data directly
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

See mw:Help:Extension:Kartographer for instructions.

Raw GeoJSON example

<maplink text="Route map">{{Wikipedia:Map data/Main Roads Western Australia/Forrest Highway}}</maplink>

{{maplink|raw={{Wikipedia:Map data/Main Roads Western Australia/Forrest Highway}}|text=Route map}}

(Link to GeoJSON data subpage: Wikipedia:Map data/Main Roads Western Australia/Forrest Highway)

Raw Wikidata query examples

<mapframe zoom="1" text="Ten countries" height="400" latitude="25" longitude="10" width="600">{ "type": "ExternalData", "service": "geoshape", "query": " SELECT * WHERE { ?id wdt:P463 wd:Q1065 . } LIMIT 10 "}</mapframe>

{{maplink|frame=yes|text=Ten countries|raw={
  "type": "ExternalData",
  "service": "geoshape",
  "query": "
SELECT * WHERE {
  ?id wdt:P463 wd:Q1065 .
} LIMIT 10
"}
|frame-width=600|frame-height=400|frame-lat=25|frame-long=10|zoom=1
}}

<mapframe zoom="3" text="Map" height="400" latitude="52" longitude="-110" width="600">{ "type": "ExternalData", "service": "geoshape", "query": " SELECT ?id ?head (SAMPLE(?img) as ?img_) (min(?partyId) as ?party) (if(?party = '0', '#800000', if(?party = '1', '#000080', '#008000')) as ?fill) (concat('', ?headLabel, '') as ?title) (concat(?stateLabel, '\\n', 'File:', substr(str(?img ), 52, 500), '') as ?description) WHERE { ?id wdt:P31 wd:Q35657 . ?id wdt:P6 ?head . ?head wdt:P102 ?party . BIND(if(?party = wd:Q29468, '0', if(?party = wd:Q29552, '1', '2')) as ?partyId) SERVICE wikibase:label { bd:serviceParam wikibase:language 'en' . ?head rdfs:label ?headLabel . ?id rdfs:label ?stateLabel . } OPTIONAL { ?head wdt:P18 ?img . } ?link schema:about ?head . ?link schema:isPartOf <https://en.wikipedia.org/> . } GROUP BY ?id ?head ?headLabel ?link ?stateLabel "}</mapframe>

{{maplink|frame=yes|raw={
  "type": "ExternalData",
  "service": "geoshape",
  "query": "
SELECT ?id ?head
  (SAMPLE(?img) as ?img_) 
  (min(?partyId) as ?party) 
  (if(?party = '0', '#800000', if(?party = '1', '#000080', '#008000')) as ?fill)
  (concat('[[', substr(str(?link),31,500),  '{{!}}', ?headLabel, ']]') as ?title)
  (concat(?stateLabel, '\\n', '[[File:', substr(str(?img_), 52, 500), '{{!}}200px]]') as ?description)
WHERE {  
  ?id wdt:P31 wd:Q35657 .
  ?id wdt:P6 ?head .
  ?head wdt:P102 ?party .
  BIND(if(?party = wd:Q29468, '0', if(?party = wd:Q29552, '1', '2')) as ?partyId) 
  SERVICE wikibase:label {
    bd:serviceParam wikibase:language 'en' .
    ?head rdfs:label ?headLabel .
    ?id rdfs:label ?stateLabel .
  }
  OPTIONAL {
    ?head wdt:P18 ?img .
  }
  ?link schema:about ?head .
  ?link schema:isPartOf <https://en.wikipedia.org/> .
} GROUP BY ?id ?head ?headLabel ?link ?stateLabel
"}|frame-width=600|frame-height=400|frame-lat=52|frame-long=-110|zoom=3}}

Gotchas

When retrieving lines or shapes from OSM, you can't style the fill color 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:

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

Tutorials

Redirects

{{Map link}}
{{Mapframe}}

Template:Maplink/doc

Contents

Uses

Usage

Parameters

For overall display

Raw GeoJSON

For each feature

TemplateData

Multiple map switcher

Examples and tips

Multiple features

Infoboxes

The raw parameter

Raw GeoJSON example

Raw Wikidata query examples

Gotchas

Tutorials

Redirects

See also

Navigation menu

Template:Maplink/doc

Uses

Usage

Parameters

For overall display

Raw GeoJSON

For each feature

TemplateData

Multiple map switcher

Examples and tips

Multiple features

Infoboxes

The raw parameter

Raw GeoJSON example

Raw Wikidata query examples

Gotchas

Tutorials

Redirects

See also

Navigation menu

Search