This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected.
Edit the infobox template (or its sandbox).
Add lines like the following examples to the infobox. Replace numbers (4, or 97 to 99), with the appropriate number based on how many other image or data parameters are already present.
Once this is done, the above parameters will be available to users of the template.
Defaults values for these parameters can also be specified in the #invoke calls above, e.g. {{#invoke:Infobox mapframe|auto|mapframe-marker=library}} means that the library marker will be used, unless a different value is passed in to the template.
The maps are off by default, which means maps will not be displayed unless |mapframe=yes is present in the template call. To turn maps on by default, in the #invoke calls above add |onByDefault=yes – which means maps will be displayed unless |mapframe=no is present in the template call. onByDefault can also be set to a conditional, such as if another parameters is present, e.g. |onByDefault={{#if:{{{pushpin_map|}}}|no|yes}}
Add the new parameters to the document. You can use {{Infobox mapframe/doc/parameters}}. Specify default values (if any are used in the #invoke calls) using by adding parameters in the form |parameter-name=value. The default output is shown here collapsed:
mapframe – Specify yes or no to show or hide the map, overriding the default. Default: no
mapframe-caption – Caption for the map. Default: blank (or if |mapframe-geomask= is set, "Location in geomask's label")
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, the subsequent mapframe parameters will be ignored. Default: not specified
mapframe-id or id or qid – Id (Q-number) of Wikidata item to use. Default:item for current page
mapframe-coordinates or mapframe-coord or 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
mapframe-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:
mapframe-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
mapframe-point – Turn off display of point feature by setting to none. Force point marker to be displayed by setting to on. Default:not specified
mapframe-line – Turn off display of line feature by setting to none. Default:not specified
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 රට (P17), P131 for එය පිහිටා ඇති පරිපාලන ඒකකය (P131)). Default:not specified
mapframe-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 පිහිටීම (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.
geomasks – switch between the geomasks specified as a comma-separated list of Wikidata items (Q-numbers) in the mapframe-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:
mapframe-frame-width or mapframe-width – Frame width. Default: 270
mapframe-frame-height or mapframe-height – Frame height. Default: 200
mapframe-shape-fill – Color used to fill shape features. Default: #606060
mapframe-shape-fill-opacity – Opacity level of shape fill, a number between 0 and 1. Default: 0.5
mapframe-stroke-color or mapframe-stroke-colour – Color of line features, and outlines of shape features. Default: #ff0000
mapframe-stroke-width – Width of line features, and outlines of shape features; default is "5". Default: 5
mapframe-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
mapframe-marker-color or mapframe-marker-colour – Background color for the marker. Default: #5E74F3
mapframe-geomask-stroke-color or mapframe-geomask-stroke-colour – Color of outline of geomask shape. Default: #555555
mapframe-geomask-stroke-width – Width of outline of geomask shape. Default: 2
mapframe-geomask-fill – Color used to fill outside geomask features. Default: #606060
mapframe-geomask-fill-opacity – Opacity level of fill outside geomask features, a number between 0 and 1. Default: 0.5
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
mapframe-length_km or mapframe-length_mi or mapframe-area_km2 or mapframe-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
mapframe-frame-coordinates or mapframe-frame-coord – Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}. Default:derived from item coordinates
