Module:Infobox mapframe/doc

This is the documentation page for Module:Infobox mapframe

This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected.

This Lua module is used on many pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them.

Usage

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

Generic usage

Just use the template {{[[Template:Infobox mapframe |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 (Tɛmpileti:Kbd, or Tɛmpileti:Kbd to Tɛmpileti: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-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-shape | mapframe-shape-fill | mapframe-shape-fill-opacity | mapframe-stroke-color | mapframe-stroke-colour | mapframe-stroke-width | mapframe-switcher | mapframe-width | mapframe-wikidata | mapframe-zoom

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 Tɛmpileti: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 |mapframe=yes is present in the template call. To turn maps on by default, in the Tɛmpileti:Kbd calls above add |onByDefault=yes – which means maps will be displayed unless |mapframe=no is present in the template call. Tɛmpileti:Kbd can also be set to a conditional, such as if another parameters is present, e.g. |onByDefault={{#if:{{{pushpin_map|}}}|no|yes}}
Add the new parameters to the document. You can use {{Infobox mapframe/doc/parameters}}. Specify default values (if any are used in the Tɛmpileti:Kbd calls) using by adding parameters in the form Tɛmpileti:Ttparameter-nameTɛmpileti:Ttvalue. The default output is shown here collapsed:

Tɛmpileti:Cot Tɛmpileti:Infobox mapframe/doc/parameters Tɛmpileti:Cob

Parameters can also be added to the TemplateData can also be added by copy-pasting from Tɛmpileti:Edit

Usage

Generic usage

Automatic maps in infoboxes

See also