Template:Gameid/doc: Difference between revisions

Template page
(Moving info to a separate documentation page so as to not clutter the main template code. Will be expanded soon to cover ird parameter as well.)
 
(Improved the documentation for the template)
Line 1: Line 1:
== Overview ==
== Overview ==
This template is designed to be used in conjunction with the ''|gameid'' parameter of the [[Template:vginfobox|vginfobox template]] using <code><nowiki>{{gameid|GameID1, GameID2, GameID3}}</nowiki></code>. This template will allow every game ID mentioned in the infobox to be linked to its respective forum thread.  
This template is designed to be used in conjunction with the ''|gameid'' parameter of the [[Template:vginfobox|vginfobox template]]. This template will allow every game ID mentioned in the infobox to be linked to its respective forum thread and ird file (if available).  


As shown below, in case the game IDs for a game need to be distinguished from each other, the template can be used twice with breaks added in between.
== Syntax ==
'''<nowiki>{{ gameid</nowiki>''' | ''id'' = GameID1, GameID2, GameID3 | ''ird'' = Option '''}}'''
 
* ''|id ='' is used to mention the game IDs separated simply by a comma and a space. Only game IDs that are present in the compatibility list and forums are to be mentioned here. Game IDs that were never tested in the forums should '''NOT''' be mentioned in this parameter as the template will produce broken links to non-existent forum threads.
* ''|ird ='' is used to capture details relating to the availability of ird files for a particular game at [http://jonnysp.bplaced.net/ jonnysp.bplaced.net]. The following options are accepted by this parameter:
** '''Yes''' - Blu-ray game ID is present and the ird file for the same is available.
** '''No''' - Blu-ray game ID is present but the ird file for the same is not available.
** '''NA''' - No Blu-ray game ID exists for the game (PSN exclusive).
 
In case the game IDs for a game need to be distinguished from each other (e.g. when one ID pertains to a demo), the template can be used twice with breaks added in between. However, though the template is repeated with a different ID, the option for the ird parameter must remain constant between templates (see example below). This is necessary as the ird parameter pertains to the game as a whole as opposed to a single ID.


== Examples ==
== Examples ==
'''[[Demon's Souls]]''' - Standard  
'''[[Demon's Souls]]''' - Standard  
<pre>{{gameid|BLES00932, BLUS30443, NPEB01202, NPUB30910}}</pre>
<pre>{{gameid|id=BLES00932, BLUS30443, NPEB01202, NPUB30910|ird=Yes}}</pre>




'''[[Catherine]]''' - Call separated to distinguish the regular IDs from the demo version
'''[[Catherine]]''' - Call separated to distinguish the regular IDs from the demo version. Note how the ird parameter is <code><nowiki>Yes</nowiki></code> even in the second template which contains no Blu-ray IDs.
<pre>{{gameid|BLUS30428, BLES01459, NPUB30698, NPEB00875}}<br/>'''''Demo'''''<br/>{{gameid|NPUB90645}}</pre>
<pre>{{gameid|id=BLUS30428, BLES01459, NPUB30698, NPEB00875|ird=Yes}}<br/>'''''Demo'''''<br/>{{gameid|id=NPUB90645|ird=Yes}}</pre>
[[Category:Templates]]
[[Category:Templates]]

Revision as of 21:04, 8 February 2018

Overview

This template is designed to be used in conjunction with the |gameid parameter of the vginfobox template. This template will allow every game ID mentioned in the infobox to be linked to its respective forum thread and ird file (if available).

Syntax

{{ gameid | id = GameID1, GameID2, GameID3 | ird = Option }}

  • |id = is used to mention the game IDs separated simply by a comma and a space. Only game IDs that are present in the compatibility list and forums are to be mentioned here. Game IDs that were never tested in the forums should NOT be mentioned in this parameter as the template will produce broken links to non-existent forum threads.
  • |ird = is used to capture details relating to the availability of ird files for a particular game at jonnysp.bplaced.net. The following options are accepted by this parameter:
    • Yes - Blu-ray game ID is present and the ird file for the same is available.
    • No - Blu-ray game ID is present but the ird file for the same is not available.
    • NA - No Blu-ray game ID exists for the game (PSN exclusive).

In case the game IDs for a game need to be distinguished from each other (e.g. when one ID pertains to a demo), the template can be used twice with breaks added in between. However, though the template is repeated with a different ID, the option for the ird parameter must remain constant between templates (see example below). This is necessary as the ird parameter pertains to the game as a whole as opposed to a single ID.

Examples

Demon's Souls - Standard

{{gameid|id=BLES00932, BLUS30443, NPEB01202, NPUB30910|ird=Yes}}


Catherine - Call separated to distinguish the regular IDs from the demo version. Note how the ird parameter is Yes even in the second template which contains no Blu-ray IDs.

{{gameid|id=BLUS30428, BLES01459, NPUB30698, NPEB00875|ird=Yes}}<br/>'''''Demo'''''<br/>{{gameid|id=NPUB90645|ird=Yes}}