Module:Infobox mapframe/doc: Difference between revisions

Revision as of 22:18, 5 April 2025

Latest revision as of 14:21, 26 August 2025

(3 intermediate revisions by the same user not shown)

Line 32:

If the template has a <code><nowiki>{{#invoke:</nowiki>[[Module:Check for unknown parameters|Check for unknown parameters]]<nowiki>}}</nowiki></code>, add the following parameters:

<pre>

| mapframe | mapframe-area_km2 | mapframe-area_mi2 | mapframe-caption | mapframe-coord | mapframe-coordinates | mapframe-custom | mapframe-frame-coord | mapframe-frame-coordinates | mapframe-frame-height | mapframe-frame-width | mapframe-geomask | mapframe-geomask-fill | mapframe-geomask-fill-opacity | mapframe-geomask-stroke-color | mapframe-geomask-stroke-colour | mapframe-geomask-stroke-width | mapframe-height | mapframe-id | mapframe-length_km | mapframe-length_mi | mapframe-marker | mapframe-marker-color | mapframe-marker-colour | mapframe-point | mapframe-population | mapframe-shape | mapframe-shape-fill | mapframe-shape-fill-opacity | mapframe-stroke-color | mapframe-stroke-colour | mapframe-stroke-width | mapframe-switcher | mapframe-type | mapframe-width | mapframe-wikidata | mapframe-zoom

</pre>

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 {{kbd|#invoke}} calls above, e.g.
<code><nowikipre>{{#invoke:Infobox mapframe
| auto
| mapframe-marker = library
}}</nowiki></codepre>
: 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 {{para|mapframe|yes}} is present in the template call.
*: To turn maps on by default, in the {{kbd|#invoke}} calls above add {{para|onByDefault|yes}} – which means maps will be displayed unless {{para|mapframe|no}} is present in the template call.
*: {{kbd|onByDefault}} can also be set to a conditional, such as if another parameters is present, e.g. {{para|onByDefault|2=<nowiki>{{#if:{{{pushpin_map|}}}|no|yes}}</nowiki>}}

*: Both the {{kbd|auto}} and {{kbd|autocaption}} functions take the {{kbd|onByDefault}} value into account.
* Add the new parameters to the document.
*: You can use {{tlx|Infobox mapframe/doc/parameters}}.
*: If any default values are modified in the {{kbd|#invoke}} calls, add them as parameters in the form {{tt|{{!}}}}''parameter-name''{{tt|{{=}}}}''value''.
*: The default output is shown here collapsed:

{{cot}}

{{Infobox mapframe/doc/parameters}}

{{cob}}

*Parameters can also be added to the TemplateData, which can also be addedcopied byand copy-pastingpasted from the relevant parts of {{edit|Template:Infobox mapframe/doc|Template:Infobox mapframe/doc}}

== See also ==