Template:Icon/doc
 | This is a documentation subpage for Template:Icon. It contains usage information, categories, and other content that is not part of the original template page. |
 | This template employs intricate features of the template syntax.
Please do not attempt to alter it unless you are certain that you understand the setup and are prepared to repair/revert any consequent collateral damage if the results are unexpected. You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here. |
This template displays and formats one of several icons followed by optional text. You can use this template for voting in strawpolls, indicating the status of something, or practically anything else where you want to use a commonly recognized icon in a discussion, infobox, or within another template.
Usage
[edit]Remember to subst: the template - it won't work if not subst:ed
Basic usage:
- {{subst:Icon|option}} places an image and some bolded text, according to the tables below
- {{subst:Icon|option|your text}} replaces the standard bolded text with the supplied your text
If your text includes an equals sign ("=") use this form:
- {{subst:Icon|icon=option|text=your text}}
If your text includes a verical pipe symbol ("|"), you may need to use the "{{!}}" template in place of the pipe symbol.
see-comment, see-note, and see-tip each accept a recommended element named "see" that links to additional information. For example:
- {{subst:Icon|icon=see-note|see=below}}
Would produce:
See note below
If you do not wish your words to be bolded, add |bold=n. Repeating the previous example:
- {{subst:Icon|icon=see-note|see=below|bold=n}}
Would produce:
- See note below
You can choose not to have any text appear. Simply leave the |text= empty and turn off bolding, like this:
- {{subst:Icon|option|text=|bold=n}}
- {{subst:Icon|icon=option|text=|bold=n}}
If you are using this template within another template or a table, you might want to prevent line breaks within the text. This feature should not be used in a normal discussion. It should be limited to use only where it is absolutely necessary to keep the icon and all of the text together unbroken on a single line. To do so, add |wrap=n.
Options and examples
[edit]
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
