Template:Icon/doc: Difference between revisions

(4 intermediate revisions by 2 users not shown)

Line 1:

~~<noinclude>~~{{~~main~~|~~Template~~:~~Icon~~}}~~</noinclude>~~

{{Deprecated|user= [[User:Arin Mara|Arin Mara]] ([[User talk:Arin Mara|talk]]) 18:30, 22 May 2022 (UTC)|"Due to the way pages are loaded and cached, this template consumes 10x CPU time usage compared to using regular image links. Just use regular image links, see [[Icons]] for a list of icon-images."}}

== Syntax ==

; Syntax

The ~~function~~ takes up to three parameters. Each of the parameters are optional, while still allowing for some customization if need be.

: The template takes up to three parameters. Each of the parameters are optional, while still allowing for some customization if need be.

{{~~code~~|~~<nowiki>{{ icon~~ | type | size | hint }}~~</nowiki>}}~~

~~=== Parameters ===~~

~~;type~~

~~:This determines which icon to show and it will default back to the webifier icon if no parameters are given. Remember to use lower-case letters.~~

;size

:; Parameters

:This determines the size of the image, in pure numbers. It defaults to 32 (the ''px'' part of the size is omitted from the parameter as it is included in the template).

::; type : This determines which icon to show and it will default back to the webifier icon if no parameters are given. Remember to use lower-case letters.

::; size : This determines the size of the image, in pure numbers. It defaults to 32 (the ''px'' part of the size is omitted from the parameter as it is included in the template).

;hint

::; hint : This is the mouse-over hint. Add this if you want custom text to be displayed when you hover over the icon. This parameter will accept codes like '''bold''' or ''italic'' or wiki-links, but will simply strip any link-coding or formatting from them and presents the unmodified plain text.

:This is the mouse-over hint. Add this if you want custom text to be displayed when you hover over the icon. This parameter will accept codes like '''bold''' or ''italic'' or wiki-links, but will simply strip any link-coding or formatting from them and presents the unmodified plain text.

== Examples ==

* <code><nowiki>{{icon|point}}</nowiki></code> → {{icon|point}} ''(it will use the default size and no mouse-over tooltip)''

* <code><nowiki>{{icon|point}}</nowiki></code> → {{icon|point}} ''(it will use the default size and icon and no mouse-over tooltip)''

* <code><nowiki>{{icon|||Stay put with a web!}}</nowiki></code> → {{icon|||Stay put with a web!}} ''(default icon and size was used since no first argument was given)''

* <code><nowiki>{{icon|warp scrambler|16|No MWD for you!}}</nowiki></code> → {{icon|warp scrambler|16|No MWD for you!}} ''(smaller icon, could be used inside a paragraph without breaking the line height)''

~~= List of icons =~~

~~For a full list of icons available through this template, see the [[icons]] page.~~

~~{{note|Using too many calls of this template on the same page might lead to pages loading slowly or not at all. Use moderately.}}~~

<includeonly>[[Category:Image templates]]</includeonly>

<includeonly>[[Category:~~Template~~]]</includeonly>

<noinclude>[[Category:Template documentation]]</noinclude>

@@ Line 1: / Line 1: @@
-<noinclude>{{main|Template:Icon}}</noinclude>
+{{Deprecated|user= [[User:Arin Mara|Arin Mara]] ([[User talk:Arin Mara|talk]]) 18:30, 22 May 2022 (UTC)|"Due to the way pages are loaded and cached, this template consumes 10x CPU time usage compared to using regular image links. Just use regular image links, see [[Icons]] for a list of icon-images."}}
-== Syntax ==
+;  Syntax
-The function takes up to three parameters. Each of the parameters are optional, while still allowing for some customization if need be.
+: The template takes up to three parameters. Each of the parameters are optional, while still allowing for some customization if need be.
-{{code|<nowiki>{{ icon | type | size | hint }}</nowiki>}}
+ {{T|Icon|type|size|hint}}
-=== Parameters ===
-;type
-:This determines which icon to show and it will default back to the webifier icon if no parameters are given. Remember to use lower-case letters.
-;size
+:; Parameters
-:This determines the size of the image, in pure numbers. It defaults to 32 (the ''px'' part of the size is omitted from the parameter as it is included in the template).
+::; type : This determines which icon to show and it will default back to the webifier icon if no parameters are given. Remember to use lower-case letters.
+::; size : This determines the size of the image, in pure numbers. It defaults to 32 (the ''px'' part of the size is omitted from the parameter as it is included in the template).
-;hint
+::; hint : This is the mouse-over hint. Add this if you want custom text to be displayed when you hover over the icon. This parameter will accept codes like '''bold''' or ''italic'' or wiki-links, but will simply strip any link-coding or formatting from them and presents the unmodified plain text.
-:This is the mouse-over hint. Add this if you want custom text to be displayed when you hover over the icon. This parameter will accept codes like '''bold''' or ''italic'' or wiki-links, but will simply strip any link-coding or formatting from them and presents the unmodified plain text.
 == Examples ==
-* <code><nowiki>{{icon|point}}</nowiki></code> &rarr; {{icon|point}} ''(it will use the default size and no mouse-over tooltip)''
+* <code><nowiki>{{icon|point}}</nowiki></code> &rarr; {{icon|point}} ''(it will use the default size and icon and no mouse-over tooltip)''
 * <code><nowiki>{{icon|||Stay put with a web!}}</nowiki></code> &rarr; {{icon|||Stay put with a web!}} ''(default icon and size was used since no first argument was given)''
 * <code><nowiki>{{icon|warp scrambler|16|No MWD for you!}}</nowiki></code> &rarr; {{icon|warp scrambler|16|No MWD for you!}} ''(smaller icon, could be used inside a paragraph without breaking the line height)''
-= List of icons =
-For a full list of icons available through this template, see the [[icons]] page.
-{{note|Using too many calls of this template on the same page might lead to pages loading slowly or not at all. Use moderately.}}
+<includeonly>[[Category:Image templates]]</includeonly>
-<includeonly>[[Category:Template]]</includeonly>
 <noinclude>[[Category:Template documentation]]</noinclude>