Template:Video game series reviews/sandbox/doc

is a template which presents review aggregator review scores for multiple video game articles in a series. It supports a series' reception section.

Things to remember:
 * This template is not required.
 * This template supplements the reception section; it does not replace it.
 * Famitsu score is only for Japanese series.
 * This template makes use of Wikidata to supplement missing or omitted fields.

Guidelines

 * is not required
 * This template acts as a quick snapshot of aggregator scores for games in a series. Reception sections should consider using additional reviews for each game.


 * All reviews must be referenced
 * Proper citation from each review must be populated.


 * GameRankings should be omitted unless it adds value on top of Metacritic.
 * If included, GameRankings scores should be rounded to the nearest whole number.
 * See WP:VGAGG for more detail.


 * Famitsu should be omitted unless this is a Japanese series.
 * Famitsu is used for Japanese series that may have not seen an English release, and therefore lack Metacritic or GameRanking scores.

Usage
All of the following fields are optional:


 * title*
 * Can be used to provide a custom title for the table; otherwise, it will chose a default based on the fields in use.


 * updated*
 * Used to denote the last time scores and citations were updated.


 * sales*
 * Determines whether or not to display the sales column. Specify "no" to stop the column from appearing, or "yes" to force it to appear, even if there is no data. The default is to display the column if any data has been provided. Sales data is not populated from Wikidata.


 * fam*
 * Determines whether or not to display the Famitsu column. Specify "no" to stop the column from appearing, or "yes" to force it to appear, even if there is no data. The default is to display the column if any data has been provided. Famitsu reviews are pulled from Wikidata if unspecified.


 * gr*
 * Determines whether or not to display the GameRankings column. Specify "no" to stop the column from appearing, or "yes" to force it to appear, even if there is no data. The default is to display the column if any data has been provided. GameRankings will be pulled from Wikidata if this is set to yes. Otherwise, Wikidata will not be used. See WP:VGAGG for further information.


 * mc*
 * Determines whether or not to display the MetaCritic column. Specify "no" to stop the column from appearing, or "yes" to force it to appear, even if there is no data. The default is to display the column if any data has been provided. MetaCritic reviews are pulled from Wikidata if unspecified.


 * sales_title*
 * Can be used to provide a custom title for the sales column; otherwise, the default will be used.


 * fam_title*
 * Can be used to provide a custom title for the Famitsu column; otherwise, the default will be used.


 * gr_title*
 * Can be used to provide a custom title for the GameRankings column; otherwise, the default will be used.


 * mc_title*
 * Can be used to provide a custom title for the MetaCritic column; otherwise, the default will be used.


 * seriesQid*
 * Used to specify the Wikidata QID for this series. This should be omitted except in rare cases such as testing or displaying a series on a page other than its own.

Game parameters
The following are repeatable fields for specifying the games to display in the table. If all of the fields are omitted, the template will try to pull the list of games for this series from Wikidata and auto-populate the table. If any of these fields have been specified, even if some games are omitted, the template will not query Wikidata.


 * qidn*
 * Specifies the Wikidata QID for this game. This is required if scores will be pulled from Wikidata. If omitted, only local scores will be used.
 * gamen*
 * Specifies the name of the game. This should be a Wikilink to the game's article. Italics will be added automatically. If qidn has been specified, this can be omitted.

Review parameters
The following are repeatable fields for specifying the review scores of a game to display in the table. If qidn has been specified, these will be populated from Wikidata where possible. If specified, Wikidata will not be used.


 * yearn*
 * Specifies the year that the game was released. If omitted and qidn has been specified, Wikidata will be used if available.
 * salesn*
 * Specifies the sales data for this game. If omitted, it will be blank, Wikidata will not be used. (Future enhancement)
 * famn*
 * Specifies the Famitsu review score for this game. A reference should be included. If omitted and qidn has been specified, Wikidata will be used if available.
 * grn*
 * Specifies the GameRankings review score for this game. A reference should be included. If omitted and both gr=yes and qidn have been specified, Wikidata will be used if available.
 * mcn*
 * Specifies the Metacritic review score for this game. A reference should be included. If omitted and qidn has been specified, Wikidata will be used if available.