ਫਰਮਾ:Infobox mapframe/doc/parameters

Template documentation[ਦੇਖੋ] [ਸੋਧੋ] [ਅਤੀਤ] [ਤਾਜ਼ਾ ਕਰੋ]

Parameter documentation for {{Infobox mapframe}}, and infoboxes using Module:Infobox mapframe (auto function).

Usage

In the documentation page of the target template (could be the infobox), add {{Infobox mapframe/doc/parameters}}.

Parameter options are:

• Set |noprefix=yes to show without the "mapframe-" prefix – for use on Template:Infobox mapframe/doc.
• Set alternate default values by passing in parameters of the form parameter-name=value e.g. |mapframe-marker=building.
• Set |deprecated=yes to show deprecated parameters

Example

{{Infobox museum/doc}} has:

{{Infobox mapframe/doc/parameters
|mapframe-marker={{kbd|museum}}
}}

Shows documentation text:

mapframe-marker – Marker symbol to use for coordinates; see [...] for options. Default: museum

Corresponding with its template code:

| image4 = {{#invoke:Infobox mapframe| ... |mapframe-marker=museum}}

Parameters

Parameter list

<!-- Infobox mapframe: all parameters, no aliases (29) --> <!-- Basic parameters: --> | mapframe = | mapframe-caption = | mapframe-custom = | qid = | mapframe-coordinates = | mapframe-wikidata = <!-- Customise features displayed: --> | mapframe-shape = | mapframe-point = | mapframe-line = | mapframe-geomask = | mapframe-switcher = <!-- Other optional parameters: --> | mapframe-frame-width = | mapframe-frame-height = | mapframe-shape-fill = | mapframe-shape-fill-opacity = | mapframe-stroke-color = | mapframe-stroke-width = | mapframe-marker = | mapframe-marker-color = | mapframe-geomask-stroke-color = | mapframe-geomask-stroke-width = | mapframe-geomask-fill = | mapframe-geomask-fill-opacity = | mapframe-zoom = | mapframe-length_km = | mapframe-length_mi = | mapframe-area_km2 = | mapframe-area_mi2 = | mapframe-frame-coordinates = <!-- Infobox mapframe: parameters, including aliases (40) --> <!-- Basic parameters: --> | mapframe = | mapframe-caption = | mapframe-custom = | id = | mapframe-id = | qid = | mapframe-coordinates = | mapframe-coord = | coordinates = | coord = | mapframe-wikidata = <!-- Customise features displayed: --> | mapframe-shape = | mapframe-point = | mapframe-line = | mapframe-geomask = | mapframe-switcher = <!-- Other optional parameters: --> | mapframe-frame-width = | mapframe-width = | mapframe-frame-height = | mapframe-height = | mapframe-shape-fill = | mapframe-shape-fill-opacity = | mapframe-stroke-color = | mapframe-stroke-colour = | mapframe-stroke-width = | mapframe-marker = | mapframe-marker-color = | mapframe-marker-colour = | mapframe-geomask-stroke-color = | mapframe-geomask-stroke-colour = | mapframe-geomask-stroke-width = | mapframe-geomask-fill = | mapframe-geomask-fill-opacity = | mapframe-zoom = | mapframe-length_km = | mapframe-length_mi = | mapframe-area_km2 = | mapframe-area_mi2 = | mapframe-frame-coordinates = | mapframe-frame-coord =

Deprecated

Deprecated parameters
mapframe-frame-lat or mapframe-frame-latitude – Alternate latitude coordinate for initial placement of map; default is derived from item coordinates mapframe-frame-long or mapframe-frame-longitude – Alternate longitude coordinate for initial placement of map; default is derived from item coordinates

The above documentation is transcluded from ਫਰਮਾ:Infobox mapframe/doc/parameters/doc. (ਸੋਧੋ | ਅਤੀਤ)
Editors can experiment in this template's ਕੱਚਾ ਖ਼ਾਕਾ (ਬਣਾਓ | mirror) and testcases (ਬਣਾਓ) pages.
Add categories to the /doc subpage. Subpages of this template.

• Basic parameters:
  • 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" (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
  • mapframe-frame-coordinates or mapframe-frame-coord – Alternate latitude and longitude coordinates for initial placement of map, using {{coord}}. Default: derived from item coordinates