Module:Mapframe/doc explained

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

Usage

Standard usage:
  • Just use, which passes its parameters to this module's function.
    From another module:
    1. Import this module, e.g. <nowiki>local mf = require('Module:Mapframe')</nowiki>
    1. Pass a table of parameter names/values to the function. See documentation for parameter names and descriptions. E.g. <nowiki>local mapframe = mf._main(parameters)</nowiki>
    1. Preprocess 's output before returning it, e.g. <nowiki>return frame:preprocess(mapframe)</nowiki>

    Set up on another wiki

    1. 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 and
    2. 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)
    3. Add documentation
      • to the template (e.g. by translating, 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).