Template:Infobox VG/doc: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
m (Text replacement - "(={2,})([^\s=])(.+)([^\s=])(={2,})" to "$1 $2$3$4 $5")
(Port recent template changes to the documentation. Only noticed the example is, "hard-coded" now (thought it was a caching issue before))
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Overview ==
== About ==
This template is used in game pages. If you are creating a new page, you must include only basic info and emulation related details. Some tags also need some rules, listed below:
Infobox VG is used on all game pages to display a title's compatibility rating along with various other information, including the title's GameIDs, release dates, and box art. Categories are also generated depending on the parameters to indicate information about the title, and flag parts of the infobox that may need improvement. When creating a new page, the infobox should be fleshed out with as much release information as possible.
*<tt>|image =</tt> must have the thumbnail size tag based on software type. We use 300px size for GameCube and Wii games, 350px size for Wii Channels  screenshots and 160px size for WiiWare titles. If you image doesn't resize, only add some garbage in the end of tag such as the image name (for example <nowiki>[[File:FlingSmash.jpg‎|300px|</nowiki>'''FlingSmash''']]). Cover preference order would be: US NTSC, UK PAL, Other PAL, JP, Other.
*<tt>|developer =</tt> must include only the developer of Dolphin emulated platforms (for example, the Playstation 2 and Xbox version of Mortal Kombat Armageddon was developed by Midway but the Wii version was developed by Just Games Interactive, so in this case we include only Just Games Interactive).
*<tt>|publisher =</tt> and <tt>|released =</tt> must use the VGrelease template (for example, on Fragile Dreams: Farewell Ruins Of The Moon, the publisher tag use <tt><nowiki>{{vgrelease|JP=Namco Bandai Games|NA=Xseed Games|EU=Rising Star Games}}</nowiki></tt> and released tag use <tt><nowiki>{{vgrelease|JP=January 22, 2009 |NA=March 16, 2010 |EU=March 19, 2010}}</nowiki></tt>).


The template will auto-generate categories for each genre, and game play mode listed.
== Example ==
The following parameters are considered required on all pages:
<pre>
{{Infobox VG
|image    =
|developer =
|publisher =
|released  =
|genre    =
|modes    =
|input    =
|forumlink =
}}</pre>
 
Produces
{|
|
{| class="infobox vevent" style="width:300px; font-size:90%; text-align:left;" cellspacing="0" cellpadding="3"
|-
! colspan=2 style="font-size:110%; text-align:center;" class="summary" | ''Infobox VG''
{{Alternating rows table section
|es=background:#f0f0f0;
|{{!}} '''[[:Category:Platforms|Platform(s)]]''' {{!!}}
|{{!}} '''[[:Category:Rating|Compatibility]]''' {{!!}}{{#if:||[[Image:Stars0.png|link=Category:0 stars (Rating)]][[File:Note.svg.png|16px|link=]]<br /><span style="display:inline-block;width:118px;text-align:center;font-size:8pt;font-weight:bold;color:#666;">Unknown</span>}}
|{{!}} '''[[GameIDs]]''' {{!!}}
|{{!}} '''See also...''' {{!!}}
{{#if:||[https://www.google.com/search?q=site:forums.dolphin-emu.org+Infobox+VG Search Dolphin Forums]<br />}}
{{#if:||[https://bugs.dolphin-emu.org/projects/emulator/search?q=Infobox+VG&open_issues=1 Open Issues]<br />}}
{{#if:||[https://www.google.com/search?q=Infobox+VG Search Google]<br />}}
[[wikipedia:Infobox VG|Search Wikipedia]]}}|}
|}


== Parameters ==
== Parameters ==
The following are the only valid parameters accepted by [[Template:Infobox VG]]. The most common/important entries are in bold.
The following are the only valid parameters accepted by this template.
:|title (Only if title must be shortened from page name (i.e. "The Legend of Zelda: Twilight Princess" for "The Legend of Zelda: Twilight Princess (GC)"))
*''|image='' Box cover art. Supply only with <code><nowiki>[[File:{{SUBPAGENAME}}.jpg|300px]]</nowiki></code>. The image size tag is optional, used to resize when the image is not <code>300px</code> (or <code>160px</code> for WiiWare titles, <code>350px</code> for Wii Channels).
:|'''channeltype''' (Only for Wii Channel pages)
*''|channeltype= Used only in [[:Category:Wii Channels|Wii Channel]] pages. Valid value to use: <code>Downloadable</code>, <code>Downloadable (third party)</code>, <code>Pre-installed</code>, or <code>Game Channel</code>.
:|'''developer'''
*''|developer='' May be supplied with <code><nowiki>{{vgrelease|}}</nowiki></code> template to list developers by region. Further details on how to use vgrelease are available at [[Template:vgrelease]].
:|'''publisher'''
*''|publisher='' May be supplied with <code><nowiki>{{vgrelease|}}</nowiki></code> template to list publishers by region. Further details on how to use vgrelease are available at [[Template:vgrelease]].
:|'''series'''
*''|series='' Used only for games that are part of a series with more than one title playable in Dolphin. Input there will be italicized automatically.
:|'''platforms''' (Only for Virtual Console titles to indicate original release system)
*''|released='' Supply only with <code><nowiki>{{vgrelease|}}</nowiki></code> template(s). Further details on how to use vgrelease are available at [[Template:vgrelease]].
:|'''released'''
*''|genre=''
:|'''genre'''
*''|modes='' Valid modes of play: <code>Single-player</code>, <code>Multiplayer (#)</code>, <code>Co-op (#)</code>, <code>Online (#)</code>. Separate modes with commas. Parentheses are required. "Online" here means online multiplayer, not online functionality.
:|'''modes''' (Single-player, Multiplayer (#), Co-op, Online)
*''|input='' Valid controller inputs: <code>Active Heart Rate Monitor</code>, <code>Arcade Controller</code>, <code>Classic Controller</code>, <code>Cyberbike</code>, <code>Dance Pad</code>, <code>DK Bongos</code>, <code>TaTaCon</code>, <code>Drawsome Tablet</code>, <code>Drum Controller</code>, <code>Game Boy Advance</code>, <code>GameCube Controller</code>, <code>Guitar Controller</code>, <code>Keyboard Controller</code>, <code>Microphone</code>, <code>Nintendo DS</code>, <code>Nunchuk</code>, <code>Ride Controller</code>, <code>Shinkansen Controller</code>, <code>Skylander Portal</code>, <code>Turntable Controller</code>, <code>uDraw GameTablet</code>, <code>USB Keyboard</code>, <code>Wii Balance Board</code>, <code>Wii MotionPlus</code>, <code>Wii MotionPlus + Nunchuk</code>, <code>Wii Remote</code>, <code>Wii Remote + Nunchuk</code>, <code>Wii Speak</code>, <code>Your Shape Camera</code>. Separate controller inputs with commas.
:|'''input'''
*''|forumlink='' Supply only with Dolphin forum page URL. As the forums have restrictions on creating per-game threads, this can only be created and added to the infobox by users with privileges on the forums.
:|'''image''' (Box cover art)
*''|wikipedia='' Wikipedia page title, only when automatic link does not work; see [[F1 2002]].
:|'''wikipedia''' (Wikipedia page title)
:|'''forumlink''' (Dolphin forum page URL)
 
The following are legacy parameters that are no longer accepted and can be safely removed from pages.
:|fps
:|compatibility
 
== Reference pages ==
You can refer to the pages below, all are using the appropriate rules and fields:
*[[Fragile Dreams: Farewell Ruins Of The Moon]]
*[[Disc Channel]]
*[[Adventure Island: The Beginning]]

Revision as of 06:13, 17 April 2020

About

Infobox VG is used on all game pages to display a title's compatibility rating along with various other information, including the title's GameIDs, release dates, and box art. Categories are also generated depending on the parameters to indicate information about the title, and flag parts of the infobox that may need improvement. When creating a new page, the infobox should be fleshed out with as much release information as possible.

Example

The following parameters are considered required on all pages:

{{Infobox VG
|image     =
|developer =
|publisher =
|released  =
|genre     =
|modes     =
|input     =
|forumlink =
}}

Produces

Infobox VG
Platform(s)
Compatibility Stars0.pngNote.svg.png
Unknown
GameIDs
See also...

Search Dolphin Forums
Open Issues
Search Google
Search Wikipedia

Parameters

The following are the only valid parameters accepted by this template.

  • |image= Box cover art. Supply only with [[File:{{SUBPAGENAME}}.jpg|300px]]. The image size tag is optional, used to resize when the image is not 300px (or 160px for WiiWare titles, 350px for Wii Channels).
  • |channeltype= Used only in Wii Channel pages. Valid value to use: Downloadable, Downloadable (third party), Pre-installed, or Game Channel.
  • |developer= May be supplied with {{vgrelease|}} template to list developers by region. Further details on how to use vgrelease are available at Template:vgrelease.
  • |publisher= May be supplied with {{vgrelease|}} template to list publishers by region. Further details on how to use vgrelease are available at Template:vgrelease.
  • |series= Used only for games that are part of a series with more than one title playable in Dolphin. Input there will be italicized automatically.
  • |released= Supply only with {{vgrelease|}} template(s). Further details on how to use vgrelease are available at Template:vgrelease.
  • |genre=
  • |modes= Valid modes of play: Single-player, Multiplayer (#), Co-op (#), Online (#). Separate modes with commas. Parentheses are required. "Online" here means online multiplayer, not online functionality.
  • |input= Valid controller inputs: Active Heart Rate Monitor, Arcade Controller, Classic Controller, Cyberbike, Dance Pad, DK Bongos, TaTaCon, Drawsome Tablet, Drum Controller, Game Boy Advance, GameCube Controller, Guitar Controller, Keyboard Controller, Microphone, Nintendo DS, Nunchuk, Ride Controller, Shinkansen Controller, Skylander Portal, Turntable Controller, uDraw GameTablet, USB Keyboard, Wii Balance Board, Wii MotionPlus, Wii MotionPlus + Nunchuk, Wii Remote, Wii Remote + Nunchuk, Wii Speak, Your Shape Camera. Separate controller inputs with commas.
  • |forumlink= Supply only with Dolphin forum page URL. As the forums have restrictions on creating per-game threads, this can only be created and added to the infobox by users with privileges on the forums.
  • |wikipedia= Wikipedia page title, only when automatic link does not work; see F1 2002.