View source for Template:Text-icon/doc

<noinclude>{{doc subpage}}[[Category:Template documentation]]</noinclude>
== Documentation ==

This template displays a little makeshift text-only icon. This is usually called from other more "useful" templates.<!-- list these under See also --> If you use this separately, you might want to enclose it in a {{htag|sup}} (superscript) element, since that is not done by default.

=== Usage ===

* {{tc-names|text-icon|text|color|background-color|font-weight|font-family|border|tip|space-same-font}}

The text shown in the icon (usually a single character) is specified in the named parameter {{tp|text}}. For convenience, this can also be passed to the template in the first positional parameter (i.e., you can omit the {{tp|text|{{null}}}} name from the template call).

The parameters {{tp|color}}, {{tp|background-color}}, {{tp|font-weight}}, {{tp|font-family}}, and {{tp|border}} are used as the values of the same-named CSS {{code|style}} attributes in a {{htag|span}} element. The default values are:
: {{code|<nowiki>color=white; background-color=#e00; font-weight=bold; font-family=monospace; border=0;</nowiki>}}
See, for example, {{xl|url=//www.w3.org/TR/CSS2/#minitoc|linktext=W3C's CSS2 documentation}} for other valid values.

The parameter {{tp|tip}} can be used to specify a "tooltip" to show when the reader "hovers" on the icon. Note that '''double-quote characters ({{code|"}}) cannot be used''' in the value of {{tp|tip}} because the tooltip text is already enclosed by double quotes in the template code. This might be changed in the future. For now, if you want to quote something, you'll have to use single quotes ({{code|'}}). Some templates that call this one already have their own mechanisms for creating tooltips. This should be remedied eventually.

The parameter {{tp|space-same-font}} can be set to any [[Help:True value|true value]] to render the space characters (non-breaking spaces, to be specific) surrounding the {{tp|text}} in the same font. This might be necessary to fix certain display issues. Otherwise, the space characters are rendered using the default font.

=== Examples ===

* {{tc-nameval|text-icon|text|🞂}} ⇒ {{text-icon|text=🞂}}
* {{tc-nameval|text-icon|text|🞂|border|1pt solid gray}} ⇒ {{text-icon|text=🞂|border=1pt solid gray}}
* {{tc-nameval|text-icon|text|🞂|color|white|background-color|red}} ⇒ {{text-icon|text=🞂|color=white|background-color=red}}
* {{tc-nameval|text-icon|text|i|color|white|background-color|blue|font-weight|bold|font-family|monospace|tip|information}} ⇒ {{text-icon|text=i|color=white|background-color=blue|font-weight=bold|font-family=monospace|tip=information}}
* {{tc-nameval|text-icon|text|i|color|white|background-color|blue|font-weight|bold|font-family|monospace|tip|information|space-same-font|y}} ⇒ {{text-icon|text=i|color=white|background-color=blue|font-weight=bold|font-family=monospace|tip=information|space-same-font=y}}

<h3>See also</h3>
{{List of similar text-icon templates|intro=Templates that call this one|nobold=y}}

<includeonly>
[[Category:Templates]]
[[Category:Templates for icons]]
[[Category:Templates mostly called by other templates]]
[[Category:Templates often used multiple times per page]]
</includeonly>