Module:Infobox mapframe/doc
This is the documentation page for Module:Infobox mapframe
Éwn malábó:Module rating Éwn malábó:High-use Éwn malábó:Lua sidebar
Usage
[nwó étéwn che]Module that automatically makes a mapframe suitable for an infobox automatically, with minimal user input.
Generic usage
[nwó étéwn che]Just use the template {{Infobox mapframe}}, following the documentation there. This module may also be imported to another Lua module.
Automatic maps in infoboxes
[nwó étéwn che]- 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 (Éwn malábó:Kbd, or Éwn malábó:Kbd to Éwn malábó: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 Éwn malábó: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 Éwn malábó:Para is present in the template call. To turn maps on by default, in the Éwn malábó:Kbd calls above add Éwn malábó:Para – which means maps will be displayed unless Éwn malábó:Para is present in the template call. Éwn malábó:Kbd can also be set to a conditional, such as if another parameters is present, e.g. Éwn malábó:Para
- Add the new parameters to the document. You can use Éwn malábó:Tlx. Specify default values (if any are used in the Éwn malábó:Kbd calls) using by adding parameters in the form Éwn malábó:Ttparameter-nameÉwn malábó:Ttvalue. The default output is shown here collapsed:
Éwn malábó:Cot Éwn malábó:Infobox mapframe/doc/parameters Éwn malábó:Cob
- Parameters can also be added to the TemplateData can also be added by copy-pasting from Éwn malábó:Edit
See also
[nwó étéwn che]