Module:Infobox mapframe/doc
This is the documentation page for Module:Infobox mapframe
Template:Module rating Template:Lua sidebar
Usage
Module that automatically makes a mapframe suitable for an infobox automatically, with minimal user input.
Generic usage
Just use the template {{Infobox mapframe}}, following the documentation there. This module may also be imported to another Lua module.
Automatic maps in infoboxes
- Example edits: Template:Infobox prison, Template:Infobox prison/doc
Edit the infobox template (or its sandbox). Add lines like the following examples to the infobox. Replace numbers (Template:Kbd, or Template:Kbd to Template:Kbd), with the appropriate number based on how many other image or data parameters are already present.
| If placing near the top of infobox | If placing at/near the bottom of the infobox |
|---|---|
| image4 = {{#invoke:Infobox mapframe|auto}}
| caption4 = {{#invoke:Infobox mapframe|autocaption}}
|
| header97 = {{#if:{{{mapframe|}}}|Location}}
| data98 = {{#invoke:Infobox mapframe|auto}}
| data99 = {{#invoke:Infobox mapframe|autocaption}}
|
If the template has a {{#invoke:Check for unknown parameters}}, add the following parameters:
| mapframe | mapframe-caption | mapframe-custom | mapframe-id | mapframe-coord | mapframe-wikidata | mapframe-point | mapframe-shape | mapframe-frame-width | mapframe-frame-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 | 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 | mapframe-switcher | mapframe-height | mapframe-width
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 Template:Kbd calls above, e.g.
{{#invoke:Infobox mapframe|auto|mapframe-marker=library}}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 Template:Para is present in the template call. To turn maps on by default, in the Template:Kbd calls above add Template:Para – which means maps will be displayed unless Template:Para is present in the template call. Template:Kbd can also be set to a conditional, such as if another parameters is present, e.g. Template:Para
- Add the new parameters to the document. You can use Template:Tlx. Specify default values (if any are used in the Template:Kbd calls) using by adding parameters in the form Template:Ttparameter-nameTemplate:Ttvalue. The default output is shown here collapsed:
Template:Cot Template:Infobox mapframe/doc/parameters Template:Cob
- Parameters can also be added to the TemplateData can also be added by copy-pasting from Template:Edit
