View source for Template:Ratings/doc

{{Documentation subpage}}
{{high-use| 82658 }}
{{lua|Module:Ratings}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[</nowiki>[[Wikipedia:Wikidata]]<nowiki>]]) -->

{{Ratings
| rev1 = [[AllMusic]] 
| rev1score = {{Rating|4|5}}<sup>[1]</sup>
| rev2 = ''[[IGN]]''
| rev2score = 9/10<sup>[3]</sup>
}}

'''''Only add a rating if you [[Wikipedia:Citing sources|cite it with a reference]]. For further information on sources, see [[Wikipedia:WikiProject Albums]]. For the guide on transitioning from Infoboxes->AlbumRatings, see [[Wikipedia:WikiProject Albums/Moving infobox reviews into article space]]'''''

==Instructions==
The template is not to be a substitute for a section in paragraph form, since a review can not be accurately boiled down to a simple rating out of five stars or other numeric score.  If an article is lacking a reception section in prose, but the information is presented in table format, the {{para|noprose|yes}} parameter can be used to tag the article as needing a reception section in prose.

This template is generally the first element after the heading for the section on Reception, Critical reception, Reviews, or something similar. If one of those sections is not present, the template should be placed immediately after the infobox, and can then be moved once a Reception section is present.

The reviews should be listed alphabetically in the '''Reviews''' field.  The information in the reviewer field should be the name of the source (most commonly an online music service like [[AllMusic]], or a music magazine like ''[[Rolling Stone]]''—note that magazines are italicized). Don't forget to [[wikilink]] to the relevant article.

The information in the score field should be the rating given in the review (e.g. 4/5). The rating should use the same format as in the review, to accurately portray the score of the review. For star ratings you should use the [[Template:Rating|star rating template]]; for example, entering <code><nowiki>{{Rating|4.5|5}}</nowiki></code>, will render: {{Rating|4.5|5}}. 

For reviews at [[AllMusic]] it is convenient to use the {{Tl|Allmusic}} template.

For reviews at [[Metacritic]] it is convenient to use "MC=" in the template. 

For reviews from [[Robert Christgau]]'s ''Consumer Guide''<!-- Xgau also writes for Blender, Rolling Stone, etc, in which he uses their rating systems. --> you may use the [[Template:Rating-Christgau|Christgau rating template]]. For example, entering <code><nowiki>{{Rating-Christgau|dud}}</nowiki></code> will render: {{Rating-Christgau|dud}}.

Please note that the [[minus sign]] character ([[−]]) is not the same thing as a [[hyphen]] ([[-]]).

