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.

• A point marker will be displayed if local coordinates are supplied or if the page's Wikidata item does have an (P402) or a (P3896).
• Shapes/lines will be displayed if local coordinates are not supplied or if the Wikidata item has either an (P402) or a (P3896).
• No map will be shown if local coordinates are not supplied and if the Wikidata item does not have a (P625).

• See Category:Infobox mapframe without OSM relation ID on Wikidata for pages which have items without an OSM Relation or a Geoshape.
• 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 shape/line features, if they are available at OpenStreet Map.

• If the Wikidata item does not specify an (P402), a point marker will be additionally shown.

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 a point marker will always been shown and shape/line features will be shown only if the Wikidata item has an (P402) or a (P3896).
• If |coord= is specified and |wikidata=yes is used, then the point marker and any shape/line features will always be shown (if available on OpenStreetMap).

Specified coordinates examples

Point feature (with coordinates specified, no shape/line feature from Wikidata item): <syntaxhighlight lang="wikitext"></syntaxhighlight>

Point feature (with coordinates specified, along with shape/line feature from Wikidata item): <syntaxhighlight lang="wikitext"></syntaxhighlight>

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>

Setting the zoom level

The zoom level of the map can always be set by an editor via |zoom=. If not explicitly set, the zoom is determined automatically:

• If the Wikidata item has an (P402) or (P3896), then the center and zoom of the image is set to nicely frame the shape/line.
• If the Wikidata item has an (P6592), it will be used as the zoom level
• Any of the following parameters will specify a zoom level:
  • |length_km=
  • |length_mi=
  • |width_km=
  • |width_mi=
  • |area_km2=
  • |area_mi2=
  • |area_ha=
  • |area_acre=
• The zoom will be set by specifying the |type= of the object, with the same usage as {{coord}}. For example, |type=city. In the case of a city, the population can determine the zoom by specifying |population=.

Zoom examples

Set zoom manually <syntaxhighlight lang="wikitext"></syntaxhighlight>

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 {{Infobox mapframe}} parameters:
  • id – Id (Q-number) of Wikidata item to use. Default: item for current page
  • wikidata – Set to <syntaxhighlight lang="text" class="" style="" inline="1">yes</syntaxhighlight> to show all shape/line features from OpenStreetMap. Default: not specified
• Customise which features are displayed:
  • 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
  • shape – Turn off display of shape feature by setting to <syntaxhighlight lang="text" class="" style="" inline="1">none</syntaxhighlight>. Force display of shape by setting to <syntaxhighlight lang="text" class="" style="" inline="1">on</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
  • line – Turn off display of line feature by setting to <syntaxhighlight lang="text" class="" style="" inline="1">none</syntaxhighlight>. Force display of line by setting to <syntaxhighlight lang="text" class="" style="" inline="1">on</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.1
  • stroke-color or stroke-colour – Color of line features, and outlines of shape features. Default: #ff0000
    • line-stroke-color or line-stroke-colour – Color of line features. Default: #ff0000
    • shape-stroke-color or shape-stroke-colour – Color of outlines of shape features. Default: #ff0000
  • stroke-width – Width of line features, and outlines of shape features. Default: 2
    • shape-stroke-width – Width of outlines of shape features. Default: 2
    • line-stroke-width – Width of line features. 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: 1
  • 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.25
  • 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 / not specified / not specified / not specified
  • frame-coordinates or frame-coord – Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}. Default: derived from item coordinates
  • type – Set the type of the object, with the same usage as {{coord}}. Default: not specified
  • population – Set the population, useful with type="city", for {{Infobox dim}}. Default: not specified

• 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

Use within templates

Please use Module:Infobox mapframe#Automatic maps in infoboxes.

FAQ

Q1: Where to file a bug report when there is a problem with the base map? (e.g. a missing lake)

A1: If the problem also occurs on OpenStreetMap, it needs to be fixed there. If the problem is only on Wikimedia's maps, it can be reported on Phabricator (you can log in with you Wikipedia account). See mw:How to report a bug for instructions (for the tags, use Maps). (Alternatively, you can try mw:Help talk:Extension:Kartographer)

Q2: Where to report other bugs or problems with the maps?

A2: This may be a problem with the Wikipedia module, or it may be an underlying software bug (there are lots of those).

• If the problem also occurs when using plain <mapframe>...</mapframe> tags, then it should be reported on Phabricator (you can log in with you Wikipedia account). See mw:How to report a bug for instructions (for the tags, use Maps). (Alternatively, you can try mw:Help talk:Extension:Kartographer)
• If the problem only occurs with Wikipedia's template/module, or you're not sure, report it here. (Alternatively, you can try Wikipedia:Village pump (technical))

