Mob: Created page with "{{Documentation subpage}} {{Lua|Module:Video game series reviews}} {{tld|Video game series reviews}} 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 o..."

2024-06-08T09:31:22Z

Created page with "{{Documentation subpage}} {{Lua|Module:Video game series reviews}}  {{tld|Video game series reviews}} 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 o..."

New page

{{Documentation subpage}}
{{Lua|Module:Video game series reviews}}


{{tld|Video game series reviews}} 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. See [[WP:VG/WD]] for a quick guide on editing Wikidata.

== Guidelines ==
;{{tld|Video game series reviews}} 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 [[Wikipedia:Citing sources|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.
;[[OpenCritic]] should use the Critics Recommend metric, unless Metacritic is unavailable.
: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.
{{clear}}

== Usage ==
All of the following fields are optional:

; ''title''*
: Can be used to provide a custom title for the table; otherwise, it will choose 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'' will be pulled from Wikidata if this is set to yes. Otherwise, Wikidata will not be used.
; ''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.
; ''oc''*
: Determines whether or not to display the OpenCritic 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. OpenCritic 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.
; ''oc_title''*
: Can be used to provide a custom title for the OpenCritic 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.
; ''df''*
: Used to specify the date format for Wikidata generated references. Default is mdy.

===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 (Using the "has part" property) 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 for games to list.

:; ''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.
:; ''ocn''*
:: Specifies the OpenCritic review score for this game. A reference should be included. If omitted and ''qidn'' has been specified, Wikidata will be used if available.

==Examples==
{| class="wikitable"
!style="width: 33%;" |Example
!style="width: 34%;" |Code
!style="width: 33%;" |Display
|-
| With no parameters, relying entirely on Wikidata. (Note, we use seriesQid here because we are not at the series' page.)
| <syntaxhighlight lang="wikitext">{{Video game series reviews
| seriesQid = Q20874570
}}</syntaxhighlight>
|{{Video game series reviews
| seriesQid = Q20874570
}}
|-
| With ''qidn'' specified, allowing all other data to be pulled from Wikidata. The QIDs in use in this example are from the Souls series.
| <syntaxhighlight lang="wikitext">{{Video game series reviews
| qid1 = Q1153708
| qid2 = Q1166232
| qid3 = Q3702740
| qid4 = Q20112508
}}</syntaxhighlight>
|{{Video game series reviews
| qid1 = Q1153708
| qid2 = Q1166232
| qid3 = Q3702740
| qid4 = Q20112508
}}
|-
|Using QIDs as above, with ''gr=yes''.
|<syntaxhighlight lang="wikitext">{{Video game series reviews
| gr = yes
| qid1 = Q1153708
| qid2 = Q1166232
| qid3 = Q3702740
| qid4 = Q20112508
}}</syntaxhighlight>
|{{Video game series reviews
| gr = yes
| qid1 = Q1153708
| qid2 = Q1166232
| qid3 = Q3702740
| qid4 = Q20112508
}}
|-
|Overriding Wikidata by specifying scores.
|<syntaxhighlight lang="wikitext">{{Video game series reviews
| qid1 = Q1153708
| mc1 = MC1 override
| gr1 = GR1 override
| qid2 = Q1166232
| qid3 = Q3702740
| mc3 = MC3 override
| qid4 = Q20112508
}}</syntaxhighlight>
|{{Video game series reviews
| qid1 = Q1153708
| mc1 = MC1 override
| gr1 = GR1 override
| qid2 = Q1166232
| qid3 = Q3702740
| mc3 = MC3 override
| qid4 = Q20112508
}}
|-
|Manual specification of fields, with no Wikidata auto-population.
|<syntaxhighlight lang="wikitext">{{Video game series reviews
| updated = July 5, 2015
| fam = yes
| sales = yes
| game1 = [[Valkyrie Profile]]
| sales1 = 709,000
| fam1 = 35/40
| mc1 = 81/100
| year1 = 2000
| game2 = Valkyrie Profile: Lenneth
| sales2 = 248,000
| fam2 = -
| mc2 = 80/100
| year2 = 2001
| game3 = [[Valkyrie Profile 2: Silmeria]]
| sales3 = 400,000 (JP)
| fam3 = 34/40
| mc3 = 84/100
| game4 = [[Valkyrie Profile: Covenant of the Plume]]
| sales4 = 230,000
| fam4 = 32/40
| mc4 = 74/100
}}</syntaxhighlight>
|{{Video game series reviews
| updated = July 5, 2015
| fam = yes
| sales = yes
| game1 = [[Valkyrie Profile]]
| sales1 = 709,000
| fam1 = 35/40
| mc1 = 81/100
| year1 = 2000
| game2 = Valkyrie Profile: Lenneth
| sales2 = 248,000
| fam2 = -
| mc2 = 80/100
| year2 = 2001
| game3 = [[Valkyrie Profile 2: Silmeria]]
| sales3 = 400,000 (JP)
| fam3 = 34/40
| mc3 = 84/100
| game4 = [[Valkyrie Profile: Covenant of the Plume]]
| sales4 = 230,000
| fam4 = 32/40
| mc4 = 74/100
}}
|-
|}

{{Reflist|30em}}

== See also ==
*[[Wikipedia:WikiProject Video games/Sources]]
*{{tiw|Video game reviews}}

<includeonly>{{Sandbox other||

[[Category:Video game templates|Series reviews]]
[[Category:Rating templates]]
[[Category:Templates using data from Wikidata]]
}}</includeonly>
<templatedata>
{
"params": {},
"format": "block"
}
</templatedata>

Template:Video game series reviews/doc - Revision history