Difference between revisions of "Template:Infobox mapframe/doc/parameters"

From blackwiki
Jump to navigation Jump to search
imported>Evad37
(add includeonly navbar)
imported>Evad37
(allow setting default value for mapframe-caption)
Line 6: Line 6:
 
*Basic parameters:{{#if:{{{noprefix|}}}||<nowiki></nowiki>
 
*Basic parameters:{{#if:{{{noprefix|}}}||<nowiki></nowiki>
 
**'''mapframe''' – Specify yes or no to show or hide the map, overriding the default. ''Default:'' {{{mapframe|no}}}
 
**'''mapframe''' – Specify yes or no to show or hide the map, overriding the default. ''Default:'' {{{mapframe|no}}}
**'''mapframe-caption''' – Caption for the map. ''Default'': ''blank'' (or if {{para|mapframe-geomask}} is set, "Location in {{kbd|geomask's label}}")
+
**'''mapframe-caption''' – Caption for the map. ''Default'': {{{mapframe-caption|''blank'' (or if {{para|mapframe-geomask}} is set, "Location in {{kbd|geomask's label}}")}}}
 
**'''mapframe-custom''' – Use a custom map instead of the automatic mapframe. Specify either a {{tlx|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-custom''' – Use a custom map instead of the automatic mapframe. Specify either a {{tlx|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''}}
 
**'''{{#if:{{{noprefix|}}}||mapframe-}}id''' – Id (Q-number) of Wikidata item to use. ''Default:'' ''item for current page''
 
**'''{{#if:{{{noprefix|}}}||mapframe-}}id''' – Id (Q-number) of Wikidata item to use. ''Default:'' ''item for current page''

Revision as of 16:41, 19 June 2020

Template documentation

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

  • Set |noprefix=yes to show without the "mapframe-" prefix.
  • Set alternate default values by passing in parameters of the form parameter-name=value e.g. |mapframe-marker=church.
  • Set |deprecated=yes to show deprecated parameters
  • 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 – Id (Q-number) of Wikidata item to use. Default: item for current page
    • mapframe-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
  • Customize 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
  • Other optional parameters:
    • mapframe-frame-width – Frame width. Default: 270
    • mapframe-frame-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)
    • mapframe-marker-color or mapframe-marker-colour – Background color for the marker. Default: #5E74F3
    • 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 Lua error in Module:Wd at line 196: attempt to index field 'wikibase' (a nil value). (P17), P131 for Lua error in Module:Wd at line 196: attempt to index field 'wikibase' (a nil value). (P131)). Default: not specified
    • 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