View source for Template:Icon/doc

{{Documentation subpage}}
<includeonly>{{High-risk|260,000+}}</includeonly>
{{lua|Module:Icon}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->

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-->
{{col-begin}}
<!--Following order of Category classes:-->
{{col-break}}
{| class="wikitable sortable" style="font-size:95%"
! Icon&nbsp; || Type&nbsp; || Code&nbsp;
|-
| {{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}}
|}
{{col-break}}
{| class="wikitable sortable" style="font-size:95%"
! Icon&nbsp; || Type&nbsp; || Code&nbsp;
|-
| {{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|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|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}}
|}
{{col-end}}

== 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}}

<!--This page transcluded beyond this template's page/subpages, so:-->
{{#ifeq:{{FULLPAGENAME}}|Template:Icon
 | <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Single-image insertion templates]]
}}