Module:Mapframe

Module documentation[view] [edit] [history] [purge]

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

1. Import this module, e.g. local mf = require('Module:Mapframe')
2. 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)
3. Preprocess _main's output before returning it, e.g. return frame:preprocess(mapframe)

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 Module:Mapframe (Q52554979) and Template:Maplink (Q27882107)
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 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).

The above documentation is transcluded from Module:Mapframe/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit) pages.
Subpages of this module.

--Parameter for cleaned-up parent.args (whitespace trimmed, blanks removed)
local Args = {}

function setCleanArgs(argsTable)
	local cleanArgs = {}
	for key, val in pairs(argsTable) do
		if type(val) == 'string' then
			val = val:match('^%s*(.-)%s*$')
			if val ~= '' then
				cleanArgs[key] = val
			end
		else
			cleanArgs[key] = val
		end
	end
	return cleanArgs
end

function makeTag(name, attributes, content)
	local tag --todo
	return tag
end

function makeContentJson(contentArgs)
	local data = {}
	if contentArgs.type == 'point' then
		data.type = "Feature"
	else
		data.type = "ExternalData"
	end

	--todo: fill out rest of data

	return mw.text.jsonEncode(data)
end

local p = {}

function p.main(frame)
	local parent = frame.getParent(frame)
	Args = setCleanArgs(parent.args)
 
	local content = {};
	local contentIndex = '';
	while Args['type'..contentIndex] do
		local contentArgs = {}
		contentArgs['type'] = Args['type'..contentIndex]
		--todo: Add other relevant args

		content[contentIndex or 1] = makeContentJson(contentArgs)

		contentIndex = (contentIndex or 1) + 1
	local mapContent

	local output = ''
	--if needsTitleTag
			



	return output
end

return p
end