Module:Mapframe/doc

&#x3c;!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikidata) --&#x3e;

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

Usage

 * Standard usage:
 * Just use Maplink, which passes its parameters to this module's main function.


 * From another module:
 * Import this module, e.g. &#x3c;code&#x3e;&#x3c;nowiki&#x3e;local mf = require('Module:Mapframe')&#x3c;/nowiki&#x3e;&#x3c;/code&#x3e;
 * Pass a table of parameter names/values to the _main function. See Maplink documentation for parameter names and descriptions. E.g. &#x3c;code&#x3e;&#x3c;nowiki&#x3e;local mapframe = mf._main(parameters)&#x3c;/nowiki&#x3e;&#x3c;/code&#x3e;
 * Preprocess _main's output before returning it, e.g. &#x3c;code&#x3e;&#x3c;nowiki&#x3e;return frame:preprocess(mapframe)&#x3c;/nowiki&#x3e;&#x3c;/code&#x3e;

Set up on another wiki

 * 1) Create template and module:
 * 2) * 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
 * 3) * On Wikidata, add them to the items and
 * 4) Localise the module
 * 5) * Edit the top bits of the module, between the comments &#x3c;code&#x3e;-- ##### Localisation (L10n) settings #####&#x3c;/code&#x3e; and &#x3c;code&#x3e;-- #### End of L10n settings ####&#x3c;/code&#x3e;, replacing values between &#x3c;code&#x3e;"&#x3c;/code&#x3e; &#x3c;code&#x3e;"&#x3c;/code&#x3e; symbols with local values (when necessary)
 * 6) Add documentation
 * 7) * to the template (e.g. by translating Template:Maplink/doc, adjusting as necessary per any localisations made in the previous step)
 * 8) * 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).

&#x3c;includeonly&#x3e;&#x3c;/includeonly&#x3e;