Template:Infobox mapframe/doc/parameters/doc

From The Right Wiki
Jump to navigationJump to search

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