Module:Icon/data/doc
This is the documentation page for Module:Icon/data
 | This Lua module is used on approximately 574,000 pages, or roughly 40112% 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
This is a documentation subpage for Module:Icon/data.
It may contain usage information, categories and other content that is not part of the original module page.
Usage
Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See Help:Wiki markup for an explanation of what the various tags do.
If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.
The template uses the <syntaxhighlight> tag with the attribute inline=1. This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:
- Template loop detected: Template:Code
However, {{code|a {{template}} call}} will still invoke the template:
- Template loop detected: Template:Code
Use <nowiki>...</nowiki> around the template name to avoid this problem:
- Template loop detected: Template:Code
When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
- Template loop detected: Template:Code
is well spaced:
- foo Template loop detected: Template:Code quux.
versus:
- Template loop detected: Template:Code
which is going to be visually confusing for many:
- foo Template loop detected: Template:Code quux.
because "foo" and "Template loop detected: Template:Code" will seem more closely associated than "Template loop detected: Template:Code" and "Template loop detected: Template:Code"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
Use parameter lua (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though Template loop detected: Template:Code and Template loop detected: Template:Code are valid values, as are Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.
This template does not need to be substituted.
Examples
| Markup | Renders asScript error: No such module "For loop". |
|---|---|
Included templates
Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.
Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:
| Markup | Renders asScript error: No such module "For loop". |
|---|---|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
TemplateData
TemplateData for Icon/data
Script error: No such module "Format TemplateData".
See also
- {{codett}}, wrapper for this template that removes background and border styling
- {{mono}}, monospaced font only
- {{param value}}, monospaced; friendly handling for blank space
- {{Syntaxhighlight}}
- {{kbd}}, for keyboard input
- Help:Wiki markup
here. If any of the text you add has double quotes in, you will need to escape it with backslashes like this:
| This is a documentation subpage for Module:Icon/data. It may contain usage information, categories and other content that is not part of the original module page. |
Usage
Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See Help:Wiki markup for an explanation of what the various tags do.
If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.
The template uses the <syntaxhighlight> tag with the attribute inline=1. This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:
- Template loop detected: Template:Code
However, {{code|a {{template}} call}} will still invoke the template:
- Template loop detected: Template:Code
Use <nowiki>...</nowiki> around the template name to avoid this problem:
- Template loop detected: Template:Code
When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
- Template loop detected: Template:Code
is well spaced:
- foo Template loop detected: Template:Code quux.
versus:
- Template loop detected: Template:Code
which is going to be visually confusing for many:
- foo Template loop detected: Template:Code quux.
because "foo" and "Template loop detected: Template:Code" will seem more closely associated than "Template loop detected: Template:Code" and "Template loop detected: Template:Code"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
Use parameter lua (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though Template loop detected: Template:Code and Template loop detected: Template:Code are valid values, as are Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.
This template does not need to be substituted.
Examples
| Markup | Renders asScript error: No such module "For loop". |
|---|---|
Included templates
Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.
Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:
| Markup | Renders asScript error: No such module "For loop". |
|---|---|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
TemplateData
TemplateData for Icon/data
Script error: No such module "Format TemplateData".
See also
- {{codett}}, wrapper for this template that removes background and border styling
- {{mono}}, monospaced font only
- {{param value}}, monospaced; friendly handling for blank space
- {{Syntaxhighlight}}
- {{kbd}}, for keyboard input
- Help:Wiki markup
.
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.
