Module:Icon/doc
From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Eyesnore (talk | contribs) at 11:21, 8 May 2016. The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision .Revision as of 11:21, 8 May 2016 by Eyesnore (talk | contribs)
icon 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.
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.
Warning This Lua module is used on 655,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.
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 is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.
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:
localmIcon=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.