Module:Icon/data/doc
This is the documentation page for Module:Icon/data
 | This Lua module is used on approximately 581,000 pages, or roughly 8392% 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 stores icon data for Module:Icon.
Adding icons
To add a new icon, add a table in the following format:
<syntaxhighlight lang="lua"> code = { image = "My image name.xyz", tooltip = "My tooltip text", link = true, }, </syntaxhighlight>
The code should be in lower case.
Fields
image: the image to be displayed. This should be without theFile:prefix. So, if you wanted to add File:Featured article star.svg, you would use <syntaxhighlight lang="lua" class="" id="" style="" inline="1">"Featured article star.svg"</syntaxhighlight> here. If any of the text you add has double quotes in, you will need to escape it with backslashes like this: <syntaxhighlight lang="lua" class="" id="" style="" inline="1">"My \"quoted\" image.svg"</syntaxhighlight>.tooltip: the tooltip to be displayed when hovering the mouse above the image. This is optional, although it is recommended you include it.link: if false, the link to the file description page is suppressed. You should only set this to false if the icon image is in the public domain, or is released under a license that does not require attribution (such as CC-0). For images released under licenses that require attribution such as CC-BY-SA and the GFDL, you should set this to true to preserve the link to the file description page.
Aliases
If you want to add aliases for the code, add an aliases table as follows:
<syntaxhighlight lang="lua">
code = {
aliases = {"alias1", "alias2"},
image = "My image name.xyz",
tooltip = "My tooltip text",
link = true,
},
</syntaxhighlight>
Please make sure that any codes and aliases that you add don't match any existing codes or aliases. If they do, one of them will be overwritten with the other (and it's not possible to say for certain which will be overwritten with which).
Removing icons
Removing icons is fairly easy. Just remove the relevant entry from the data table. You should not remove the _DEFAULT entry, as Module:Icon relies on it being there, and removing it will cause script errors.
