Template:ArticleIcons/doc: Difference between revisions
From SmashWiki, the Super Smash Bros. wiki
Jump to navigationJump to search
No edit summary |
mNo edit summary |
||
Line 1: | Line 1: | ||
This template is for use in | This template is intended for use in most [[SmashWiki:About|SmashWiki]] articles. It is used to display a series of icons in the top right corner of the article that quickly point out certain things about its content: | ||
*[[Image:SSB64 Icon.png|24px]] denotes that the article relates to Super Smash Bros. (64). | *[[Image:SSB64 Icon.png|24px]] denotes that the article relates to ''[[Super Smash Bros.]]'' (the original, [[Nintendo 64]], game). | ||
*[[Image:SSBM Icon.png|24px]] indicates that the article relates to Super Smash Bros. Melee. | *[[Image:SSBM Icon.png|24px]] indicates that the article relates to ''[[Super Smash Bros. Melee]]''. | ||
*[[Image:SSBB Icon.png|24px]] shows that the article relates to Super Smash Bros. Brawl. | *[[Image:SSBB Icon.png|24px]] shows that the article relates to ''[[Super Smash Bros. Brawl]]''. | ||
*[[Image:Unofficial Lingo.png|24px]] means that the article's title is unofficial. | *[[Image:Unofficial Lingo.png|24px]] means that the article's title is [[:Category:Unofficial lingo|unofficial]]. | ||
*[[Image:Featured.png|24px]] is how featured articles are marked. | *[[Image:Featured.png|24px]] is how [[SmashWiki:Featured content|featured articles]] are marked. | ||
Articles may make use of zero, one, many, or all of these icons as necessary. | Articles may make use of zero, one, many, or all of these icons as necessary. | ||
==Usage== | ==Usage== | ||
The basic template, <code><nowiki>{{ArticleIcons}}</nowiki></code>, will not display anything. Parameters are used to tell the template which icons to display: | The basic template, <code><nowiki>{{ArticleIcons}}</nowiki></code>, will not display anything. Parameters are used to tell the template which icons to display: | ||
*<code> | *<code>ssb</code> or <code>ssb64</code> | ||
*<code>ssbm</code> or <code>melee</code> | *<code>ssbm</code> or <code>melee</code> | ||
*<code>ssbb</code> or <code>brawl</code> | *<code>ssbb</code> or <code>brawl</code> | ||
*<code>unofficial</code> | *<code>unofficial</code> | ||
*<code>fa</code> or <code>featured</code> | *<code>fa</code> or <code>featured</code> | ||
Setting one of these parameters to "y" (such as <code> | Setting one of these parameters to "y" (such as <code>ssb=y</code>) will show its icon, with pipes (<code>|</code>) between each parameter. Examples: | ||
*<code><nowiki>{{ArticleIcons| | *<code><nowiki>{{ArticleIcons|ssb=y}}</nowiki></code> | ||
*<code><nowiki>{{ArticleIcons|ssbm=y|ssbb=y}}</nowiki></code> | *<code><nowiki>{{ArticleIcons|ssbm=y|ssbb=y}}</nowiki></code> | ||
*<code><nowiki>{{ArticleIcons|brawl=y|featured=y}}</nowiki></code> | *<code><nowiki>{{ArticleIcons|brawl=y|featured=y}}</nowiki></code> | ||
The order of icons will always be the same, no matter what order they are written in. | The order of icons will always be the same, no matter what order they are written in. | ||
==Other features== | ==Other features== | ||
*The icons link to an appropriate article or category when clicked on. | *The icons link to an appropriate article or category when clicked on. | ||
*Adding the unofficial lingo icon automatically places the article into [[:Category:Unofficial lingo]], while the featured article icon puts it in [[:Category:Featured Articles]]. | *Adding the unofficial lingo icon automatically places the article into [[:Category:Unofficial lingo]], while the featured article icon puts it in [[:Category:Featured Articles]]. | ||
==Improvements== | ==Improvements== | ||
If you have ideas for other icons, post on [[Template talk:ArticleIcons]]. | If you have ideas for other icons, post on [[Template talk:ArticleIcons]]. | ||
<noinclude>[[Category:Template documentation]]</noinclude> |
Revision as of 14:41, June 24, 2011
This template is intended for use in most SmashWiki articles. It is used to display a series of icons in the top right corner of the article that quickly point out certain things about its content:
- denotes that the article relates to Super Smash Bros. (the original, Nintendo 64, game).
- indicates that the article relates to Super Smash Bros. Melee.
- shows that the article relates to Super Smash Bros. Brawl.
- means that the article's title is unofficial.
- is how featured articles are marked.
Articles may make use of zero, one, many, or all of these icons as necessary.
Usage
The basic template, {{ArticleIcons}}
, will not display anything. Parameters are used to tell the template which icons to display:
ssb
orssb64
ssbm
ormelee
ssbb
orbrawl
unofficial
fa
orfeatured
Setting one of these parameters to "y" (such as ssb=y
) will show its icon, with pipes (|
) between each parameter. Examples:
{{ArticleIcons|ssb=y}}
{{ArticleIcons|ssbm=y|ssbb=y}}
{{ArticleIcons|brawl=y|featured=y}}
The order of icons will always be the same, no matter what order they are written in.
Other features
- The icons link to an appropriate article or category when clicked on.
- Adding the unofficial lingo icon automatically places the article into Category:Unofficial lingo, while the featured article icon puts it in Category:Featured Articles.
Improvements
If you have ideas for other icons, post on Template talk:ArticleIcons.