View source for Module:Map/doc

{{Documentation}}

{{APIDoc
|funcName = map
|funcDesc = The main entry point for templates and 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]
|desc1 = The frame object automatically passed via <code>{{#invoke}}</code>.
|returnType = string
|returnDesc = A fully rendered map.
}}
{{APIDoc
|funcName = buildMap
|funcDesc = The main entry point for other modules.
|arg1 = args
|type1 = table
|desc1 = Any [[Template:Map#Arguments|map or feature arguments]].
|returnType = string
|returnDesc = A fully rendered map.
}}
{{APIDoc
|funcName = getMap
|funcDesc = Pulls a map from SMW.
|arg1 = name
|type1 = string
|desc1 = The page name to use in the look up. Append the version name the map is defined under (e.g., <code>#Version1</code> or <code>#Version2</code>) if there is one.
|arg2 = mapOpts
|type2 = table
|desc2 = [[#Map options|Map options]] to control the map behaviour.
|optional2 = Yes
|returnType = string
|returnDesc = A fully rendered map.
}}