Module:Icon/doc: Difference between revisions
High-use template |
→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''}}. |
||
| Line 7: | Line 7: | ||
=== From wikitext === |
=== From wikitext === |
||
From wikitext this module should be used via [[Template:Icon]]. Please see the template page for documentation. |
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 [[WP:PEIS|post-expand include size]] limit, {{mlx|Icon|<nowiki>|</nowiki>''icon name''}} may be used instead of {{tlx|Icon|''icon name''}}. |
||
=== From Lua === |
=== From Lua === |
||
Revision as of 18:06, 23 July 2024
 | 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. |
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.