Template:Gameid/doc: Difference between revisions

Template page
(→‎Examples: Added examples for the remaining 2 ird cases as well)
(→‎Syntax: Edited source information of IRDs)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Overview ==
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).  
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).  


== Syntax ==
== Syntax ==
'''<nowiki>{{ gameid</nowiki>''' | ''id'' = GameID1, GameID2, GameID3 | ''ird'' = Option '''}}'''
'''<nowiki>{{ gameid</nowiki>''' | ''id'' = GameID1, GameID2, GameID3 | ''oid'' = 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.
* ''|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. Use <code>oid</code> parameter for such game IDs.
* ''|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:
* ''|oid ='' is used for game IDs that are '''NOT''' present in the compatibility list and forums. Similar to <code>id</code> parameter, game IDs are separated by a comma and a space.
** '''Yes''' - Blu-ray game ID is present and the ird file for the same is available.
* ''|ird ='' is used to capture details relating to the availability of IRD files for a particular game at [https://flexby420.github.io/playstation_3_ird_database/ FlexBy IRD Database]. The following options are accepted by this parameter:
** '''No''' - Blu-ray game ID is present but the ird file for the same is not available.  
** '''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).
** '''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.
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. Similarly, where a few game IDs have IRD files but other game IDs for the same game do not, the template can be used twice with the corresponding <code>ird</code> parameter as ''Yes'' and ''No'' respectively. Do note that when using the template twice without breaks in between, you will have to manually add a comma and space between the templates to maintain formatting.


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




'''[[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.
'''[[Catherine]]''' - Call separated to distinguish the regular IDs from the demo version
<pre>{{gameid|id=BLUS30428, BLES01459, NPUB30698, NPEB00875|ird=Yes}}<br/>'''''Demo'''''<br/>{{gameid|id=NPUB90645|ird=Yes}}</pre>
<pre>{{gameid|id=BLUS30428, BLES01459, NPUB30698, NPEB00875|oid=BLJM60215|ird=Yes}}<br>'''''Demo'''''<br>{{gameid|id=NPUB90645|ird=NA}}</pre>




'''[[Find a game that does this]]''' - Games that have Blu-ray game IDs but the ird file for the same is not available
'''[[.hack//Versus]]''' - Games that have Blu-ray game IDs but the ird file for the same is not available
<pre>{{gameid|id=GameID1, GameID2|ird=No}}</pre>
<pre>{{gameid|id=BLJS93008|ird=No}}</pre>




'''[[Find a game that does this]]''' - Games without any Blu-ray game IDs
'''[[Disgaea 4: A Promise Unforgotten]]''' - Games that have Blu-ray game IDs where few game IDs have ird files but other game IDs do not. Take note of how <code>, </code> has been manually added to separate the 2 templates.
<pre>{{gameid|id=GameID1, GameID2|ird=NA}}</pre>
<pre>{{gameid|id=BLES01225, BLUS30727|ird=Yes}}, {{gameid|id=BCAS20185|ird=No}}</pre>
 
 
'''[[Scott Pilgrim vs. The World: The Game]]''' - Games without any Blu-ray game IDs
<pre>{{gameid|id=NPEB00258, NPUB30162|ird=NA}}</pre>
[[Category:Templates]]
[[Category:Templates]]

Latest revision as of 18:52, 24 February 2024

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 | oid = 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. Use oid parameter for such game IDs.
  • |oid = is used for game IDs that are NOT present in the compatibility list and forums. Similar to id parameter, game IDs are separated by a comma and a space.
  • |ird = is used to capture details relating to the availability of IRD files for a particular game at FlexBy IRD Database. 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. Similarly, where a few game IDs have IRD files but other game IDs for the same game do not, the template can be used twice with the corresponding ird parameter as Yes and No respectively. Do note that when using the template twice without breaks in between, you will have to manually add a comma and space between the templates to maintain formatting.

Examples

Demon's Souls - Standard

{{gameid|id=BLES00932, BLUS30443, NPEB01202, NPUB30910|oid=BCAS20071|ird=yes}}


Catherine - Call separated to distinguish the regular IDs from the demo version

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


.hack//Versus - Games that have Blu-ray game IDs but the ird file for the same is not available

{{gameid|id=BLJS93008|ird=No}}


Disgaea 4: A Promise Unforgotten - Games that have Blu-ray game IDs where few game IDs have ird files but other game IDs do not. Take note of how , has been manually added to separate the 2 templates.

{{gameid|id=BLES01225, BLUS30727|ird=Yes}}, {{gameid|id=BCAS20185|ird=No}}


Scott Pilgrim vs. The World: The Game - Games without any Blu-ray game IDs

{{gameid|id=NPEB00258, NPUB30162|ird=NA}}