Template:Infobox mapframe/doc

This template generates a mapframe map, suitable for infoboxes, with minimal user input. This template only works with single features (points, lines, or shapes); use {{maplink}} if more advanced options, such as displaying multiple features, are required.

If coordinates are not supplied, they will be fetched from the page's Wikidata item. In such cases, if |point= is not set, then a point feature marker is displayed at those coordinates unless the Wikidata item has an (P402) specified.

• See Category:Infobox mapframe without OSM relation ID on Wikidata for pages which have items without (P402)
• Troubleshooting shapes guidance is found at Module talk:mapframe/FAQ

Usage

Note: When in mainspace, parameter |id= is not required (except to use a different page's data)

Basic

<syntaxhighlight lang="wikitext"></syntaxhighlight> When used without parameters, or with only |id=, the map will display either a shape, line, or point feature, depending on the data available on Wikidata and OpenStreetMap.

• If the Wikidata item does not specify a (P402) value, then a point marker will be displayed by default in addition any OSM shape or line feature.
• If the Wikidata items does not specify a (P625) or a (P3896) value, then no map will be displayed

Basic usage examples
Point feature (Wikidata coordinates): <syntaxhighlight lang="wikitext"></syntaxhighlight> Line feature: <syntaxhighlight lang="wikitext"></syntaxhighlight> Shape feature: <syntaxhighlight lang="wikitext"></syntaxhighlight>

Using specified coordinates instead of Wikidata

Point feature only, no shapes or lines: <syntaxhighlight lang="wikitext"></syntaxhighlight> Point feature and shape/line feature if available: <syntaxhighlight lang="wikitext"></syntaxhighlight>

Specify coordinates using the {{Coord}} templates, e.g. |coord={{Coord|32.1|S|116.2|E}}

• If |coord= is specified, then by default only that coordinate will be displayed (no line or shape features)
• If |coord= is specified and |wikidata=yes is used, then those coordinate will be displayed, along with any line or shape features linked to the Wikidata item.

Specified coordinates examples

Point feature (with coordinates specified, no shape/line feature from Wikidata item): <syntaxhighlight lang="wikitext"><mapframe zoom="10" frameless="1" align="center" longitude="115.96666666667" latitude="-31.933333333333" height="200" width="270">{"type":"Feature","geometry":{"coordinates":[115.96666666666667,-31.933333333333334],"type":"Point"},"properties":{"title":"Infobox mapframe/doc","marker-color":"#5E74F3"}}</mapframe></syntaxhighlight> <mapframe zoom="10" frameless="1" align="center" longitude="115.96666666667" latitude="-31.933333333333" height="200" width="270">{"type":"Feature","geometry":{"coordinates":[115.96666666666667,-31.933333333333334],"type":"Point"},"properties":{"title":"Infobox mapframe/doc","marker-color":"#5E74F3"}}</mapframe> Point feature (with coordinates specified, along with shape/line feature from Wikidata item): <syntaxhighlight lang="wikitext"><mapframe zoom="10" frameless="1" align="center" longitude="115.96666666667" latitude="-31.933333333333" height="200" width="270">{"type":"Feature","geometry":{"coordinates":[115.96666666666667,-31.933333333333334],"type":"Point"},"properties":{"title":"Infobox mapframe/doc","marker-color":"#5E74F3"}}</mapframe></syntaxhighlight> <mapframe zoom="10" align="center" frameless="1" height="200" width="270">[ {"properties":{"title":"Infobox mapframe/doc","fill-opacity":0.5,"stroke":"#FF0000","stroke-width":3,"fill":"#606060"},"type":"ExternalData","service":"geoshape","ids":"Q45935"}, {"properties":{"stroke-width":5,"stroke":"#FF0000","title":"Infobox mapframe/doc"},"type":"ExternalData","service":"geoline","ids":"Q45935"}, {"type":"Feature","geometry":{"coordinates":[115.96666666666667,-31.933333333333334],"type":"Point"},"properties":{"title":"Infobox mapframe/doc","marker-color":"#5E74F3"}} ]</mapframe>

Customizing which features are displayed

Inverse shape

<syntaxhighlight lang="wikitext"></syntaxhighlight> Replace the shape with an inverse-shape (geomask) by setting |shape=inverse

Inverse shape example
<syntaxhighlight lang="wikitext"></syntaxhighlight>

Turn point marker on or off

Force point marker to be displayed: <syntaxhighlight lang="wikitext"></syntaxhighlight> Prevent point marker from being displayed: <syntaxhighlight lang="wikitext"></syntaxhighlight>

Turn shape feature off

Prevent shape feature from being displayed: <syntaxhighlight lang="wikitext"></syntaxhighlight>

Turn line feature off

Prevent line feature from being displayed: <syntaxhighlight lang="wikitext"></syntaxhighlight>

Show a geomask from a related Wikidata item

<syntaxhighlight lang="wikitext"></syntaxhighlight> Set |geomask= to a Wikidata item id (Q-number), or property id (P-number) such as (P17)

Geomask examples
Use the item linked from the (P17) statement as a geomask: <syntaxhighlight lang="wikitext"></syntaxhighlight> Use the item (Q1199) as a geomask: <syntaxhighlight lang="wikitext"></syntaxhighlight>

Determine zoom from object length or area

Use |length_km= or |length_mi= or |area_km2= or |area_mi2=

Zoom from length/area examples
Determine zoom from object length in kilometres or miles <syntaxhighlight lang="wikitext"></syntaxhighlight> <syntaxhighlight lang="wikitext"></syntaxhighlight> Determine zoom from object area in square kilometres or square miles <syntaxhighlight lang="wikitext"></syntaxhighlight> <syntaxhighlight lang="wikitext"></syntaxhighlight>

Parameters

All parameters are optional.

• Basic parameters:
  • id – Id (Q-number) of Wikidata item to use. Default: item for current page
  • coordinates or coord – Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template, e.g. |coord={{Coord|12.34|N|56.78|E}}. Default: coordinates from Wikidata
  • wikidata – Set to <syntaxhighlight lang="text" class="" style="" inline="1">yes</syntaxhighlight> to show shape/line features from the wikidata item, if any, when |coord= is set. Default: not specified
• Customise which features are displayed:
  • shape – Turn off display of shape feature by setting to <syntaxhighlight lang="text" class="" style="" inline="1">none</syntaxhighlight>. Use an inverse shape (geomask) instead of a regular shape by setting to <syntaxhighlight lang="text" class="" style="" inline="1">inverse</syntaxhighlight>. Default: not specified
  • point – Turn off display of point feature by setting to <syntaxhighlight lang="text" class="" style="" inline="1">none</syntaxhighlight>. Force point marker to be displayed by setting to <syntaxhighlight lang="text" class="" style="" inline="1">on</syntaxhighlight>. Default: not specified
  • line – Turn off display of line feature by setting to <syntaxhighlight lang="text" class="" style="" inline="1">none</syntaxhighlight>. Default: not specified
  • geomask – Wikidata item to use as a geomask (everything outside the boundary is shaded darker). Can either be a specific Wikidata item (Q-number), or a property that specifies the item to use (e.g. P17 for (P17), P131 for (P131)). Default: not specified
  • switcher – set to <syntaxhighlight lang="text" class="" style="" inline="1">auto</syntaxhighlight> or <syntaxhighlight lang="text" class="" style="" inline="1">geomasks</syntaxhighlight> or <syntaxhighlight lang="text" class="" style="" inline="1">zooms</syntaxhighlight> to enable Template:Switcher-style switching between multiple mapframes. Default: not specified
    • <syntaxhighlight lang="text" class="" style="" inline="1">auto</syntaxhighlight> – switch geomasks found in (P276) and (P131) statements on the page's Wikidata item, searching recursively. E.g. an item's city, that city's state, and that state's country.
    • <syntaxhighlight lang="text" class="" style="" inline="1">geomasks</syntaxhighlight> – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the geomask parameter
    • <syntaxhighlight lang="text" class="" style="" inline="1">zooms</syntaxhighlight> – switch between "zoomed in"/"zoomed midway"/"zoomed out", where "zoomed in" is the default zoom (with a minimum of <syntaxhighlight lang="text" class="" style="" inline="1">3</syntaxhighlight>), "zoomed out" is <syntaxhighlight lang="text" class="" style="" inline="1">1</syntaxhighlight>, and "zoomed midway" is the average
• Other optional parameters:
  • frame-width or width – Frame width. Default: 270
  • frame-height or height – Frame height. Default: 200
  • shape-fill – Color used to fill shape features. Default: #606060
  • shape-fill-opacity – Opacity level of shape fill, a number between 0 and 1. Default: 0.5
  • stroke-color or stroke-colour – Color of line features, and outlines of shape features. Default: #ff0000
  • stroke-width – Width of line features, and outlines of shape features; default is "5". Default: 5
  • marker – Marker symbol to use for coordinates; see mw:Help:Extension:Kartographer/Icons for options. Default: not specified (i.e. blank)
    • Can also be set to <syntaxhighlight lang="text" class="" style="" inline="1">blank</syntaxhighlight> to override any default marker symbol
  • marker-color or marker-colour – Background color for the marker. Default: #5E74F3
  • geomask-stroke-color or geomask-stroke-colour – Color of outline of geomask shape. Default: #555555
  • geomask-stroke-width – Width of outline of geomask shape. Default: 2
  • geomask-fill – Color used to fill outside geomask features. Default: #606060
  • geomask-fill-opacity – Opacity level of fill outside geomask features, a number between 0 and 1. Default: 0.5
  • zoom – Set the zoom level, from "1" (map of earth) to "18" (maximum zoom in), to be used if the zoom level cannot be determined automatically from object length or area. Default: 10
  • length_km or length_mi or area_km2 or area_mi2 – Determine zoom level by passing in object's length (in kilometres or miles) or area (in square kilometres or square miles). Default: not specified
  • frame-coordinates or frame-coord – Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}. Default: derived from item coordinates
