Template:ArticleIcons/doc: Difference between revisions

From SmashWiki, the Super Smash Bros. wiki
Jump to navigationJump to search
(Prose update.)
No edit summary
Tag: Mobile edit
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:SSB Icon.png|24px]] shows that the article relates to ''{{b|Super Smash Bros.|series}}'' (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]]''.
*[[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: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]]'' as a whole or otherwise covers both the 3DS and Wii U versions.
*[[Image:SSB4 Icon.png|24px]] shows that the article relates to ''[[Super Smash Bros. 4]]'' as a whole or otherwise covers both the 3DS and Wii U versions.
*[[Image:SSB4-3 Icon.png|24px]] shows that the article relates specifically to ''[[Super Smash Bros. for Nintendo 3DS]]''.
*[[Image:SSB4-3 Icon.png|24px]] shows that the article relates specifically to {{for3ds}}.
*[[Image:SSB4-U Icon.png|24px]] shows that the article relates specifically to ''[[Super Smash Bros. for Wii U]]''.
*[[Image:SSB4-U Icon.png|24px]] shows that the article relates specifically to {{forwiiu}}.
*[[Image:Unofficial Lingo.png|24px]] means that the article's title is [[:Category:Unofficial lingo|unofficial]].
*[[Image:Unofficial Lingo.png|24px]] means that the article's title is [[:Category:Unofficial lingo|unofficial]].
*[[Image:Competitive.png|24px]] means that the article relates to [[competitive play]].
*[[Image:Competitive.png|24px]] means that the article relates to [[competitive play]].

Revision as of 13:20, November 21, 2014

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
  • pm or projectm
  • 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 (at this time: SSB64 Icon.pngSSBM Icon.pngSSBB Icon.pngSSB4 Icon.png). 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.