Template:Symbol/doc

icon

This is a documentation subpage for Template:Terminate sentence
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

<syntaxhighlight inline="1" lang="wikitext">{{symbol|Segnale generico.svg}}</syntaxhighlight> → File:Segnale generico.svg
<syntaxhighlight inline="1" lang="wikitext">{{symbol|Segnale generico.svg|30}}</syntaxhighlight> → File:Segnale generico.svg
<syntaxhighlight inline="1" lang="wikitext">{{symbol|Segnale generico.svg||Attention}}</syntaxhighlight> → Attention
<syntaxhighlight inline="1" lang="wikitext">{{symbol|Segnale generico.svg|30|Attention}}</syntaxhighlight> → Attention
<syntaxhighlight inline="1" lang="wikitext">{{symbol|Segnale generico.svg|30|link=no}}</syntaxhighlight> → File:Segnale generico.svg
<syntaxhighlight inline="1" lang="wikitext">{{symbol|fac}}</syntaxhighlight> → Featured article candidate
<syntaxhighlight inline="1" lang="wikitext">{{symbol|fac|30}}</syntaxhighlight> → Featured article candidate
<syntaxhighlight inline="1" lang="wikitext">{{symbol|fac||Example hover text}}</syntaxhighlight> → Example hover text
<syntaxhighlight inline="1" lang="wikitext">{{symbol|fac|30|Example hover text}}</syntaxhighlight> → 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 Good.

Stock options
Values	Output
check, done, tick	Done
maybe, partly done, half done, yellow tick	Partly done
not done, cross, x	Not Done
pass, good, g, ga, good article, yes, y, ok, k, +, aye	Good
fail, bad, no, n, -, nk, nay	Fail
dunno, ?, ??, ???, idk, question	?
comment, c	Comment
neu, neutral, und, equal	Neutral
hold, on hold, wait	On Hold
wtf	???
love, heart, wikilove	Love
info, i, note	Note
thanks, smile, smiley, thank you, s	Smile!
gac, ga candidate, good article candidate	Good article candidate
fa, featured article	Featured article
fac, featured article candidate	Featured article candidate
pr, peer review	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

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