Template:ArticleIcons/doc: Difference between revisions
(+competitive) |
No edit summary |
||
| Line 4: | Line 4: | ||
*[[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:PM Icon.png|24px]] shows that the article relates to [[Project M]]. '''Not''' to be used outside PM-only pages and relevant tournaments. | |||
*[[Image:SSB4 Icon.png|24px]] shows that the article relates to ''[[Super Smash Bros. 4]]'' (both versions). | *[[Image:SSB4 Icon.png|24px]] shows that the article relates to ''[[Super Smash Bros. 4]]'' (both versions). | ||
*[[Image:SSB4-3 Icon.png|24px]] shows that the article relates to ''Super Smash Bros. 4'' (3DS version only). | *[[Image:SSB4-3 Icon.png|24px]] shows that the article relates to ''Super Smash Bros. 4'' (3DS version only). | ||
| Line 19: | Line 20: | ||
*<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>pm</code> or <code>projectm</code> | |||
*<code>ssb4</code> or <code>ssb4-both</code> | *<code>ssb4</code> or <code>ssb4-both</code> | ||
*<code>ssb4-3ds</code> or <code>ssb4-3</code> | *<code>ssb4-3ds</code> or <code>ssb4-3</code> | ||
| Line 31: | Line 33: | ||
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. | ||
The <code>allgames</code> parameter will show icons for all games. Note that <code>allgames</code> and <code>series</code> are not equivalent; the latter should only be used for elements that are inherent to the series and its games, or similarly. As such, it's not necessarily qualified just because it has appeared in all the games. | The <code>allgames</code> parameter will show icons for all games (at this time: [[Image:SSB64 Icon.png|20px]][[Image:SSBM Icon.png|20px]][[Image:SSBB Icon.png|20px]][[Image:SSB4 Icon.png|20px]]). Note that <code>allgames</code> and <code>series</code> are not equivalent; the latter should only be used for elements that are inherent to the series and its games, or similarly. As such, it's not necessarily qualified just because it has appeared in all the games. | ||
===Protected icon=== | ===Protected icon=== | ||
Revision as of 13:53, November 20, 2013
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:
shows that the article relates to Super Smash Bros. (the series in general).
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.
shows that the article relates to Project M. Not to be used outside PM-only pages and relevant tournaments.
shows that the article relates to Super Smash Bros. 4 (both versions).
shows that the article relates to Super Smash Bros. 4 (3DS version only).
shows that the article relates to Super Smash Bros. 4 (Wii U version only).
means that the article's title is unofficial.
means that the article relates to competitive play.
is how featured articles are marked.
shows that the page is protected.
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:
seriesssborssb64ssbmormeleessbborbrawlpmorprojectmssb4orssb4-bothssb4-3dsorssb4-3ssb4-wiiuorssb4-wii-uorssb4-uunofficial(for unofficial lingo)faorfeaturedprotected
Activating any of these parameters with any argument (such as ssb=y) will show its icon, with pipes (|) between each parameter. Examples:
{{ArticleIcons|ssb=y}}{{ArticleIcons|ssbm=yes|ssbb=yes}}{{ArticleIcons|brawl=1|featured=1}}
The order of icons will always be the same, no matter what order they are written in.
The allgames parameter will show icons for all games (at this time: 
). Note that allgames and series are not equivalent; the latter should only be used for elements that are inherent to the series and its games, or similarly. As such, it's not necessarily qualified just because it has appeared in all the games.
Protected icon
The protected icon should be given certain values other than anything generic, such as "y":
vandalism
highrisk
editwar
preemptive
These values produce different icon colours and rollover text relating to the protection type. If anything else is entered, it is used as a custom reason.
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.
