Module:Mapframe/doc: Difference between revisions
Content deleted Content added
High-use template |
{{Uses TemplateStyles|Template:Maplink/styles-multi.css}} |
||
| Line 3: | Line 3: | ||
{{High-use}} |
{{High-use}} |
||
{{Lua|Module:Transcluder}} |
{{Lua|Module:Transcluder}} |
||
{{Uses TemplateStyles|Template:Maplink/styles-multi.css}} |
|||
On English Wikipedia, this module is called by {{tlx|Maplink}}, see that template's documentation for usage instructions. |
On English Wikipedia, this module is called by {{tlx|Maplink}}, see that template's documentation for usage instructions. |
||
== Usage == |
== Usage == |
||
Revision as of 12:18, 3 May 2024
 | This Lua module is used on approximately 1,050,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: |
 | This module uses TemplateStyles: |
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.
- 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)
- Import this module, e.g.
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)
- Edit the top bits of the module, between the comments
- 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).