Module:Map/doc: Difference between revisions

Content added Content deleted

Inline

Revision as of 00:12, 17 October 2024

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.

@@ Line 3: / Line 3: @@
 {{APIDoc
 |funcName = map
-|funcDesc = The main entry point for templates and pages. Should only be called via <code>{{#invoke}}</code> outside of a module.
+|funcDesc = The main entry point for templates and mw.pages. Should only be called via <code>{{#invoke}}</code> outside of a module.
 |arg1 = frame
 |type1 = [https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#frame-object frame object]