Q3: Why does the thumbnail map render as a static image when viewing pages, but is interactive when editing pages?

A3: On Wikipedia, and most wikis other than Wikivoyage, the emdeded thumbnail is a static map, and the full screen map needs to be opened before the map can be zoomed or panned. This is for for performance reasons, and to present some content if javascript is disabled, and for printing.
That preview mode shows an interactive map is a bug, phab:T203863 (and also a performance issue). Further explanation can be found in the comments on phab:T202793.

Q4: Why is a line or shape feature from OpenStreetMap not being shown?

A4: There are several possible causes:

• The feature on OSM needs to be tagged with the Wikidata id, per mw:Help:Extension:Kartographer/OSM. It is not enough to just set (P402) on the Wikidata item.
• Only certain OSM relations (those with type=multipolygon, type=route, type=waterway and type=boundary) can be used, and not others like buildings and public transport master routes. See mw:Help:Extension:Kartographer/OSM#Limitation and phab:T156433.
• It can take 1 or 2 days after tagging on OSM before the data is available here.
• Wikimedia occasionally has problems replicating OSM data (e.g. phab:T218097), or intentionally disables replication due to other problems (e.g. phab:T243609)

Q5: Why are line, shape, or point features are not shown after editing or adding a map, even though they were shown in the page preview?

A5: This is a bug related to generating thumbnail map images. It should fix itself in an hour or two. See phab:T269984 for details.

Q6: A page using mapframe's |raw= parameter is showing error messages of "The time allocated for running scripts has expired." What can be done?

A6: If the amount of raw data to be processed is too large, that timeout message may be shown. You can try moving the raw data to Commons (example) or replacing the mapframe template with the equivalent wikitext using Special:ExpandTemplates (example)

Template Data

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

TemplateData documentation used by VisualEditor and other tools

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	caption	Caption for the map. If geomask is set, then the default is "Location in <<geomask's label>>"	String	optional
Custom 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	id id qid	Id (Q-number) of Wikidata item to use. Default (item for current page)	String	optional
Mapframe coordinates	coordinates 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	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	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	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	frame-width width	Frame width in pixels Default 270	Number	optional
Mapframe height	frame-height height	Frame height in pixels Default 200	Number	optional
Mapframe shape fill	shape-fill	Color used to fill shape features Default #606060	String	optional
Mapframe shape fill opacity	shape-fill-opacity	Opacity level of shape fill, a number between 0 and 1 Default 0.1	Number	optional
Mapframe stroke color	stroke-color stroke-colour	Color of line features, and outlines of shape features Default #ff0000	String	optional
Mapframe stroke width	stroke-width	Width of line features, and outlines of shape features Default 2	Number	optional
Mapframe line stroke color	line-stroke-color line-stroke-colour	Color of line features Default #ff0000	String	optional
Mapframe line stroke width	line-stroke-width	Width of line features Default 5	Number	optional
Mapframe shape stroke color	shape-stroke-color shape-stroke-colour	Color of outlines of shape features Default #ff0000	String	optional
Mapframe shape stroke width	shape-stroke-width	Width of outlines of shape features Default 2	Number	optional
Mapframe marker	marker	Marker symbol to use for coordinates; see [[mw:Help:Extension:Kartographer/Icons]] for options Example museum	String	optional
Mapframe marker color	marker-color marker-colour	Background color for the marker Default #5E74F3	String	optional
Mapframe geomask	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	geomask-stroke-color geomask-stroke-colour	Color of outline of geomask shape Default #555555	String	optional
Mapframe geomask stroke width	geomask-stroke-width	Width of outline of geomask shape Default 1	Number	optional
Mapframe geomask fill	geomask-fill	Color used to fill outside geomask features Default #606060	String	optional
Mapframe geomask fill opacity	geomask-fill-opacity	Opacity level of fill outside geomask features, a number between 0 and 1 Default 0.25	Number	optional
Mapframe zoom	zoom	Set the zoom level, from "1" to "18", to used if the zoom level cannot be determined automatically from object length or area. NB: default may also be set by Kartographer automatically based on the features rendered. Default 10 Example 12	Number	optional
Mapframe length (km)	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)	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)	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)	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	frame-coordinates 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	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 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 feature	line	Turn off display of line feature by setting to none. Force display of line by setting to on.	String	optional
Mapframe type	type	Type of the object rendered in the mapframe, like with {{coord}}.	String	optional

Tracking category

• Category:Pages using infobox mapframe with unknown parameters (0)
• Category:Pages using infobox mapframe with missing coordinates (0)
• Category:Pages using infobox mapframe with forced centering (0)

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