Module:Infobox mapframe/doc

This module implements {{Infobox mapframe}}.

See Template:Infobox mapframe/testcases for tests.

Usage

Module that automatically makes a mapframe suitable for an infobox automatically, with minimal user input.

Generic usage

Just use the template {{Infobox mapframe}}, following the documentation there. This module may also be imported to another Lua module.

Automatic maps in infoboxes

Example edits: Template:Infobox prison, Template:Infobox prison/doc

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.

If placing near the top of infobox	If placing at/near the bottom of the infobox
| image4 = {{#invoke:Infobox mapframe|autoWithCaption}}	| header97 = {{#if:{{{mapframe|}}}|Location}} | data98 = {{#invoke:Infobox mapframe|autoWithCaption}}

If the template has a call to {{#invoke:Check for unknown parameters|check}}, simply add |mapframe_args=y to the call and the various mapframe args will automatically be included.

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
  | autoWithCaption
  | 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 template documentation.

  You can use {{Infobox mapframe/doc/parameters}}.

  If any default values are modified in the #invoke calls, add them as parameters in the form |parameter-name=value.

  The default output is shown here collapsed:

Extended content

• Basic {{Infobox mapframe}} parameters:
  • mapframe – Specify yes or no to show or hide the map, overriding the default. Default: no
    • Internal onByDefault parameter: not specified
  • 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 d:Property:P625
  • 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, most 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-wikidata – Set to yes to show all shape/line features from OpenStreetMap. Default: not specified
• Customise which features are displayed:
  • 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-shape – Turn off display of shape feature by setting to none. Force display of shape by setting to on. Use an inverse shape (geomask) instead of a regular shape by setting to inverse. Default: not specified
  • mapframe-line – Turn off display of line feature by setting to none. Force display of line by setting to on. 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 country (P17), P131 for located in the administrative territorial entity (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 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 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.1
  • mapframe-stroke-color or mapframe-stroke-colour – Color of line features, and outlines of shape features. Default: #ff0000
    • mapframe-line-stroke-color or mapframe-line-stroke-colour – Color of line features. Default: #ff0000
    • mapframe-shape-stroke-color or mapframe-shape-stroke-colour – Color of outlines of shape features. Default: #ff0000
  • mapframe-stroke-width – Width of line features, and outlines of shape features. Default: 2
    • mapframe-shape-stroke-width – Width of outlines of shape features. Default: 2
    • mapframe-line-stroke-width – Width of line features. 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: 1
  • 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.25
  • mapframe-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
  • 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 / not specified / not specified / 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
  • mapframe-type – Set the type of the object, with the same usage as {{coord}}. Default: not specified
  • mapframe-population – Set the population, useful with type="city", for {{Infobox dim}}. Default: not specified

• Parameters can also be added to the TemplateData, which can be copied and pasted from the relevant parts of
• For a list of available markers, see mw:Help:Extension:Kartographer/Icons

See also

• Wikipedia:Mapframe maps in infoboxes
• Module:Mapframe & Template:Maplink