Template:Symbol/doc

This is a documentation subpage for Template:Symbol.
It may contain usage information, categories and other content that is not part of the original template page.

Shortcut

{{SymTemplate: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.

One advantage over using a [[File: ...]] tag directly is the automatic setting of the noviewer class, which disables the Media Viewer.

Syntax

{{symbol|filename or stock option|width|description|link=[yes/no]}}

Parameters

File name without "File:" (required), or built-in stock option code
Width in pixels, default 18
Description, appears on mouse over
|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

{{symbol|Segnale generico.svg}} →
{{symbol|Segnale generico.svg|30}} →
{{symbol|Segnale generico.svg||Attention}} →
{{symbol|Segnale generico.svg|30|Attention}} →
{{symbol|Segnale generico.svg|30|link=no}} →
{{symbol|fac}} →
{{symbol|fac|30}} →
{{symbol|fac||Example hover text}} →
{{symbol|fac|30|Example hover text}} →

Stock options

These are the various stock options, along with their output. These are all case-insensitive; |1=g and |1=G both produce .

Stock options
Values	Output
check, done, d, tick
maybe, partly done, pd, half done, yellow tick
not done, nd, cross, x
pass, good, g, ga, good article, yes, y, ok, k, +, aye
fail, bad, no, n, -, nk, nay
dunno, ?, ??, ???, idk, question
comment, c
neu, neutral, und, equal
hold, on hold, wait
wtf
love, heart, wikilove
info, i, note
thanks, smile, smiley, thank you, s
gac, ga candidate, good article candidate
fa, featured article
fac, featured article candidate
pr, peer review

Template data

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Symbol in articles based on its TemplateData.

TemplateData for Symbol

A template to insert various symbols inline. There are built-in stock options, or you can use any freely-licensed image of your choosing.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
File title	`1`	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)	Line	required
Symbol size	`2`	Width in pixels of the symbol (without '' px ''). Default is 18. Example: 30.	Number	optional
Description of the symbol	`alt` `3`	Description of the symbol, which will appear when you move the mouse over the image. This also functions as the image's alt text	Line	optional
Flag to deactivate the link	`link`	Fill in with "no" to disable the image link.	Boolean	optional