Template:ArticleIcons/doc: Difference between revisions

From SmashWiki, the Super Smash Bros. wiki
Jump to navigationJump to search
No edit summary
(→‎Usage: Note on the difference between series/allgames, if I've understood it somewhat correctly)
Line 30: Line 30:
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.
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.


===Protected icon===
===Protected icon===

Revision as of 10:03, June 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:

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:

  • series
  • ssb or ssb64
  • ssbm or melee
  • ssbb or brawl
  • ssb4 or ssb4-both
  • ssb4-3ds or ssb4-3
  • ssb4-wiiu or ssb4-wii-u or ssb4-u
  • unofficial (for unofficial lingo)
  • fa or featured
  • protected

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. 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":

  • ProtectIconRed.png vandalism
  • ProtectIconYellow.png highrisk
  • ProtectIconGreen.png editwar
  • ProtectIconBlue.png 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

Improvements

If you have ideas for other icons, post on Template talk:ArticleIcons.