Module:Icon/data/doc: Difference between revisions

Revision as of 15:09, 22 April 2017

Latest revision as of 21:48, 29 August 2024

(5 intermediate revisions by 3 users not shown)

Line 1:

{{Module rating|protected}}

{{High-use}}

This module stores icon data for [[Module:Icon]].

Line 6 ⟶ 8:

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

<sourcesyntaxhighlight lang="lua">

code = {

image = "My image name.xyz",

tooltip = "My tooltip text",

link = true,

},

</syntaxhighlight>

</source>

The code should be in lower case.

If you want to add aliases for the code, use the following format instead:

<source lang="lua">

=== Fields ===

* <code>image</code>: the image to be displayed. This should be without the <code>File:</code> prefix. So, if you wanted to add [[:File:Featured article star.svg]], you would use {{code|"Featured article star.svg"|lua}} here. If any of the text you add has double quotes in, you will need to escape it with backslashes like this: {{code|"My \"quoted\" image.svg"|lua}}.

* <code>tooltip</code>: the tooltip to be displayed when hovering the mouse above the image. This is optional, although it is recommended you include it.

* <code>link</code>: 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, useadd thean following<code>aliases</code> formattable insteadas follows:

<sourcesyntaxhighlight lang="lua">

code = {

aliases = {"alias1", "alias2"},

image = "My image name.xyz",

tooltip = "My tooltip text",

link = true,

},

</syntaxhighlight>

</source>

If any of the text you add has double quotes in, you will need to escape it with backslashes like this: {{code|"My \"quoted\" image.svg"|lua}}.

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).

You can omit the tooltip text if you want, but it is recommended that you add it.

== Removing icons ==

Removing icons is fairly easy. Just remove the relevant entry from the data table. You can'tshould not remove the _DEFAULT entry, as [[Module:Icon]] relies on it being there, and removing it will cause script errors.

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

<!-- Categories below this line, please; interwikis at Wikidata -->

}}</includeonly><noinclude>

[[Category:Module documentation pages]]

</noinclude>