Template:Maplink/doc

This template adds a link, or frame, which will display map data – either from: Note:
 * 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
 * GeoJSON files cannot currently be directly uploaded. Instead, on Commons, create a page that is in the  namespace and ends in   – 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 and mw:Help:Extension:Kartographer/OSM for further information.

Uses
This template is intended for linear or polygon features, including (but not limited to): and more... This template can also be used to display point features on a map, i.e. coordinates.
 * Roads
 * Rivers
 * Subway or train lines
 * Ship courses
 * Flight paths
 * Explorers journeys
 * Animal habitats
 * Countries and their subdvisions

Usage
Basic usage
 * on Commons :
 * (specify .map data page in from=, excluding Data prefix)
 * (specify raw GeoJSON, preferably transcluded from a subpage of Map data)
 * from OSM:
 * (Wikidata id only required if another article's Wikidata page is to be used)
 * from OSM:
 * (Wikidata id only required if another article's Wikidata page is to be used)
 * from OSM:
 * (Wikidata id only required if another article's Wikidata page is to be used)
 * (coordinates):
 * ...from Wikidata: (Wikidata id only required if another article's Wikidata page is to be used)
 * ...from specified coordinates: (specify coordinates using Coord template)
 * (centred on a point's coordinates):
 * ...from Wikidata: (Wikidata id only required if another article's Wikidata page is to be used)
 * ...from specified coordinates: (specify coordinates using Coord template)
 * To show in a frame, add the parameter yes.
 * To show in a frame, add the parameter yes.


 * Additional parameters are available to customise the displayed map.

Full parameter set – data page

Full parameter set – raw data

Full parameter set – geoline/geoshape

Full parameter set – point features/coordinates

Full parameter set – circles

For overall display

 * display
 * How the template is displayed. Valid values are:
 * - Only displays the inline link (you can forego this, as it is the default)
 * - Only displays the title link
 * - Displays the inline link as well as the title link
 * - 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  to   (larger numbers zoom in further); default is automatically determined by the map (Note that automatically determined zoom level does not work for mapframe maps except when previewing the page – see T193455)

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:,  , or  ; default is
 * frame-width
 * Width of the map frame, default is
 * frame-height
 * Height of the map frame, default is
 * frame-coordinates
 * (or frame-coord)
 * Optional - alternate coordinates for initial placement of map. Use Coord template to specify coordinates . 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.
 * 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)

Raw GeoJSON

 * raw
 * Raw GeoJSON (preferably transcluded from a subpage of Map data) as well as – a geoline feature from OSM (e.g. a road)
 * – a geoshape feature from OSM (e.g. a state or province)
 * – a geomask feature from OSM (the inverse of a geoshape - allows an unobstructed view of the map beneath)
 * – a geoJSON data page on Commons (parameter is optional in this case)
 * – a point feature (coordinates)
 * – 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
 * The JSON (.map) file from Commons to display (excluding the  prefix)


 * 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  (red)


 * stroke-width
 * Width for the lines used to draw the feature (for features from OSM); default is


 * stroke-opacity
 * Opacity for the lines used to draw the feature (for features from OSM) – a number between  (fully transparent) and   (fully opaque); default is


 * fill
 * Color code for the fill color of the feature (for shape or shape-inverse features from OSM); default is  (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  (fully transparent) and   (fully opaque); default is


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


 * 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 . Higher numbers will result in a smoother circle but use more Lua processing resources.

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

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

For simple cases with a single feature, can be used instead (see that template's documentation for details).

The raw parameter
The "raw" parameter allows the same inputs as the full function. It allows you to: See mw:Help:Extension:Kartographer for instructions.
 * 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

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

Raw Wikidata query examples




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:
 * To fix it, put a space before the two template braces or move them to a separate line.