Module:Icon/doc: Difference between revisions
More actions
Created page with "{{Module rating|protected}} {{High-use}} 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, {{mlx|Icon|<nowiki>|</nowiki>''icon name''}} may be used instead of {{..." |
No edit summary |
||
Line 1: | Line 1: | ||
{{ | {{doc sub}} | ||
This module displays an icon depending on the code it is given. It implements [[Template:Icon]]. | This module displays an icon depending on the code it is given. It implements [[Template:Icon]]. | ||
Line 31: | Line 30: | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | | ||
<!-- Categories below this line, please; interwikis at Wikidata --> | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
[[Category:Modules]] | |||
}}</includeonly><noinclude> | }}</includeonly><noinclude> | ||
[[Category:Module documentation pages]] | [[Category:Module documentation pages]] | ||
</noinclude> | </noinclude> |
Revision as of 22:49, 1 March 2025
This is a documentation subpage for Module:Icon. It may contain usage information, categories and other content that is not part of the original module page. |
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.