Template:ArticleIcons/doc: Difference between revisions
m (→Usage: clarifying) |
(adding icon for series in general) |
||
| Line 1: | Line 1: | ||
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: | 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:SSB Icon.png|24px]] shows that the article relates to ''[[Super Smash Bros. (series)|Super Smash Bros.]]'' (the series in general). | |||
*[[Image:SSB64 Icon.png|24px]] denotes that the article relates to ''[[Super Smash Bros.]]'' (the original, [[Nintendo 64]], game). | *[[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]]''. | ||
| Line 11: | Line 12: | ||
==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>allgames</code> or <code>series</code> | |||
*<code>ssb</code> or <code>ssb64</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>ssb4</code> | *<code>ssb4</code> | ||
*<code>unofficial</code> (for unofficial lingo) | *<code>unofficial</code> (for unofficial lingo) | ||
*<code>fa</code> or <code>featured</code> | *<code>fa</code> or <code>featured</code> | ||
Revision as of 11:21, March 28, 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 Super Smash Bros. 4.
means that the article's title is unofficial.
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:
allgamesorseriesssborssb64ssbmormeleessbborbrawlssb4unofficial(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.
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.
