Template:Vginfobox/doc: Difference between revisions

Template page
m (→‎Attribution and re-use: Added issue and PR template to the attribution list)
No edit summary
Line 1: Line 1:
== Overview ==
This template is used on all game pages. When creating a new page, the infobox should be fleshed out with as much information as possible. Most of the general information can be taken directly from wikipedia with minimal fuss, except for images, Wikipedia's cover images are too small to use here. Certain parameters in this template should be used with other templates to display the information effectively (as explained below). For additional guidance, read the documentation present in the respective templates linked.
This template is used on all game pages. When creating a new page, the infobox should be fleshed out with as much release information as possible. Some tags also need some rules, listed below:
 
*<var>|image =</var> must have the thumbnail size tag based on software type. The standard is: 300px size for games covers and 350px size for screenshots. If an image doesn't resize, just add some garbage to the end of tag such as the image name (for example <nowiki>[[File:DemonSouls.jpg‎|300px|</nowiki>'''DeS''']]). Cover preference order would be: US NTSC, UK PAL, Other PAL, JP, Other.
== Parameters ==
*<var>|developer =</var> must include only the developer of PS3 (for example, the PlayStation Vita version of [[God of War Collection]] was developed by Sanzaru Games, but the PlayStation 3 version was developed by Bluepoint Games, so in this case only Bluepoint Games should be included).
The following are the only valid parameters accepted by this template. Required entries are in bold.
*<var>|publisher =</var> and <var>|date =</var> must use the [[Template:vgregion|vgregion template]] (for example the publisher tag in [[Demon's Souls]] uses <code><nowiki>{{vgregion|JP=Sony Computer Entertainment|NA=Atlus USA|AU/EU|Namco Bandai Games}}</nowiki></code> and date tag in [[Catherine]] uses <code><nowiki>{{vgregion|JP=February 17, 2011|NA=July 26, 2011|EU=February 10, 2012|AU=February 23, 2012}}</nowiki></code>).
Some parameters are tags also need some rules, listed below:
*<var>|gameid =</var> must use the [[Template:gameid|gameid template]] (for example the gameid tag in [[Demon's Souls]] uses <code><nowiki>{{gameid|id=BLES00932, BLUS30443, NPEB01202, NPUB30910|ird=Yes}}</nowiki></code>).
*''|title ='' should be used only in exceptional cases where title of the game differs significantly from the page title such that the links to the compatibility list and github in the "see also..." category break - see [[Find a game]]
*'''''|image =''''' must have the box cover art at the standard size of 300px. If an image doesn't resize correctly, add some garbage to the end of tag such as the image name (for example <nowiki>[[File:DemonSouls.jpg‎|300px|</nowiki>'''DeS''']]). Cover preference order would be: US NTSC, UK PAL, Other PAL, JP, Other.
*'''''|developer =''''' must include only the developer of PS3 version (for example, the PlayStation Vita version of [[God of War Collection]] was developed by Sanzaru Games, but the PlayStation 3 version was developed by Bluepoint Games, so in this case only Bluepoint Games should be included).
*'''''|publisher =''''' and '''''|date =''''' must use the [[Template:vgregion|vgregion template]] (for example the publisher tag in [[Demon's Souls]] uses <code><nowiki>{{vgregion|JP=Sony Computer Entertainment|NA=Atlus USA|AU/EU|Namco Bandai Games}}</nowiki></code> and date tag in [[Catherine]] uses <code><nowiki>{{vgregion|JP=February 17, 2011|NA=July 26, 2011|EU=February 10, 2012|AU=February 23, 2012}}</nowiki></code>). For the date parameter, the regions should be in chronological order and must include only the publishers and release dates relating to the PS3 version.
*'''''|series =''''' should be included for games that are part of a series with more than one title on PlayStation 3. If a game does not have any other titles from the series on PlayStation 3, do not include this parameter. For example, [[Red Dead Redemption]] is part of the "Red Dead" series but no other game from the series is on PlayStation 3. Hence, this parameter shall not be included in its game page.
*'''''|release =''''' should be used to highlight the exclusivity of a game. Ignore PS Now when deciding the release status in this parameter. Only choose '''ONE''' of the following options:
** ''PlayStation 3 exclusive'' - Available ONLY on PlayStation 3
** ''PlayStation exclusive'' - Available on PlayStation 3 and other PlayStation consoles
** ''Console exclusive'' - Available on Playstation 3 and other consoles (such as XBox or Wii) but NOT available on PC
** ''Multi-platform'' - Available on Playstation 3 and various other platforms including PC
*'''''|genre =''''' can be taken directly from Wikipedia but genres combining 2 or more distinct genres need to be split to prevent excessive genres from being created (i.e. "Action-adventure" should be split into "Action" and "Adventure"). Also, only list the "genre", not "genre game" (i.e. "Action" instead of "Action game"). Should be plain text, and not contain wiki/html markup. Use spelling and capitalization from [[:Category:Genres|Genres]].
*'''''|modes =''''' should be used for the different game modes available in a game. The inputs accepted by this parameter are - Single-player, Multiplayer, Co-op, Online (inputs are case sensitive).
*'''''|gameid =''''' must use the [[Template:gameid|gameid template]] (for example, [[Demon's Souls]] uses <code><nowiki>{{gameid|id=BLES00932, BLUS30443, NPEB01202, NPUB30910|ird=Yes}}</nowiki></code>).
*''|wikipedia ='' should be used only when the automatic link does not work - see [[Catherine]]


The template will auto-generate categories for each genre and gameplay mode listed, as well as various maintenance and error catching categories for incorrect formatting.
The template will auto-generate categories for each genre and gameplay mode listed, as well as various maintenance and error catching categories for incorrect formatting.


== Parameters ==
== Example ==
The following are the only valid parameters accepted by this template. Required entries are in bold.
'''[[Demon's Souls]]''' uses the following syntax:
:|title (To be used only in exceptional cases where title of the game differs significantly from the page title such that the links to the compatibility list and github in the "see also..." category break - see [[Find a game]])
<pre>{{vginfobox
:|'''image''' (Box cover art)
|image     = [[File:DeSCover.jpg|300px]]
:|'''developer'''
|developer = FromSoftware
:|'''publisher'''
|publisher = {{vgregion|JP=Sony Computer Entertainment|NA=Atlus USA|AU/EU|Namco Bandai Games}}
:|'''series''' (Only for games that are part of a series with more than one title on PlayStation 3)
|series   = Souls
:|'''date'''
|date     = {{vgregion|JP=February 5, 2009|NA=October 6, 2009|AU=June 23, 2010}}{{vgregion|EU=June 25, 2010}}
:|'''release''' (One of the following - PlayStation 3 exclusive, PlayStation exclusive, Console exclusive, Multi-platform)
|release   = PlayStation 3 exclusive
:|'''genre'''
|genre     = Action role-playing
:|'''modes''' (Single-player, Multiplayer, Co-op, Online)
|modes     = Single-player, Multiplayer
:|'''gameid'''
|gameid   = {{gameid|id=BLES00932, BLUS30443, NPEB01202, NPUB30910|ird=Yes}}
:|wikipedia (Wikipedia page title, only when automatic link does not work - see [[Catherine]])
}}</pre>


== Attribution and re-use ==
== Attribution and re-use ==
Line 31: Line 44:
* [[Template:Pr|pull request template]]
* [[Template:Pr|pull request template]]
* [[Template:Vginfobox|vginfobox template]] along with its [[Template:Vginfobox/doc|documentation template]]
* [[Template:Vginfobox|vginfobox template]] along with its [[Template:Vginfobox/doc|documentation template]]
* [[Template:Vgregion|vgregion template]] along with its [[Template:Vgregion/doc|documentation template]]
* [[Template:vgregion|vgregion template]] along with its [[Template:Vgregion/doc|documentation template]]
* [[Template:Void|void template]]
* [[Template:Void|void template]]
* [[Template:Wrap|wrap template]]
* [[Template:Wrap|wrap template]]
[[Category:Templates]]
[[Category:Templates]]

Revision as of 16:50, 15 February 2018

This template is used on all game pages. When creating a new page, the infobox should be fleshed out with as much information as possible. Most of the general information can be taken directly from wikipedia with minimal fuss, except for images, Wikipedia's cover images are too small to use here. Certain parameters in this template should be used with other templates to display the information effectively (as explained below). For additional guidance, read the documentation present in the respective templates linked.

Parameters

The following are the only valid parameters accepted by this template. Required entries are in bold. Some parameters are tags also need some rules, listed below:

  • |title = should be used only in exceptional cases where title of the game differs significantly from the page title such that the links to the compatibility list and github in the "see also..." category break - see Find a game
  • |image = must have the box cover art at the standard size of 300px. If an image doesn't resize correctly, add some garbage to the end of tag such as the image name (for example [[File:DemonSouls.jpg‎|300px|DeS]]). Cover preference order would be: US NTSC, UK PAL, Other PAL, JP, Other.
  • |developer = must include only the developer of PS3 version (for example, the PlayStation Vita version of God of War Collection was developed by Sanzaru Games, but the PlayStation 3 version was developed by Bluepoint Games, so in this case only Bluepoint Games should be included).
  • |publisher = and |date = must use the vgregion template (for example the publisher tag in Demon's Souls uses {{vgregion|JP=Sony Computer Entertainment|NA=Atlus USA|AU/EU|Namco Bandai Games}} and date tag in Catherine uses {{vgregion|JP=February 17, 2011|NA=July 26, 2011|EU=February 10, 2012|AU=February 23, 2012}}). For the date parameter, the regions should be in chronological order and must include only the publishers and release dates relating to the PS3 version.
  • |series = should be included for games that are part of a series with more than one title on PlayStation 3. If a game does not have any other titles from the series on PlayStation 3, do not include this parameter. For example, Red Dead Redemption is part of the "Red Dead" series but no other game from the series is on PlayStation 3. Hence, this parameter shall not be included in its game page.
  • |release = should be used to highlight the exclusivity of a game. Ignore PS Now when deciding the release status in this parameter. Only choose ONE of the following options:
    • PlayStation 3 exclusive - Available ONLY on PlayStation 3
    • PlayStation exclusive - Available on PlayStation 3 and other PlayStation consoles
    • Console exclusive - Available on Playstation 3 and other consoles (such as XBox or Wii) but NOT available on PC
    • Multi-platform - Available on Playstation 3 and various other platforms including PC
  • |genre = can be taken directly from Wikipedia but genres combining 2 or more distinct genres need to be split to prevent excessive genres from being created (i.e. "Action-adventure" should be split into "Action" and "Adventure"). Also, only list the "genre", not "genre game" (i.e. "Action" instead of "Action game"). Should be plain text, and not contain wiki/html markup. Use spelling and capitalization from Genres.
  • |modes = should be used for the different game modes available in a game. The inputs accepted by this parameter are - Single-player, Multiplayer, Co-op, Online (inputs are case sensitive).
  • |gameid = must use the gameid template (for example, Demon's Souls uses {{gameid|id=BLES00932, BLUS30443, NPEB01202, NPUB30910|ird=Yes}}).
  • |wikipedia = should be used only when the automatic link does not work - see Catherine

The template will auto-generate categories for each genre and gameplay mode listed, as well as various maintenance and error catching categories for incorrect formatting.

Example

Demon's Souls uses the following syntax:

{{vginfobox
|image     = [[File:DeSCover.jpg|300px]]
|developer = FromSoftware
|publisher = {{vgregion|JP=Sony Computer Entertainment|NA=Atlus USA|AU/EU|Namco Bandai Games}}
|series    = Souls
|date      = {{vgregion|JP=February 5, 2009|NA=October 6, 2009|AU=June 23, 2010}}{{vgregion|EU=June 25, 2010}}
|release   = PlayStation 3 exclusive
|genre     = Action role-playing
|modes     = Single-player, Multiplayer
|gameid    = {{gameid|id=BLES00932, BLUS30443, NPEB01202, NPUB30910|ird=Yes}}
}}

Attribution and re-use

The following templates have been adapted from Dolphin Emulator Wiki released under the Creative Commons Attribution-ShareAlike 3.0 License: