Module:Icon/doc: Difference between revisions
Content deleted Content added
m update /doc |
m change source to syntaxhighlight |
||
| Line 11: | Line 11: | ||
To use this module from another Lua module, first load it: |
To use this module from another Lua module, first load it: |
||
< |
<syntaxhighlight lang="lua"> |
||
local mIcon = require('Module:Icon') |
local mIcon = require('Module:Icon') |
||
</syntaxhighlight> |
|||
</source> |
|||
Then you can make icons with the _main function. |
Then you can make icons with the _main function. |
||
< |
<syntaxhighlight lang="lua"> |
||
mIcon._main(args) |
mIcon._main(args) |
||
</syntaxhighlight> |
|||
</source> |
|||
The <var>args</var> variable is a table of arguments. This corresponds to the parameters accepted by [[Template:Icon]] - please see the template page for parameter documentation. |
The <var>args</var> variable is a table of arguments. This corresponds to the parameters accepted by [[Template:Icon]] - please see the template page for parameter documentation. |
||
Revision as of 13:23, 7 July 2020
This module displays an icon depending on the code it is given. It implements Template:Icon.
 | This Lua module is used on approximately 642,000 pages, or roughly 1% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
Usage
From wikitext
From wikitext this module should be used via Template:Icon. Please see the template page for documentation.
From Lua
To use this module from another Lua module, first load it:
local mIcon = require('Module:Icon')
Then you can make icons with the _main function.
mIcon._main(args)
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.