Template:Infobox mapframe/sandbox

This is the template sandbox page for Template:Infobox mapframe (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 92,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.

Preview message: Transclusion count updated automatically (see documentation).

This template uses Lua:

Module:Infobox mapframe (sandbox)

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 OpenStreetMap relation ID (P402) specified.

See Category:Infobox mapframe without OSM relation ID on Wikidata for pages which have items without OpenStreetMap relation ID (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

{{Infobox mapframe}}

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 OpenStreetMap relation ID (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 coordinate location (P625) or a geoshape (P3896) value, then no map will be displayed

Basic usage examples

Point feature (Wikidata coordinates):

{{Infobox mapframe |id=Q7270550}}

Line feature:

{{Infobox mapframe |id=Q1318331}}

Shape feature:

{{Infobox mapframe |id=Q61}}

Using specified coordinates instead of Wikidata

Point feature only, no shapes or lines:

{{Infobox mapframe |coord=}}

Point feature and shape/line feature if available:

{{Infobox mapframe |wikidata=yes |coord=}}

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):

{{infobox mapframe |coord={{coord|31|56|S|115|58|E}} }}

Point feature (with coordinates specified, along with shape/line feature from Wikidata item):

{{infobox mapframe |wikidata=yes |coord={{coord|31|56|S|115|58|E}} }}

Customizing which features are displayed

Inverse shape

{{Infobox mapframe |shape=inverse}}

Replace the shape with an inverse-shape (geomask) by setting |shape=inverse

Inverse shape example
{{Infobox mapframe \|id=Q61 \|shape=inverse}}

Turn point marker on or off

Force point marker to be displayed:

{{Infobox mapframe |point=on}}

Prevent point marker from being displayed:

{{Infobox mapframe |point=none}}

Turn shape feature off

Prevent shape feature from being displayed:

{{Infobox mapframe |shape=none}}

Turn line feature off

Prevent line feature from being displayed:

{{Infobox mapframe |line=none}}

Show a geomask from a related Wikidata item

{{Infobox mapframe |geomask=}}

Set |geomask= to a Wikidata item id (Q-number), or property id (P-number) such as country (P17)

Geomask examples

Use the item linked from the country (P17) statement as a geomask:

{{Infobox mapframe |id=Q3239281 |geomask=P17}}

Use the item Hesse (Q1199) as a geomask:

{{Infobox mapframe |id=Q3239281 |geomask=Q1199}}

Determine zoom from object length or area

Use any of the following parameters to specify an object's dimension:

|length_km=
|length_mi=
|width_km=
|width_mi=
|area_km2=
|area_mi2=
|area_ha=
|area_acre=

Additionally, the zoom of the mapframe can 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 from length/area examples

Determine zoom from object length in kilometres or miles

{{Infobox mapframe |id=Q1318331 |length_km=5.6}}

{{Infobox mapframe |id=Q1318331 |length_mi=3.5}}

Determine zoom from object area in square kilometres or square miles

{{Infobox mapframe |id=Q100 |area_km2=232.14}}

{{Infobox mapframe |id=Q100 |area_mi2=89.63}}

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 yes 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 none. Use an inverse shape (geomask) instead of a regular shape by setting to inverse. Default: not specified
- point – Turn off display of point feature by setting to none. Force point marker to be displayed by setting to on. Default: not specified
- line – Turn off display of line feature by setting to none. 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 country (P17), P131 for located in the administrative territorial entity (P131)). Default: not specified
- switcher – set to auto or geomasks or zooms to enable Template:Switcher-style switching between multiple mapframes. Default: not specified
  - 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.
  - geomasks – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the geomask parameter
  - 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
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 blank 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)

|image3    = {{yesno|{{{mapframe|yes}}}|no=|yes={{Infobox mapframe
 |zoom={{{mapframe-zoom|}}}
 |frame-width={{{mapframe-width|}}}
 |frame-height={{{mapframe-height|}}}
 |marker={{{mapframe-marker|hospital}}}
 |marker-color={{{mapframe-marker-color|{{{mapframe-marker-colour|}}}}}}
 |frame-lat={{{mapframe-lat|{{{mapframe-latitude|}}}}}}
 |frame-long={{{mapframe-long|{{{mapframe-longitude|}}}}}}
 |stroke-color={{{mapframe-stroke-color|{{{mapframe-stroke-colour|}}}}}}
 }}
}}
|caption3 = {{yesno|{{{mapframe|yes}}}|no=|yes={{{mapframe-caption|}}}}}

Infobox power station

{{Infobox power station}} (as of 2 April 2019):

| image2        = {{#ifeq:{{{location_map|}}}|no|<!-- -->|{{Infobox mapframe
                  |id                    = {{{qid|}}}
                  |coord                 = {{{coordinates|}}}
                  |frame-width           = {{Digits|1={{#if:{{{image_size|}}}|{{{image_size|}}}|300px}}}}
                  |marker                = industrial
                  |zoom                  = {{#if:{{{location_map_geomask|}}}|{{{location_map_zoom|}}}|{{{location_map_zoom|5}}}}}
                  |geomask               = {{#ifeq:{{{location_map_geomask|}}}|Yes|P17|<!-- -->}}
                  |geomask-stroke-width  = {{#ifeq:{{{location_map_geomask|}}}|Yes|0.5|<!-- -->}}
                  |geomask-stroke-colour = {{#ifeq:{{{location_map_geomask|}}}|Yes|#000000|<!-- -->}}
                  |geomask-fill          = {{#ifeq:{{{location_map_geomask|}}}|Yes|#BABABA|<!-- -->}}
                  }}}}
| caption2      = {{#ifeq:{{{location_map|}}}|no|<!-- -->|{{#if:{{{coordinates|}}}{{#property:P625}}|{{{location_map_caption|}}}}}}}

Infobox Australian road

{{Infobox Australian road}} (as of 5 October 2019):

| data3        = {{#ifexist:media:{{{location|}}}<!--
-->|[[File:{{{location}}}|270px|frameless|alt={{{location_alt|{{{loc_alt|{{{alt|}}}}}}}}}]]<!--
-->|{{{location|<!--
   -->{{yesno| {{{mapframe|yes}}}<!--
   -->|no=<!--
   -->|yes={{Infobox mapframe | length_km={{{length|}}} }}<!-- Tracking category:
    -->{{main other|{{#if:{{#property:P625}}|[[Category:Infobox Australian road articles with an infobox mapframe map|{{#if:{{{coordinates_a|}}}|π}}{{PAGENAME}}]]}}}}<!--
   -->}}<!--
 -->}}}<!--
-->}}

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 OpenStreetMap relation ID (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)

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[Edit template data]
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