Module:Icon/doc

This module displays an icon depending on the code it is given. It implements Template:Icon.

Usage

From wikitext

From wikitext this module should be used via Template:Icon in most cases. Please see the template page for documentation. In cases where lots of icons cause the page to exceed the post-expand include size limit, {{#invoke:Icon||icon name}} may be used instead of {{Icon|icon name}}.

From Lua

To use this module from another Lua module, first load it:

<syntaxhighlight lang="lua"> local mIcon = require('Module:Icon') </syntaxhighlight>

Then you can make icons with the _main function.

<syntaxhighlight lang="lua"> mIcon._main(args) </syntaxhighlight>

The args variable is a table of arguments. This corresponds to the parameters accepted by Template:Icon - please see the template page for parameter documentation.

Data

The icon data is stored at Module:Icon/data. See the instructions there for how to add and remove icons.