Module:Icon/data/doc - Revision history

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T21:48:10Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 21:48, 29 August 2024
Line 45:		Line 45:
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->

	}}</includeonly>		}}</includeonly><noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

Paine Ellsworth: High-use template

2024-07-16T04:08:44Z

High-use template

← Previous revision		Revision as of 04:08, 16 July 2024
Line 1:		Line 1:
	{{Module rating\|protected}}		{{Module rating\|protected}}
	{{High-use~~\|demo=Module:{{ROOTPAGENAME}}~~}}		{{High-use}}

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

Paine Ellsworth: fix High-use template in sandbox display

2022-11-11T01:15:47Z

fix High-use template in sandbox display

← Previous revision		Revision as of 01:15, 11 November 2022
Line 1:		Line 1:
	{{Module rating\|protected}}		{{Module rating\|protected}}
			{{High-use\|demo=Module:{{ROOTPAGENAME}}}}
	{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|{{High-use}}}}

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

Paine Ellsworth: High-use template

2022-06-14T02:19:00Z

High-use template

← Previous revision		Revision as of 02:19, 14 June 2022
Line 1:		Line 1:
	{{Module rating\|protected}}		{{Module rating\|protected}}
			{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|{{High-use}}}}

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

Mr. Stradivarius: document the link field

2021-08-29T11:10:51Z

document the link field

← Previous revision		Revision as of 11:10, 29 August 2021
Line 10:		Line 10:
	image = "My image name.xyz",		image = "My image name.xyz",
	tooltip = "My tooltip text",		tooltip = "My tooltip text",
			link = true,
	},		},
	</syntaxhighlight>		</syntaxhighlight>

			The code should be in lower case.
⚫	If you want to add aliases for the code, ~~use~~ ~~the~~ ~~following~~ ~~format~~ ~~instead~~:

			=== 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, add an <code>aliases</code> table as follows:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	code = {		code = {
Line 19:		Line 30:
	image = "My image name.xyz",		image = "My image name.xyz",
	tooltip = "My tooltip text",		tooltip = "My tooltip text",
			link = true,
	},		},
	</syntaxhighlight>		</syntaxhighlight>

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

	Removing icons is fairly easy. Just remove the relevant entry from the data table. You ~~can't~~ remove the _DEFAULT entry, as [[Module:Icon]] relies on it being there.		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.

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

WOSlinker: change source to syntaxhighlight

2020-07-07T16:28:06Z

change source to syntaxhighlight

← Previous revision		Revision as of 16:28, 7 July 2020
Line 6:		Line 6:
	To add a new icon, add a table in the following format:		To add a new icon, add a table in the following format:

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	code = {		code = {
	image = "My image name.xyz",		image = "My image name.xyz",
	tooltip = "My tooltip text",		tooltip = "My tooltip text",
	},		},
			</syntaxhighlight>
	</source>

	If you want to add aliases for the code, use the following format instead:		If you want to add aliases for the code, use the following format instead:
	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	code = {		code = {
	aliases = {"alias1", "alias2"},		aliases = {"alias1", "alias2"},
Line 20:		Line 20:
	tooltip = "My tooltip text",		tooltip = "My tooltip text",
	},		},
			</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}}.		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}}.

Ludwig20 at 15:09, 22 April 2017

2017-04-22T15:09:50Z

← Previous revision		Revision as of 15:09, 22 April 2017
Line 1:		Line 1:
			{{Module rating\|protected}}
	This module stores icon data for [[Module:Icon]].		This module stores icon data for [[Module:Icon]].

Mr. Stradivarius: create

2015-01-23T10:25:26Z

create

New page

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

== Adding icons ==

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

<source lang="lua">
code = {
image = "My image name.xyz",
tooltip = "My tooltip text",
},
</source>

If you want to add aliases for the code, use the following format instead:
<source lang="lua">
code = {
aliases = {"alias1", "alias2"},
image = "My image name.xyz",
tooltip = "My tooltip text",
},
</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't remove the _DEFAULT entry, as [[Module:Icon]] relies on it being there.

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


}}</includeonly>