View source for Template:Symbol/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{tsh|Sym}}

== Usage ==
This template is for inserting a very small image in line, used as an icon. It also accepts a variety of commonly-used [[#Stock options|stock options]].

One advantage over using a <nowiki>[[File: ...]]</nowiki> tag directly is the automatic setting of the <code>noviewer</code> class, which disables the [[Wikipedia:Media Viewer|Media Viewer]].

==Syntax==
<code><nowiki>{{symbol|filename or stock option|width|description|link=[yes/no]}}</nowiki></code>

==Parameters==
* '''File name''' without "File:" (required), or [[#Stock option|built-in stock option code]]
* Width in pixels, default 18
* Description, appears on mouse over
* {{para|link|no}}, to make the symbol not link to the file description page. Note that this should only be disabled if the image is in the public domain per [[MOS:BLANKALT]], as otherwise the link is legally required for attribution.

==Examples==
* {{demo inline|<nowiki>{{symbol|Segnale generico.svg}}</nowiki>}}
* {{demo inline|<nowiki>{{symbol|Segnale generico.svg|30}}</nowiki>}}
* {{demo inline|<nowiki>{{symbol|Segnale generico.svg||Attention}}</nowiki>}}
* {{demo inline|<nowiki>{{symbol|Segnale generico.svg|30|Attention}}</nowiki>}}
* {{demo inline|<nowiki>{{symbol|Segnale generico.svg|30|link=no}}</nowiki>}}
* {{demo inline|<nowiki>{{symbol|fac}}</nowiki>}}
* {{demo inline|<nowiki>{{symbol|fac|30}}</nowiki>}}
* {{demo inline|<nowiki>{{symbol|fac||Example hover text}}</nowiki>}}
* {{demo inline|<nowiki>{{symbol|fac|30|Example hover text}}</nowiki>}}

== Stock options ==
These are the various stock options, along with their output. These are all case-insensitive; {{para|1|g}} and {{para|1|G}} both produce {{symbol|g}}.
{| class="wikitable"
|+ {{sronly|Stock options}}
! scope="col" | Values
! scope="col" | Output
|-
|check, done, tick
|{{sym|check}}
|-
|maybe, partly done, half done, yellow tick
|{{sym|partly done}}
|-
|not done, cross, x
|{{sym|not done}}
|-
|pass, good, g, ga, good article, yes, y, ok, k, +, aye || {{sym|pass}}
|-
|fail, bad, no, n, -, nk, nay
|{{sym|fail}}
|-
|dunno, ?, ??, ???, idk, question
|{{sym|dunno}}
|-
|comment, c
|{{sym|comment}}
|-
|neu, neutral, und, equal
|{{sym|neu}}
|-
|hold, on hold, wait
|{{sym|hold}}
|-
|wtf
|{{sym|wtf}}
|-
|love, heart, wikilove
|{{sym|love}}
|-
|info, i, note
|{{sym|info}}
|-
|thanks, smile, smiley, thank you, s
|{{sym|thanks}}
|-
|gac, ga candidate, good article candidate
|{{sym|gac}}
|-
|fa, featured article
|{{sym|fa}}
|-
|fac, featured article candidate
|{{sym|fac}}
|-
|pr, peer review
|{{sym|pr}}
|}

==Template data==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "File title",
			"description": "The title of the file without the prefix \"File:\" or \"Image:\", or one of the built-in stock options (see [[Template:Symbol/doc#Stock options]] for available choices)",
			"type": "line",
			"required": true
		},
		"2": {
			"label": "Symbol size",
			"description": "Width in pixels of the symbol (without '' px ''). Default is 18. Example: 30.",
			"type": "number"
		},
		"link": {
			"label": "Flag to deactivate the link",
			"description": "Fill in with \"no\" to disable the image link.",
			"type": "boolean"
		},
		"alt": {
			"aliases": [
				"3"
			],
			"label": "Description of the symbol",
			"description": "Description of the symbol, which will appear when you move the mouse over the image. This also functions as the image's alt text",
			"type": "line"
		}
	},
	"description": "A template to insert various symbols inline. There are built-in stock options, or you can use any freely-licensed image of your choosing.",
	"format": "inline",
	"paramOrder": [
		"1",
		"2",
		"alt",
		"link"
	]
}
</templatedata>

==See also==
* [[Template:Flag icon]]
* [[Template:Infobox symbol]]
* [[Template:Val]] &ndash; values in scientific notation

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Wikipedia-specific image insertion templates]]
[[Category:Icon insertion templates]]

}}</includeonly>