After the rating should be the citation of the source of the review. Per [[Wikipedia:Citing sources]] do not add reviews without a citation. This means a properly formatted footnote, in most cases providing the author, date, and source, along with an external link if available. Do not use an embedded link with no information (e.g. [https://en.wikipedia.org/wiki/ link]) as this promotes [[link rot]] and is inconsistent with [[Wikipedia:Cite_sources#Embedded_links|Wikipedia's policy on embedded links]]. If you must use an embedded link, be sure to manually provide a full citation in the article's References section per [[Wikipedia:Cite_sources#Embedded_links|Wikipedia:Citing sources]].

==Usage==
<pre>
{{Ratings
| title =
| subtitle =
<!-- Aggregate scores -->
| ADM = 
| MC = 
| aggregate1 = 
| aggregate1score = 
| aggregate2 = 
| aggregate2score = 
| aggregate3 = 
| aggregate3score = 
<!-- ... -->
<!-- Reviewers -->
| rev1 =
| rev1score =
| rev2 =
| rev2score =
| rev3 =
| rev3score =
<!-- ... -->
<!-- Article needs reviews expanded into prose -->
| noprose = <!--yes-->
}}
</pre>

== Parameters ==
Required fields:

:; ''rev#''
:: The name of the reviewer. [[Wikipedia:WikiProject Albums/Article body#Critical reception|It is recommended to include no more than 10 reviews]], but you can add more in exceptional circumstances. For instance, a particularly popular album which has been re-released and has several prominent reviews over decades' time.
:; ''rev#score''
:: The rating given by the reviewer.

All of the following fields are optional:

:; ''title''
:: Can be used to provide a custom title for the table, otherwise, it will default to "Professional ratings".
:; ''subtitle''
:: Used to add additional text before the collapsible section.  This is necessary to add if want a longer title, as long titles via the "title" parameter will not center correctly. 
:; ''width''
:: Sets the width of the table; default is 24.2em, to match the width of the album infobox in most browsers and skins.
:; ''ADM''
:: [[AnyDecentMusic?]] score.
:; ''MC''
:: [[Metacritic]] score.
:; ''aggregate#''
:: Name of a [[review aggregator]].
:; ''aggregate#score''
:: The rating given by the review aggregator.
:; ''noprose''
:: Should only be used for articles that do not have a Reception section summarizing the reviews. If set to ''yes'', will categorize articles into [[:Category:Articles with album ratings that need to be turned into prose]].

==Example==
For example, entering

<pre style="overflow:auto">
{{Album ratings
| MC = 69/100<ref name="Meta">{{cite web|url=http://www.metacritic.com/music/black-gives-way-to-blue/alice-in-chains|title=Black Gives Way To Blue|publisher=Metacritic|accessdate=2012-09-02}}</ref>
| rev1 = [[AllMusic]]
| rev1score = {{Rating|4.5|5}}<ref name="AM">{{Allmusic |class=album |id=r70661 |tab=review |label=Alice in Chains: ''Dirt'' > Review |first=Steve |last=Huey |accessdate=31 January 2010}}</ref>
| rev2 = [[Robert Christgau]]
| rev2score = B<ref name="RC">{{cite web |first=Robert |last=Christgau |title=Review: ''Dirt'' |url=http://www.robertchristgau.com/get_artist.php?name=Alice+in+Chains |publisher=[[Robert Christgau]] |accessdate=31 January 2010}}</ref>
| rev3 = ''[[Q (magazine)|Q]]''
| rev3score = {{Rating|4|5}}<ref name="Q">{{cite journal |last=Doe |first=Jane |title=Review: ''Dirt'' |journal=[[Q (magazine)|Q]] |issue=65 |date=February 2002 |page=120}}</ref>
}}
</pre>

will render

{{Album ratings
| MC = 69/100<ref name="Meta">{{cite web|url=http://www.metacritic.com/music/black-gives-way-to-blue/alice-in-chains|title=Black Gives Way To Blue|publisher=Metacritic|accessdate=2012-09-02}}</ref>
| rev1 = [[AllMusic]]
| rev1score = {{Rating|4.5|5}}<ref name="AM">{{Allmusic |class=album |id=r70661 |tab=review |label=Alice in Chains: ''Dirt'' > Review |first=Steve |last=Huey |accessdate=31 January 2010}}</ref>
| rev2 = [[Robert Christgau]]
| rev2score = B<ref name="RC">{{cite web |first=Robert |last=Christgau |title=Review: ''Dirt'' |url=http://www.robertchristgau.com/get_artist.php?name=Alice+in+Chains |publisher=[[Robert Christgau]] |accessdate=31 January 2010}}</ref>
| rev3 = ''[[Q (magazine)|Q]]''
| rev3score = {{Rating|4|5}}<ref name="Q">{{cite journal |last=Doe |first=Jane |title=Review: ''Dirt'' |journal=[[Q (magazine)|Q]] |issue=65 |date=February 2002  |page=120}}</ref>
}}
{{clear}}

and generate the following footnotes with the sources:
{{reflist}}

==Template data==
{{TemplateDataHeader}}
<templatedata>
{
	"description": "This template creates a table with reviews for albums. Only add a rating if you cite it with a reference. The template is not to be a substitute for a section in paragraph form.",
	"params": {
		"rev1": {
			"label": "First reviewer",
			"type": "string",
			"required": true,
			"description": "The name of the first reviewer."
		},
		"rev1score": {
			"label": "First reviewer's rating",
			"type": "string",
			"required": true,
			"description": "The rating given by the first reviewer. "
		},
		"rev2": {
			"label": "Second reviewer",
			"type": "string",
			"description": "The name of the second reviewer. More reviewers can be added with parameters in the format rev[#] (the next one would be rev3). It is recommended to include no more than 10 reviews, but more can be added in exceptional circumstances."
		},
		"rev2score": {
			"label": "Second reviewer's rating",
			"type": "string",
			"description": "The rating given by the second reviewer. More ratings can be added with parameters in the format rev[#]score (the next one would be rev3score). It is recommended to include no more than 10 reviews, but more can be added in exceptional circumstances."
		},
		"title": {
			"label": "Table title",
			"type": "string",
			"description": "A custom title for the table, replacing \"professional ratings\"."
		},
		"subtitle": {
			"label": "Table subtitle",
			"type": "string",
			"description": "Additional text before the collapsible section. This is necessary to add if you want a longer title, as long titles in the \"title\" parameter will not work right."
		},
		"width": {
			"label": "Table width",
			"type": "string",
			"description": "The width of the table."
		},
		"MC": {
			"label": "Metacritic score",
			"type": "string",
			"description": "The Metacritic score. Appears under the \"Aggregate scores\" header."
		},
		"noprose": {
			"label": "Article lacks prose section",
			"type": "string",
			"description": "Set this to \"yes\" to flag articles that have an album ratings table without a prose reviews section."
		},
		"ADM": {
			"label": "AnyDecentMusic score",
			"description": "The AnyDecentMusic? score. Appears under the \"Aggregate scores\" header.",
			"type": "string"
		},
		"aggregate1": {
			"label": "First review aggregator",
			"description": "The name of the first review aggregator.",
			"type": "string"
		},
		"aggregate1score": {
			"label": "First review aggregator's rating",
			"description": "The rating given by the first review aggregator.",
			"type": "string"
		},
		"aggregate2": {
			"label": "Second review aggregator",
			"description": "The name of the second review aggregator.",
			"type": "string"
		},
		"aggregate2score": {
			"label": "Second review aggregator's rating",
			"description": "The rating given by the second review aggregator.",
			"type": "string"
		}
	},
	"format": "block"
}
</templatedata>

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia rating templates]]
[[Category:WikiProject Albums templates]]
}}</includeonly>