Module:Icon/data/doc

This is the documentation page for Module:Icon/data

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. 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 module stores icon data for Module:Icon.

Adding icons

To add a new icon, add a table in the following format:

	code = {
		image = "My image name.xyz",
		tooltip = "My tooltip text",
		link = true,
	},

The code should be in lower case.

Fields

image: the image to be displayed. This should be without the File: prefix. So, if you wanted to add File:Featured article star.svg, you would use "Featured article star.svg" here. If any of the text you add has double quotes in, you will need to escape it with backslashes like this: "My \"quoted\" image.svg".
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:

	code = {
		aliases = {"alias1", "alias2"},
		image = "My image name.xyz",
		tooltip = "My tooltip text",
		link = true,
	},

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.