imported>Zackmann08: /* Automatic maps in infoboxes */ Updating documentation to reflect new functionality

2025-11-18T20:39:00Z

Automatic maps in infoboxes: Updating documentation to reflect new functionality

New page

{{Module rating|release}}

{{High-use}}
{{Lua|Module:Mapframe|Module:InfoboxImage|Module:Infobox dim|Module:Yesno|Module:Arguments}}
{{Lua sidebar}}

This module implements {{tl|Infobox mapframe}}.

See [[Template:Infobox mapframe/testcases]] for tests.

== Usage ==

Module that automatically makes a mapframe suitable for an infobox automatically, with minimal user input.

===Generic usage===
Just use the template {{tl|Infobox mapframe}}, following the documentation there. This module may also be imported to another Lua module.

===Automatic maps in infoboxes===
:''Example edits: [https://en.wikipedia.org/w/index.php?title=Template%3AInfobox_prison&type=revision&diff=962824818&oldid=782742135 Template:Infobox prison], [https://en.wikipedia.org/w/index.php?title=Template%3AInfobox_prison%2Fdoc&type=revision&diff=962825435&oldid=768262729 Template:Infobox prison/doc]''
Edit the infobox template (or its sandbox).
Add lines like the following examples to the infobox. Replace numbers ({{kbd|4}}, or {{kbd|97}} to {{kbd|99}}), with the appropriate number based on how many other image or data parameters are already present.
{|style=width:100%
|-
! If placing near the top of infobox !! If placing at/near the bottom of the infobox
|-
|<pre>
| image4 = {{#invoke:Infobox mapframe|autoWithCaption}}
</pre>
|<pre>
| header97 = {{#if:{{{mapframe|}}}|Location}}
| data98 = {{#invoke:Infobox mapframe|autoWithCaption}}
</pre>
|}
If the template has a call to {{mlx|Check for unknown parameters|check}}, simply add {{para|mapframe_args|y}} to the call and the various mapframe args will automatically be included.

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.
<pre>{{#invoke:Infobox mapframe
| autoWithCaption
| mapframe-marker = library
}}</pre>
: 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>}}
* Add the new parameters to the template documentation.
*: 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 be copied and pasted from the relevant parts of {{edit|Template:Infobox mapframe/doc|Template:Infobox mapframe/doc}}
*For a list of available markers, see [[mw:Help:Extension:Kartographer/Icons]]

== See also ==
* [[Wikipedia:Mapframe maps in infoboxes]]
* [[Module:Mapframe]] & [[Template:Maplink]]

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |


}}</includeonly><noinclude>
[[Category:Module documentation pages]]
</noinclude>

Module:Infobox mapframe/doc - Revision history

imported>Zackmann08: /* Automatic maps in infoboxes */ Updating documentation to reflect new functionality