Module:Icon/doc: Difference between revisions
(→From wikitext: In cases where lots of icons cause the page to exceed the post-expand include size limit, {{mlx|Icon|<nowiki>|</nowiki>''icon name''}} may be used instead of {{tlx|Icon|''icon name''}}.) |
m (1 revision imported: initial setup) |
||
(No difference)
| |||
Latest revision as of 16:13, 25 August 2024
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
 | This Lua module is used on many pages. To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its /sandbox or /testcases subpages. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
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:
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.