Module:Mapframe/doc: Difference between revisions
		
		
		
		
		
		Jump to navigation
		Jump to search
		
				
		
		
	
| Module:Mapframe/doc>Paine Ellsworth  (High-use template) | m (1 revision imported) | 
| (No difference) | |
Latest revision as of 02:20, 9 February 2024
|  | This Lua module is used on many pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. | 
|  | This module depends on the following other modules: | 
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 Template:Mono function.
- From another module
- 
- Import this module, e.g. local mf = require('Module:Mapframe')
- Pass a table of parameter names/values to the Template:Mono function. See {{Maplink}} documentation for parameter names and descriptions. E.g. local mapframe = mf._main(parameters)
- Preprocess Template:Mono'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 Template:Wde and Template:Wde
 
- 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).