Module:Top icons/doc

From Old School Near-Reality Wiki
Jump to navigation Jump to search

This is the documentation page for Module:Top icons

Information icon-grey.png
This is a documentation subpage for Module:Top icons.
It contains usage information, categories, and other content that is not part of the original module page.
Module:Top icons's function main is invoked by Template:External.
Module:Top icons is required by Module:Update.

This module is used in Template:External to generate the top icons. It can also be called from other modules using its helper function.

This module is a helper module to be used by other modules; it may not be designed to be invoked directly. See Near-Reality:Lua/Helper modules for a full list and more information.

ModuleFunctionTypeUse
Top icons_main(args)StringReturns a string that adds top icons to the page. args must be a table of arguments. Numbered arguments must have values of rs, rsc, meta or wp. To provide a specific pagename on the top icon link, specify named arguments with those same indices, with the value being the external pagename.