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

From blackwiki
Jump to navigation Jump to search
imported>Evad37
(mapframe_ → mapframe-; add mapframe-custom)
imported>Evad37
(change to bullet list to take up less vertical space)
Line 3: Line 3:
 
* Set alternate default values by passing in parameters of the form ''parameter-name''=''value'' e.g. {{para|mapframe-marker|church}}.  
 
* Set alternate default values by passing in parameters of the form ''parameter-name''=''value'' e.g. {{para|mapframe-marker|church}}.  
 
* Set {{para|deprecated|yes}} to show deprecated parameters
 
* Set {{para|deprecated|yes}} to show deprecated parameters
}}</noinclude>Basic parameters:
+
}}</noinclude><nowiki/>
{{#if:{{{noprefix|}}}||<nowiki></nowiki>
+
*Basic parameters:{{#if:{{{noprefix|}}}||<nowiki></nowiki>
;'''mapframe'''
+
**'''mapframe''' Specify yes or no to show or hide the map, overriding the default. ''Default:'' {{{mapframe|no}}}
:Specify yes or no to show or hide the map, overriding the default
+
**'''mapframe-caption''' Caption for the map. ''Default'': ''blank'' (or if {{para|mapframe-geomask}} is set, "Location in {{kbd|geomask's label}}")
:''Default:'' {{{mapframe|no}}}
+
**'''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-caption'''
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}id''' – Id (Q-number) of Wikidata item to use. ''Default:'' ''item for current page''
:Caption for the map
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}coord''' – Coordinates to use, instead of any on Wikidata. Use the {{tl|Coord}} template, e.g. {{para|coord|2={{tlx|Coord|12.34|N|56.78|E}}}}. ''Default:'' ''coordinates from Wikidata''
:''Default'': ''blank'' (or if {{para|mapframe-geomask}} is set, "Location in {{kbd|geomask's label}}")
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}wikidata''' – Set to {{code|yes}} to show shape/line features from the wikidata item, if any, when {{para|coord}} is set. ''Default:'' {{{mapframe-wikidata|''not specified''}}}
;'''mapframe-custom'''
+
*Customize which features are displayed:
: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.
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}shape''' – Turn off display of shape feature by setting to {{code|none}}. Use an inverse shape (geomask) instead of a regular shape by setting to {{code|inverse}}. ''Default:'' {{{mapframe-shape|''not specified''}}}
:''Default'': ''not specified''
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}point''' – Turn off display of point feature by setting to {{code|none}}. Force point marker to be displayed by setting to {{code|on}}. ''Default:'' {{{mapframe-point|''not specified''}}}
}}
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}line''' – Turn off display of line feature by setting to {{code|none}}. ''Default:'' {{{mapframe-line|''not specified''}}}
;{{#if:{{{noprefix|}}}||mapframe-}}id
+
*Other optional parameters:
:Id (Q-number) of Wikidata item to use, instead of the current page's item
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}frame-width''' – Frame width. ''Default:'' {{{mapframe-frame-width|270}}}
:''Default:'' ''item for current page''
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}frame-height''' – Frame height. ''Default:'' {{{mapframe-frame-height|200}}}
;{{#if:{{{noprefix|}}}||mapframe-}}coord
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}shape-fill''' – Color used to fill shape features. ''Default:'' {{{mapframe-shape-fill|#606060}}}
:Coordinates to use instead, of any on Wikidata. Use the {{tl|Coord}} template, e.g. {{para|coord|2={{tlx|Coord|12.34|N|56.78|E}}}}
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}shape-fill-opacity''' – Opacity level of shape fill, a number between 0 and 1. ''Default:'' {{{mapframe-shape-fill-opacity|0.5}}}
:''Default:'' ''coordinates from Wikidata''
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}stroke-color''' or '''{{#if:{{{noprefix|}}}||mapframe-}}stroke-colour''' Color of line features, and outlines of shape features. ''Default:'' {{{mapframe-stroke-color|{{{mapframe-stroke-colour|#ff0000}}}}}}
;{{#if:{{{noprefix|}}}||mapframe-}}wikidata
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}stroke-width''' – Width of line features, and outlines of shape features; default is "5". ''Default:'' {{{mapframe-stroke-width|5}}}
:Set to {{code|yes}} to show shape/line features from the wikidata item, if any, when {{para|coord}} is set.
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}marker''' – Marker symbol to use for coordinates; see [[mw:Help:Extension:Kartographer/Icons]] for options.''Default:'' {{{mapframe-marker|''not specified (i.e. blank)''}}}
:''Default:'' {{{mapframe-wikidata|''not specified''}}}
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}marker-color''' or '''{{#if:{{{noprefix|}}}||mapframe-}}marker-colour''' Background color for the marker. ''Default:'' {{{mapframe-marker-color|{{{mapframe-marker-colour|#5E74F3}}}}}}
 
+
**'''{{#if:{{{noprefix|}}}||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. <code>P17</code> for {{Q|P17}}, <code>P131</code> for {{Q|P131}}). ''Default:'' {{{mapframe-marker|''not specified''}}}
 
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}geomask-stroke-color''' or '''{{#if:{{{noprefix|}}}||mapframe-}}geomask-stroke-colour''' Color of outline of geomask shape. ''Default:'' {{{mapframe-geomask-stroke-color|{{{mapframe-geomask-stroke-colour|#555555}}}}}}
Customize which features are displayed:
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}geomask-stroke-width''' – Width of outline of geomask shape. ''Default:'' {{{mapframe-geomask-stroke-width|2}}}
;{{#if:{{{noprefix|}}}||mapframe-}}shape
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}geomask-fill''' – Color used to fill outside geomask features. ''Default:'' {{{mapframe-geomask-fill|#606060}}}
:Turn off display of shape feature by setting to {{code|none}}. Use an inverse shape (geomask) instead of a regular shape by setting to {{code|inverse}}
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}geomask-fill-opacity''' – Opacity level of fill outside geomask features, a number between 0 and 1. ''Default:'' {{{mapframe-geomask-fill-opacity|0.5}}}
:''Default:'' {{{mapframe-shape|''not specified''}}}
+
**'''{{#if:{{{noprefix|}}}||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:'' {{{mapframe-zoom|10}}}
;{{#if:{{{noprefix|}}}||mapframe-}}point
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}length_km {{nobold|or}} {{#if:{{{noprefix|}}}||mapframe-}}length_mi {{nobold|or}} {{#if:{{{noprefix|}}}||mapframe-}}area_km2 {{nobold|or}} {{#if:{{{noprefix|}}}||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''
:Turn off display of point feature by setting to {{code|none}}. Force point marker to be displayed by setting to {{code|on}}.
+
**'''{{#if:{{{noprefix|}}}||mapframe-}}frame-coordinates''' or '''{{#if:{{{noprefix|}}}||mapframe-}}frame-coord''' Alternate latitude and longitude coordinates for initial placement of map, using {{tl|coord}}. ''Default:'' ''derived from item coordinates''{{#if:{{{deprecated|}}}|<nowiki></nowiki>
:''Default:'' {{{mapframe-point|''not specified''}}}
+
*Deprecated parameters
;{{#if:{{{noprefix|}}}||mapframe-}}line
+
**{{gray|1='''{{#if:{{{noprefix|}}}||mapframe-}}frame-lat''' or '''{{#if:{{{noprefix|}}}||mapframe-}}frame-latitude'''}} – Alternate latitude coordinate for initial placement of map; default is derived from item coordinates
:Turn off display of line feature by setting to {{code|none}}
+
**{{gray|1='''{{#if:{{{noprefix|}}}||mapframe-}}frame-long''' or '''{{#if:{{{noprefix|}}}||mapframe-}}frame-longitude'''}} – Alternate longitude coordinate for initial placement of map; default is derived from item coordinates
:''Default:'' {{{mapframe-line|''not specified''}}}
 
 
 
 
 
Other optional parameters:
 
;{{#if:{{{noprefix|}}}||mapframe-}}frame-width
 
:Frame width
 
:''Default:'' {{{mapframe-frame-width|270}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}frame-height
 
:Frame height
 
:''Default:'' {{{mapframe-frame-height|200}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}shape-fill
 
:Color used to fill shape features
 
:''Default:'' {{{mapframe-shape-fill|#606060}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}shape-fill-opacity
 
:Opacity level of shape fill, a number between 0 and 1
 
:''Default:'' {{{mapframe-shape-fill-opacity|0.5}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}stroke-color
 
:''or '''{{#if:{{{noprefix|}}}||mapframe-}}stroke-colour'''''
 
:Color of line features, and outlines of shape features
 
:''Default:'' {{{mapframe-stroke-color|{{{mapframe-stroke-colour|#ff0000}}}}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}stroke-width
 
:Width of line features, and outlines of shape features; default is "5"
 
:''Default:'' {{{mapframe-stroke-width|5}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}marker
 
:Marker symbol to use for coordinates; see [[mw:Help:Extension:Kartographer/Icons]] for options
 
:''Default:'' {{{mapframe-marker|''not specified''}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}marker-color
 
:'' or '''{{#if:{{{noprefix|}}}||mapframe-}}marker-colour'''''
 
:Background color for the marke
 
:''Default:'' {{{mapframe-marker-color|{{{mapframe-marker-colour|#5E74F3}}}}}}
 
;{{#if:{{{noprefix|}}}||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. <code>P17</code> for {{Q|P17}}, <code>P131</code> for {{Q|P131}})
 
:''Default:'' {{{mapframe-marker|''not specified''}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}geomask-stroke-color
 
:''or '''{{#if:{{{noprefix|}}}||mapframe-}}geomask-stroke-colour'''''
 
:Color of outline of geomask shape
 
:''Default:'' {{{mapframe-geomask-stroke-color|{{{mapframe-geomask-stroke-colour|#555555}}}}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}geomask-stroke-width
 
:Width of outline of geomask shape
 
:''Default:'' {{{mapframe-geomask-stroke-width|2}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}geomask-fill
 
:Color used to fill outside geomask features
 
:''Default:'' {{{mapframe-geomask-fill|#606060}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}geomask-fill-opacity
 
:Opacity level of fill outside geomask features, a number between 0 and 1
 
:''Default:'' {{{mapframe-geomask-fill-opacity|0.5}}}
 
;{{#if:{{{noprefix|}}}||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:'' {{{mapframe-zoom|10}}}
 
;{{#if:{{{noprefix|}}}||mapframe-}}length_km {{nobold|or}} {{#if:{{{noprefix|}}}||mapframe-}}length_mi {{nobold|or}} {{#if:{{{noprefix|}}}||mapframe-}}area_km2 {{nobold|or}} {{#if:{{{noprefix|}}}||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''
 
;{{#if:{{{noprefix|}}}||mapframe-}}frame-coordinates
 
:''or'' '''{{#if:{{{noprefix|}}}||mapframe-}}frame-coord'''
 
:Alternate latitude and longitude coordinates for initial placement of map, using {{tl|coord}}
 
:''Default:'' ''derived from item coordinates''
 
{{#if:{{{deprecated|}}}|<nowiki></nowiki>
 
 
 
 
 
''Deprecated parameters''
 
;{{#if:{{{noprefix|}}}||mapframe-}}frame-lat (''deprecated'')
 
:''or'' '''{{#if:{{{noprefix|}}}||mapframe-}}frame-latitude'''
 
:Alternate latitude coordinate for initial placement of map; default is derived from item coordinates
 
;{{#if:{{{noprefix|}}}||mapframe-}}frame-long (''deprecated'')
 
:''or'' '''{{#if:{{{noprefix|}}}||mapframe-}}frame-longitude'''
 
:Alternate longitude coordinate for initial placement of map; default is derived from item coordinates
 
 
}}
 
}}

Revision as of 04:00, 17 June 2020

50px 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