Template:ArticleIcons/doc: Difference between revisions

From SmashWiki, the Super Smash Bros. wiki
Jump to navigationJump to search
No edit summary
Tag: Mobile edit
m (Text replacement - "class=("?)invert\b([^-])" to "class=$1invert-dark$2")
 
(16 intermediate revisions by 7 users not shown)
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 ''{{b|Super Smash Bros.|series}}'' (the series in general).
*[[File: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).
*[[File: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]]''.
*[[File:SSBM Icon.png|24px|class=invert-dark]] 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]]''.
*[[File: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.
*[[File: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.
*[[File:SSB4-3 Icon.png|24px]] shows that the article relates specifically to {{for3ds}}.
*[[Image:SSB4-3 Icon.png|24px]] shows that the article relates specifically to {{for3ds}}.
*[[File:SSB4-U Icon.png|24px]] shows that the article relates specifically to {{forwiiu}}.
*[[Image:SSB4-U Icon.png|24px]] shows that the article relates specifically to {{forwiiu}}.
*[[File:SSBU Icon.png|24px|class=invert-dark]] shows that the article relates to ''[[Super Smash Bros. Ultimate]]''.
*[[Image:Unofficial Lingo.png|24px]] means that the article's title is [[:Category:Unofficial lingo|unofficial]].
*[[File:PM Icon.png|24px]] shows that the article relates to ''[[Project M]]''. '''Not''' to be used outside ''PM''-only pages and relevant tournaments ([[Forum:The Project M debate|archived discussion]]).
*[[Image:Competitive.png|24px]] means that the article relates to [[competitive play]].
*[[File:P+ Icon.png|24px]] shows that the article relates to ''[[Project+]]''. '''Not''' to be used outside ''P+''-only pages and relevant tournaments
*[[Image:Featured.png|24px]] is how [[SmashWiki:Featured content|featured articles]] are marked.
*[[File:Unofficial Lingo.png|24px]] means that the article's title is [[:Category:Unofficial lingo|unofficial]].
*[[Image:ProtectIconGrey.png|24px]] shows that the page is [[SW:PROTECT|protected]].
*[[File:Competitive.png|24px]] means that the article relates to [[competitive play]].
*[[File:OnlineIcon.svg|24px|class=invert-dark]] means that the article relates to [[online play]].
*[[File:Featured.png|24px]] is how [[SmashWiki:Featured content|featured articles]] are marked.
*[[File:ProtectIconGrey.png|24px]] shows that the page is [[SW:PROTECT|protected]].
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.


Line 20: Line 23:
*<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>
*<code>ssb4-wiiu</code> or <code>ssb4-wii-u</code> or <code>ssb4-u</code>
*<code>ssb4-wiiu</code> or <code>ssb4-wii-u</code> or <code>ssb4-u</code>
*<code>ssbu</code> or <code>ultimate</code>
*<code>pm</code> or <code>projectm</code>
*<code>p+</code> or <code>project+</code>
*<code>unofficial</code> (for unofficial lingo)
*<code>unofficial</code> (for unofficial lingo)
*<code>competitive</code>
*<code>fa</code> or <code>featured</code>
*<code>fa</code> or <code>featured</code>
*<code>protected</code>
*<code>protected</code>
Line 33: Line 39:
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 (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.
The <code>allgames</code> parameter will show icons for all released games (though this might not be done immediately on release, in order to give time to update its usages). Note that <code>allgames</code> and <code>series</code> are not equivalent:
* <code>allgames</code> is for elements that happen to appear in every game, but are not an inherent part of Smash Bros. For example, every game has an appearance by the Beam Sword, the Pokémon universe, and Master Hand, but there could easily be a Smash Bros. game without these things.
* <code>series</code> is for elements that are fundamental to the nature of Smash Bros., and the game cannot exist without them. For example, it is impossible to make a Smash Bros. game without concepts such as knockback, port priority, and pausing.


===Protected icon===
===Protected icon===
The protected icon should be given certain values other than anything generic, such as "y":
The protected icon should be given certain values other than anything generic, such as "y":
*[[Image:ProtectIconRed.png|24px]] <code>vandalism</code>
*[[File:ProtectIconRed.png|24px]] <code>vandalism</code>
*[[Image:ProtectIconYellow.png|24px]] <code>highrisk</code>
*[[File:ProtectIconYellow.png|24px]] <code>highrisk</code>
*[[Image:ProtectIconGreen.png|24px]] <code>editwar</code>
*[[File:ProtectIconGreen.png|24px]] <code>editwar</code>
*[[Image:ProtectIconBlue.png|24px]] <code>preemptive</code>
*[[File:ProtectIconBlue.png|24px]] <code>preemptive</code>
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.
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==
==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>
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 14:25, May 20, 2024

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
  • ssbu or ultimate
  • pm or projectm
  • p+ or project+
  • unofficial (for unofficial lingo)
  • competitive
  • 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 released games (though this might not be done immediately on release, in order to give time to update its usages). Note that allgames and series are not equivalent:

  • allgames is for elements that happen to appear in every game, but are not an inherent part of Smash Bros. For example, every game has an appearance by the Beam Sword, the Pokémon universe, and Master Hand, but there could easily be a Smash Bros. game without these things.
  • series is for elements that are fundamental to the nature of Smash Bros., and the game cannot exist without them. For example, it is impossible to make a Smash Bros. game without concepts such as knockback, port priority, and pausing.

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.

Retrieved from "https://www.ssbwiki.com/index.php?title=Template:ArticleIcons/doc&oldid=1902314"