Module:Map/doc

This is a documentation subpage for Module:Map. It contains usage information, categories, and other content that is not part of the original module page.

Module:Map's function map is invoked by Template:Map.

Module:Map requires Module:Paramtest.

Module:Map is required by Module:Clues.

Module:Map is required by Module:Sandbox/User:Als Toy Barn/ShopLocLine.

map(frame)
The main entry point for templates and mw.pages. Should only be called via {{#invoke}} outside of a module.
Argument	Type	Description	Optional
frame	frame object	The frame object automatically passed via {{#invoke}}.
Returns	string	A fully rendered map.

buildMap(args)
The main entry point for other modules.
Argument	Type	Description	Optional
args	table	Any map or feature arguments.
Returns	string	A fully rendered map.

getMap(name, mapOpts)
Pulls a map from SMW.
Argument	Type	Description	Optional
name	string	The page name to use in the look up. Append the version name the map is defined under (e.g., #Version1 or #Version2) if there is one.
mapOpts	table	Map options to control the map behaviour.
Returns	string	A fully rendered map.