Module:Mapframe/doc

This is a documentation subpage for Module:Mapframe.
It may contain usage information, categories and other content that is not part of the original module page.

This module is rated as beta. It is considered ready for widespread use, but as it is still relatively new, it should be applied with some caution to ensure results are as expected.

This Lua module is used on approximately 1,490,000 pages, or roughly 2% of all pages.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

Module:Transcluder (sandbox)

This module uses TemplateStyles:

Template:Maplink/styles-multi.css

On English Wikipedia, this module is called by {{Maplink}}, see that template's documentation for usage instructions.

Usage

Standard usage

Just use {{Maplink}}, which passes its parameters to this module's main function as default.

If a page has a rendering time by Lua of between 5 seconds and 10 seconds using {{Maplink}} the use of the direct module call by syntax like:

{{#tag:mapframe|[raw GeoJSON]|frameless=[1 for frame]|align=[left/right/center]|text=[caption]|width=[in px]|height=[in px]|latitude=[decimal degrees]|longitude=[decimal degrees]|zoom=[zoom factor]}}

saves Lua over-head. An example of this substitution is at https://en.wikipedia.org/w/index.php?diff=970846012. Such code minimises the chances of hitting the ten second Lua timeout if the back-end servers are busy.

From another module

Import this module, e.g. local mf = require('Module:Mapframe')
Pass a table of parameter names/values to the _main function. See {{Maplink}} documentation for parameter names and descriptions. E.g. local mapframe = mf._main(parameters)
Preprocess _main's output before returning it, e.g. return frame:preprocess(mapframe)

Set up on another wiki

Create template and module:
- Import this module and its template to that wiki (or copy the code over, giving attribution in the edit summary). Optionally, give them a name that makes sense in that wiki's language
- On Wikidata, add them to the items Module:Mapframe (Q52554979) and Template:Maplink (Q27882107)
Localise the module
- Edit the top bits of the module, between the comments -- ##### Localisation (L10n) settings ##### and -- #### End of L10n settings ####, replacing values between " " symbols with local values (when necessary)
Add documentation
- to the template (e.g. by translating Template:Maplink/doc, adjusting as necessary per any localisations made in the previous step)
- to the module (please transfer/translate these instructions so that wikimedians who read your wiki but not the English Wikipedia can also set up the module and template on another wiki).