Difference between revisions of "Template:Icon/doc"

From blackwiki
Jump to navigation Jump to search
(Replaced content with 'lies')
imported>Moxy
 
(23 intermediate revisions by 17 users not shown)
Line 1: Line 1:
lies
+
{{Documentation subpage}}
 +
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 +
{{High-use| 369518 }}
 +
{{lua|Module:Icon}}
 +
 
 +
This template creates an inline image that is used in [[Wikipedia:Meta|metapages]] such as [[Wikipedia:Vital articles]] and/or in [[Special:ListUsers|user pages]].
 +
 
 +
== Syntax ==
 +
 
 +
'''Basic usage'''
 +
&#123;&#123;icon&#124;''code''&#125;&#125;
 +
 
 +
&#123;&#123;icon&#124;class=''code''&#125;&#125;
 +
 
 +
'''Custom size'''
 +
 
 +
&#123;&#123;icon&#124;''code''&#124;size=''size''&#125;&#125;
 +
 
 +
== Parameters ==
 +
 
 +
* <code>1</code> or <code>class</code> - the icon code. See the [[#Icon codes|table below]] for a list of available codes.
 +
* <code>size</code> - a custom icon size, e.g. "30px". The default size is "16x16px" (16 by 16 pixels).
 +
 
 +
== Icon codes ==
 +
<!--[[Template:Icon link]] links here-->
 +
<!--Following order of Category classes:-->
 +
{| class="wikitable sortable" style="font-size:95%"
 +
! Icon&nbsp; || Type&nbsp; || Code&nbsp;
 +
|-
 +
| {{icon|Vital}} || '''Vital Article''' || {{tlf|icon|Vital}}
 +
|-
 +
| {{icon|FA}} || '''Featured Article''' || {{tlf|icon|FA}}
 +
|-
 +
| {{icon|FAC}} || '''Featured Article Candidate''' || {{tlf|icon|FAC}}
 +
|-
 +
| {{icon|FAR}} || '''Featured Article Review''' || {{tlf|icon|FAR}}
 +
|-
 +
| {{icon|FARC}} || '''Featured Article Removal Candidate''' || {{tlf|icon|FARC}}
 +
|-
 +
| {{icon|FFA}} || '''Former Featured Article''' || {{tlf|icon|FFA}}
 +
|-
 +
| {{icon|FFAC}} || '''Failed Featured Article Candidate''' || {{tlf|icon|FFAC}}
 +
|-
 +
| {{icon|FP}} || '''Featured Picture''' || {{tlf|icon|FP}}
 +
|-
 +
| {{icon|FPC}} || '''Featured Picture Candidate''' || {{tlf|icon|FPC}}
 +
|-
 +
| {{icon|FFP}} || '''Former Featured Picture''' || {{tlf|icon|FFP}}
 +
|-
 +
| {{icon|FPo}} || '''Featured Portal''' || {{tlf|icon|FPo}}
 +
|-
 +
| {{icon|FFPo}} || '''Former Featured Portal''' || {{tlf|icon|FFPo}}
 +
|-
 +
| {{icon|FPoC}} || '''Featured Portal Candidate''' || {{tlf|icon|FPoC}}
 +
|-
 +
| {{icon|FPoR}} || '''Featured Portal Review''' || {{tlf|icon|FPoR}}
 +
|-
 +
| {{icon|FS}} || '''Featured Sound''' || {{tlf|icon|FS}}
 +
|-
 +
| {{icon|FFS}} || '''Former Featured Sound''' || {{tlf|icon|FFS}}
 +
|-
 +
| {{icon|FSC}} || '''Featured Sound Candidate''' || {{tlf|icon|FSC}}
 +
|-
 +
| {{icon|FT}} || '''Featured Topic''' || {{tlf|icon|FT}}
 +
|-
 +
| {{icon|FTC}} || '''Featured Topic Candidate''' || {{tlf|icon|FTC}}
 +
|-
 +
| {{icon|FTRC}} || '''Featured Topic Removal Candidate''' || {{tlf|icon|FTRC}}
 +
|-
 +
| {{icon|FFT}} || '''Former Featured Topic''' || {{tlf|icon|FFT}}
 +
|-
 +
| {{icon|A}} || '''A-Class Article''' || {{tlf|icon|A}}
 +
|-
 +
| {{icon|ACC}} || '''A-Class Article Candidate''' || {{tlf|icon|ACC}}
 +
|-
 +
| {{icon|DAA}} || '''Demoted A-Class Article''' || {{tlf|icon|DAA}}
 +
|-
 +
| {{icon|FAAC}} || '''Failed A-Class Article Candidate''' || {{tlf|icon|FAAC}}
 +
|-
 +
| {{icon|GA}} || '''Good Article''' || {{tlf|icon|GA}}
 +
|-
 +
| {{icon|GAN}} || '''Good Article Nominee''' || {{tlf|icon|GAN}}
 +
|-
 +
| {{icon|GA2}} || '''Good Article, 2nd Opinion''' || {{tlf|icon|GA2}}
 +
|-
 +
| {{icon|GAH}} || '''Good Article on Hold''' || {{tlf|icon|GAH}}
 +
|-
 +
| {{icon|GAR}} || '''Good Article Reassessment''' || {{tlf|icon|GAR}}
 +
|-
 +
| {{icon|DGA}} || '''Delisted Good Article''' || {{tlf|icon|DGA}}
 +
|-
 +
| {{icon|FGAN}} || '''Failed Good Article Nominee''' || {{tlf|icon|FGAN}}
 +
|-
 +
| {{icon|GT}} || '''Good Topic''' || {{tlf|icon|GT}}
 +
|-
 +
| {{icon|GTC}} || '''Good Topic Candidate''' || {{tlf|icon|GTC}}
 +
|-
 +
| {{icon|GTRC}} || '''Good Topic Removal Candidate''' || {{tlf|icon|GTRC}}
 +
|-
 +
| {{icon|bplus|b+}} || '''Bplus-Class Article''' || {{tlf|icon|BPLUS}}
 +
|-
 +
| {{icon|b}} || '''B-Class Article''' || {{tlf|icon|B}}
 +
|-
 +
| {{icon|br|bcr}} || '''B-Class Review''' || {{tlf|icon|BR}}
 +
|-
 +
| {{icon|c}} || '''C-Class Article''' || {{tlf|icon|C}}
 +
|-
 +
| {{icon|start}} || '''Start-Class Article''' || {{tlf|icon|START}}
 +
|-
 +
| {{icon|stub}} || '''Stub-Class Article''' || {{tlf|icon|STUB}}
 +
|-
 +
| {{icon|FL}} || '''Featured List''' || {{tlf|icon|FL}}
 +
|-
 +
| {{icon|FLC}} || '''Featured List Candidate''' || {{tlf|icon|FLC}}
 +
|-
 +
| {{icon|FFL}} || '''Former Featured List''' || {{tlf|icon|FFL}}
 +
|-
 +
| {{icon|FFLC}} || '''Failed Featured List Candidate''' || {{tlf|icon|FFLC}}
 +
|-
 +
| {{icon|FLR}} || '''Featured List Review''' || {{tlf|icon|FLR}}
 +
|-
 +
| {{icon|FLRC}} || '''Featured List Removal Candidate''' || {{tlf|icon|FLRC}}
 +
|-
 +
| {{icon|List}} || '''List-Class Article''' || {{tlf|icon|LIST}}
 +
|-
 +
| {{icon|Book}} || '''Wikipedia Book''' || {{tlf|icon|Book}}
 +
|-
 +
| {{icon|Cat|Categ|Category}} || '''Category''' || {{tlf|icon|Category}}
 +
|-
 +
| {{icon|dab|disamb|disambig|disambiguation}} || '''Disambiguation page''' || {{tlf|icon|Disambig}}
 +
|-
 +
| {{icon|Image|File}} || '''File''' || {{tlf|icon|Image}}
 +
|-
 +
| {{icon|VP}} || '''Valued Picture''' || {{tlf|icon|VP}}
 +
|-
 +
| {{icon|VPC}} || '''Valued Picture Candidate''' || {{tlf|icon|VPC}}
 +
|-
 +
| {{icon|outline}} || '''Outline''' || {{tlf|icon|Outline}}
 +
|-
 +
| {{icon|portal}} || '''Portal''' || {{tlf|icon|Portal}}
 +
|-
 +
| {{icon|project}} || '''Project Page''' || {{tlf|icon|Project}}
 +
|-
 +
| {{icon|red|redir|redirect}} || '''Redirect''' || {{tlf|icon|Redirect}}
 +
|-
 +
| {{icon|temp|templ|template}} || '''Template''' || {{tlf|icon|Template}}
 +
|-
 +
| {{icon|module}} || '''Module''' || {{tlf|icon|module}}
 +
|-
 +
| {{icon|essay}} || '''Essay''' || {{tlf|icon|Essay}}
 +
|-
 +
| {{icon|na}} || '''Non-article Page''' || {{tlf|icon|NA}}
 +
|-
 +
| {{icon|no}} || '''Unknown-Class Article''' || {{tlf|icon|NO}}
 +
|-
 +
| {{icon|Unassessed}} || '''Unassessed Article''' || {{tlf|icon|Unassessed}}
 +
|-
 +
| {{icon|aa}} || '''Audited Article of limited subject matter''' || {{tlf|icon|AA}}
 +
|-
 +
| {{icon|DA}} || '''Demoted Article''' || {{tlf|icon|DA}}
 +
|-
 +
| {{icon|DYK}} || '''Did You Know?''' || {{tlf|icon|DYK}}
 +
|-
 +
| {{icon|DYK2}} || '''Did You Know? (alternate)''' || {{tlf|icon|DYK2}}
 +
|-
 +
| {{icon|ITN}} || '''In The News''' || {{tlf|icon|ITN}}
 +
|-
 +
| {{icon|OTD}} || '''On This Day''' || {{tlf|icon|OTD}}
 +
|-
 +
| {{icon|PR}} || '''Peer Review''' || {{tlf|icon|PR}}
 +
|-
 +
| {{icon|PPR}} || '''Portal Peer Review''' || {{tlf|icon|PPR}}
 +
|-
 +
| {{icon|Q}} || '''Question''' || {{tlf|icon|Q}}
 +
|-
 +
| {{icon|QI}} || '''Quality Image on Wikimedia Commons''' || {{tlf|icon|QI}}
 +
|-
 +
| {{icon|TFA}} || '''Today's Featured Article''' || {{tlf|icon|TFA}}
 +
|-
 +
| {{icon|VI}} || '''Valued Image on Wikimedia Commons''' || {{tlf|icon|VI}}
 +
|-
 +
| {{icon|Commons}} || '''Commons page''' || {{tlf|icon|Commons}}
 +
|-
 +
| {{icon|Meta}} || '''Meta-wiki page''' || {{tlf|icon|Meta}}
 +
|-
 +
| {{icon|Wikibooks}} || '''Wikibooks page''' || {{tlf|icon|Wikibooks}}
 +
|-
 +
| {{icon|Wikidata}} || '''Wikidata page''' || {{tlf|icon|Wikidata}}
 +
|-
 +
| {{icon|Wikinews}} || '''Wikinews page''' || {{tlf|icon|Wikinews}}
 +
|-
 +
| {{icon|Wikipedia}} || '''Wikipedia page''' || {{tlf|icon|Wikipedia}}
 +
|-
 +
| {{icon|WikiProject}} || '''WikiProject page''' || {{tlf|icon|WikiProject}}
 +
|-
 +
| {{icon|Wikiquote}} || '''Wikiquote page''' || {{tlf|icon|Wikiquote}}
 +
|-
 +
| {{icon|Wikisource}} || '''Wikisource page''' || {{tlf|icon|Wikisource}}
 +
|-
 +
| {{icon|Wikispecies}} || '''Wikispecies page''' || {{tlf|icon|Wikispecies}}
 +
|-
 +
| {{icon|Wikiversity}} || '''Wikiversity page''' || {{tlf|icon|Wikiversity}}
 +
|-
 +
| {{icon|Wikivoyage}} || '''Wikivoyage page''' || {{tlf|icon|Wikivoyage}}
 +
|-
 +
| {{icon|Wiktionary}} || '''Wiktionary page''' || {{tlf|icon|Wiktionary}}
 +
|-
 +
| {{icon|FOUR}} || '''Four Award''' || {{tlf|icon|FOUR}}
 +
|-
 +
| {{icon|Million}} || '''Million Award''' || {{tlf|icon|Million}}
 +
|}
 +
 
 +
== TemplateData ==
 +
{{TemplateData header}}
 +
<templatedata>
 +
{
 +
"description": "This template creates an inline icon-sized image. Please refer to 'Template:Icon/doc' for the list of supported values.",
 +
"params": {
 +
"1": {
 +
"label": "Icon",
 +
"description": "The identifier or name of the icon to be displayed.",
 +
"type": "line",
 +
"required": false,
 +
"aliases": [
 +
"class"
 +
],
 +
"default": ""
 +
},
 +
"size": {
 +
"description": "The size of the icon to display, e.g. \"30px\".",
 +
"type": "line",
 +
"default": "16x16px"
 +
}
 +
}
 +
}
 +
</templatedata>
 +
 
 +
== See also ==
 +
* {{tl|icon+link}}
 +
*[[Template:Done/See also]] - Inline icon templates by shape and color.
 +
*[[Template:Table cell templates/doc]] -
 +
{{Wikipedia templates|state=collapsed}}
 +
<!--This page transcluded beyond this template's page/subpages, so:-->
 +
{{#ifeq:{{FULLPAGENAME}}|Template:Icon|
 +
[[Category:Single-image insertion templates]]
 +
}}

Latest revision as of 07:49, 5 December 2020

This template creates an inline image that is used in metapages such as Wikipedia:Vital articles and/or in user pages.

Syntax

Basic usage

{{icon|code}}
{{icon|class=code}}

Custom size

{{icon|code|size=size}}

Parameters

  • 1 or class - the icon code. See the table below for a list of available codes.
  • size - a custom icon size, e.g. "30px". The default size is "16x16px" (16 by 16 pixels).

Icon codes

Icon  Type  Code 
16x16px Vital Article {{icon|Vital}}
16x16px Featured Article {{icon|FA}}
16x16px Featured Article Candidate {{icon|FAC}}
16x16px Featured Article Review {{icon|FAR}}
16x16px Featured Article Removal Candidate {{icon|FARC}}
16x16px Former Featured Article {{icon|FFA}}
16x16px Failed Featured Article Candidate {{icon|FFAC}}
16x16px Featured Picture {{icon|FP}}
16x16px Featured Picture Candidate {{icon|FPC}}
16x16px Former Featured Picture {{icon|FFP}}
16x16px Featured Portal {{icon|FPo}}
16x16px Former Featured Portal {{icon|FFPo}}
16x16px Featured Portal Candidate {{icon|FPoC}}
16x16px Featured Portal Review {{icon|FPoR}}
16x16px Featured Sound {{icon|FS}}
16x16px Former Featured Sound {{icon|FFS}}
16x16px Featured Sound Candidate {{icon|FSC}}
16x16px Featured Topic {{icon|FT}}
16x16px Featured Topic Candidate {{icon|FTC}}
16x16px Featured Topic Removal Candidate {{icon|FTRC}}
16x16px Former Featured Topic {{icon|FFT}}
16x16px A-Class Article {{icon|A}}
16x16px A-Class Article Candidate {{icon|ACC}}
16x16px Demoted A-Class Article {{icon|DAA}}
16x16px Failed A-Class Article Candidate {{icon|FAAC}}
16x16px Good Article {{icon|GA}}
16x16px Good Article Nominee {{icon|GAN}}
16x16px Good Article, 2nd Opinion {{icon|GA2}}
16x16px Good Article on Hold {{icon|GAH}}
16x16px Good Article Reassessment {{icon|GAR}}
16x16px Delisted Good Article {{icon|DGA}}
16x16px Failed Good Article Nominee {{icon|FGAN}}
16x16px Good Topic {{icon|GT}}
16x16px Good Topic Candidate {{icon|GTC}}
16x16px Good Topic Removal Candidate {{icon|GTRC}}
16x16px Bplus-Class Article {{icon|BPLUS}}
16x16px B-Class Article {{icon|B}}
16x16px B-Class Review {{icon|BR}}
16x16px C-Class Article {{icon|C}}
16x16px Start-Class Article {{icon|START}}
16x16px Stub-Class Article {{icon|STUB}}
16x16px Featured List {{icon|FL}}
16x16px Featured List Candidate {{icon|FLC}}
16x16px Former Featured List {{icon|FFL}}
16x16px Failed Featured List Candidate {{icon|FFLC}}
16x16px Featured List Review {{icon|FLR}}
16x16px Featured List Removal Candidate {{icon|FLRC}}
16x16px List-Class Article {{icon|LIST}}
16x16px Wikipedia Book {{icon|Book}}
16x16px Category {{icon|Category}}
16x16px Disambiguation page {{icon|Disambig}}
16x16px File {{icon|Image}}
16x16px Valued Picture {{icon|VP}}
16x16px Valued Picture Candidate {{icon|VPC}}
16x16px Outline {{icon|Outline}}
16x16px Portal {{icon|Portal}}
16x16px Project Page {{icon|Project}}
16x16px Redirect {{icon|Redirect}}
16x16px Template {{icon|Template}}
16x16px Module {{icon|module}}
16x16px Essay {{icon|Essay}}
16x16px Non-article Page {{icon|NA}}
16x16px Unknown-Class Article {{icon|NO}}
16x16px Unassessed Article {{icon|Unassessed}}
16x16px Audited Article of limited subject matter {{icon|AA}}
16x16px Demoted Article {{icon|DA}}
16x16px Did You Know? {{icon|DYK}}
16x16px Did You Know? (alternate) {{icon|DYK2}}
16x16px In The News {{icon|ITN}}
16x16px On This Day {{icon|OTD}}
16x16px Peer Review {{icon|PR}}
16x16px Portal Peer Review {{icon|PPR}}
16x16px Question {{icon|Q}}
16x16px Quality Image on Wikimedia Commons {{icon|QI}}
16x16px Today's Featured Article {{icon|TFA}}
16x16px Valued Image on Wikimedia Commons {{icon|VI}}
16x16px Commons page {{icon|Commons}}
16x16px Meta-wiki page {{icon|Meta}}
16x16px Wikibooks page {{icon|Wikibooks}}
16x16px Wikidata page {{icon|Wikidata}}
16x16px Wikinews page {{icon|Wikinews}}
16x16px Wikipedia page {{icon|Wikipedia}}
16x16px WikiProject page {{icon|WikiProject}}
16x16px Wikiquote page {{icon|Wikiquote}}
16x16px Wikisource page {{icon|Wikisource}}
16x16px Wikispecies page {{icon|Wikispecies}}
16x16px Wikiversity page {{icon|Wikiversity}}
16x16px Wikivoyage page {{icon|Wikivoyage}}
16x16px Wiktionary page {{icon|Wiktionary}}
16x16px Four Award {{icon|FOUR}}
16x16px Million Award {{icon|Million}}

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Icon

This template creates an inline icon-sized image. Please refer to 'Template:Icon/doc' for the list of supported values.

Template parameters

ParameterDescriptionTypeStatus
Icon1 class

The identifier or name of the icon to be displayed.

Default
Lineoptional
Sizesize

The size of the icon to display, e.g. "30px".

Default
16x16px
Lineoptional

See also