MediaWiki extensions manual

Kartographer Release status: stable
Implementation	Tag
Description	Allows to add maps to pages as a frontend tomapping services
Author(s)	Yuri Astrakhan (yuriktalk)
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	1.39+
Database changes	No
License	MIT License
Download	Download extension Git[?]: Browse repository (GitHub) Gerrit code review Git commit log Download source tarball
Help	Help:Extension:Kartographer
Example	See below on this page
Parameters $wgKartographerSimpleStyleMarkers $wgKartographerSrcsetScales $wgKartographerStaticFullWidth $wgKartographerUsePageLanguage $wgKartographerStaticMapframe $wgKartographerDfltStyle $wgKartographerFallbackZoom $wgKartographerParsoidVersion $wgKartographerMapServer $wgKartographerWikivoyageMode $wgKartographerMediaWikiInternalUrl $wgKartographerStyles $wgKartographerUseMarkerStyle $wgKartographerNearby
Tags mapframe maplink
Hooks used ParserAfterParse ParserFirstCallInit
Quarterly downloads	48 (Ranked 68th)
Public wikis using	898 (Ranked 289th)
Translate the Kartographer extension if it is available at translatewiki.net
Issues	Open tasks ·Report a bug

TheKartographer extension lets you display maps (based aroundOpenStreetMap) in wiki pages.It was specifically designed in order to run on Wikimedia sites such as Wikivoyage and Wikipedia, although it can be used on any wiki.

Kartographer defines the wikitext tags‎<mapframe>...‎</mapframe> and‎<maplink>, which display a map and a link to a map on the page respectively.SeeHelp:Extension:Kartographer for how to call these tags.

Map ofLondon

• Install theJsonConfig extension as described in its documentation which is required to run this extension.
• Download and move the extractedKartographer folder to yourextensions/ directory.
  Developers and code contributors should install the extensionfrom Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Kartographer
• Only when installing from Git, runComposer to install PHP dependencies, by issuingcomposer install --no-dev in the extension directory.(SeeT173141 for potential complications.)
• Add the following code at the bottom of yourLocalSettings.php file:

  wfLoadExtension('Kartographer');

• Configure as required.
• Done – Navigate toSpecial:Version on your wiki to verify that the extension is successfully installed.

null

["osm-intl","osm"]

"osm-intl"

[1.3,1.5,2,2.6,3]

false

false

false

1024

true

13

true

This extension provides two internal APIs.

• Query mapdata
• Action sanitize mapdata

• Kartographer developer guide
• API documentation

Kartographer makes use of a suite of open-source, open-data tools for displaying maps:

• On the client side (within the browser):
  • Leaflet, a JavaScript mapping library
• On the server side:
  • Kartotherian, a map tile service developed by the Wikimedia Foundation, which itself contains code fromMapbox. Third party installations should use non-Wikimedia tile servers listed onopenstreetmap:Tile servers
• Generating the data in advance:
  • Tilerator - a tile pre-generation service also developed by the Wikimedia Foundation
  • OpenStreetMap - an open map data source, the source for the map data as well as for most of POIs.^[1]

For more information on these, seeWikimedia Maps.

For more information on the production aspects of running these services, see theWikitech Maps page.

• A simple method to insert a map into an article without requiring common.js code changes
• Ability to add extra information (marks, area, popups, text, links) to the map
• Ability to gather map usage statistics (KPI) to better gauge how and what should be improved.
• TBD: experimentation - if the user is aware of the privacy implications, the map should be able to show external data from non-production source, e.g. Static, server-side rendered images will not include the extra data added via this method until the extra data source is hosted in the secure production environment and can be shown without the user action.

Wikivoyage tends to have a large number of POIs listed on a page^[1] (seeexample).Each POI is usually added with a template, but all of them should appear on the same map.Also, each POI should be referable by showing an icon with a number, both in the text of the article, and on the map:

• Ability to incrementally add features to the map. For example, each usage of therestaurant template adds a single POI^[1], and the map shows all of them.
• Added features need to be indexable. E.g. the firstrestaurant template would show^[1] on the page, and map would show POI as a clickable^[1] element. There could be multiple index counters at the same time, each for its own type of POIs.

See the corresponding project(s) inPhabricator for acomplete list of bugs.

• Extension:Maps

This extension is being used on one or moreWikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia'sCommonSettings.php andInitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki'sSpecial:Version page.

This extension is included in the following wiki farms/hosts and/or packages: Miraheze WikiForge This is not an authoritative list.Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here.Always check with your wiki farms/hosts or bundle to confirm.

• Stable extensions
• Tag extensions
• MIT licensed extensions
• Extensions in Wikimedia version control
• ParserAfterParse extensions
• ParserFirstCallInit extensions
• All extensions
• Extensions requiring Composer with git
• Extensions used on Wikimedia
• Extensions included in Miraheze
• Extensions included in WikiForge
• Map extensions
• Discovery
• Extensions with VisualEditor support

• Extensions with release branches compatibility policy
• Extensions with manual MediaWiki version
• Pages using the Kartographer extension