• Deprecated parameters
  • frame-lat or frame-latitude – Alternate latitude coordinate for initial placement of map; default is derived from item coordinates
  • frame-long or frame-longitude – Alternate longitude coordinate for initial placement of map; default is derived from item coordinates

Examples for use within templates

Infobox hospital
{{Infobox hospital}} (as of 5 October 2019) <syntaxhighlight lang="wikitext">	image3 =	caption3 = </syntaxhighlight>

Infobox power station
{{Infobox power station}} (as of 2 April 2019): <syntaxhighlight lang="wikitext">| image2 =	caption2 = </syntaxhighlight>

Infobox Australian road
{{Infobox Australian road}} (as of 5 October 2019): <syntaxhighlight lang="wikitext">	data3 = </syntaxhighlight>

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Infobox mapframe in articles based on its TemplateData.

TemplateData for Infobox mapframe

parameters

No description. Template parameters Parameter Description Type Status Show mapframe map mapframe Specify yes or no to show or hide the map, overriding the default Default no Example yes String suggested Mapframe caption mapframe-caption Caption for the map. If mapframe-geomask is set, then the default is "Location in <<geomask's label>>" String optional Custom mapframe mapframe-custom Use a custom map instead of the automatic mapframe. Specify either a {{maplink}} template, or another template that generates a mapframe map, or an image name. If used, other mapframe parameters will be ignored. Template optional Mapframe Wikidata item mapframe-id id qid Id (Q-number) of Wikidata item to use. Default (item for current page) String optional Mapframe coordinates mapframe-coordinates mapframe-coord coordinates coord Coordinates to use, instead of any on Wikidata. Use the {{Coord}} template. Default (coordinates from Wikidata) Example {{Coord|12.34|N|56.78|E}} Template optional Mapframe shapes from Wikidata mapframe-wikidata et to yes to show shape/line features from the wikidata item, if any, when coordinates are specified by parameter Example yes String optional Mapframe point feature mapframe-point Override display of mapframe point feature. Turn off display of point feature by setting to "none". Force point marker to be displayed by setting to "on" String optional Mapframe shape feature mapframe-shape Override display of mapframe shape feature. Turn off by setting to "none". Use an inverse shape (geomask) instead of a regular shape by setting to "inverse" String optional Mapframe width mapframe-frame-width mapframe-width Frame width in pixels Default 270 Number optional Mapframe height mapframe-frame-height mapframe-height Frame height in pixels Default 200 Number optional Mapframe shape fill mapframe-shape-fill Color used to fill shape features Default #606060 String optional Mapframe shape fill opacity mapframe-shape-fill-opacity Opacity level of shape fill, a number between 0 and 1 Default 0.5 Number optional Mapframe stroke color mapframe-stroke-color mapframe-stroke-colour Color of line features, and outlines of shape features Default #ff0000 String optional Mapframe stroke width mapframe-stroke-width Width of line features, and outlines of shape features Default 5 Number optional Mapframe marker mapframe-marker Marker symbol to use for coordinates; see [[mw:Help:Extension:Kartographer/Icons]] for options Example museum String optional Mapframe marker color mapframe-marker-color mapframe-marker-colour Background color for the marker Default #5E74F3 String optional Mapframe geomask mapframe-geomask Wikidata item to use as a geomask (everything outside the boundary is shaded darker). Can either be a specific Wikidata item (Q-number), or a property that specifies the item to use (e.g. P17 for country, or P131 for located in the administrative territorial entity) Example Q100 Page name optional Mapframe geomask stroke color mapframe-geomask-stroke-color mapframe-geomask-stroke-colour Color of outline of geomask shape Default #555555 String optional Mapframe geomask stroke width mapframe-geomask-stroke-width Width of outline of geomask shape Default 2 Number optional Mapframe geomask fill mapframe-geomask-fill Color used to fill outside geomask features Default #606060 String optional Mapframe geomask fill opacity mapframe-geomask-fill-opacity Opacity level of fill outside geomask features, a number between 0 and 1 Default 0.5 Number optional Mapframe zoom mapframe-zoom Set the zoom level, from "1" to "18", to used if the zoom level cannot be determined automatically from object length or area Default 10 Example 12 Number optional Mapframe length (km) mapframe-length_km Object length in kilometres, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area Number optional Mapframe length (mi) mapframe-length_mi Object length in miles, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area Number optional Mapframe area (km^2) mapframe-area_km2 Object arean square kilometres, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area Number optional Mapframe area (mi^2) mapframe-area_mi2 Object area in square miles, for automatically determining zoom level. ONLY use ONE of the available parameters for length or area Number optional Mapframe frame coordinates mapframe-frame-coordinates mapframe-frame-coord Alternate latitude and longitude coordinates for initial placement of map, using {{coord}} Example {{Coord|12.35|N|56.71|E}} Template optional Mapframe switcher mapframe-switcher Set to "auto" or "geomasks" or "zooms" to enable Template:Switcher-style switching between multiple mapframes. IF SET TO auto – switch geomasks found in location (P276) and located in the administrative territorial entity (P131) statements on the page's Wikidata item, searching recursively. E.g. an item's city, that city's state, and that state's country. IF SET TO geomasks – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the mapframe-geomask parameter. IF SET TO zooms – switch between "zoomed in"/"zoomed midway"/"zoomed out", where "zoomed in" is the default zoom (with a minimum of 3), "zoomed out" is 1, and "zoomed midway" is the average. String optional mapframe-line mapframe-line no description Unknown optional

See also

• Wikipedia:Mapframe maps in infoboxes, inclusion of this kind of functionality in infoboxes by default
• Wikipedia:Maps for Wikipedia, a list of mapping tools available on Wikipedia