Template:Music ratings/doc: Difference between revisions

Content deleted Content added
document ADM and aggregate parameters
Added the full ten rev parameters to the sample (I figure it's easier to have them and remove ones that aren't needed than to add more every time they are)
 
(42 intermediate revisions by 20 users not shown)
Line 1:
{{Documentation subpage}}
{{High-use}}
<includeonly>{{high-use|70,000+}}</includeonly>
{{Ombox
{{lua|Module:Album ratings}}
|type = notice
|text =
<div>
'''Only add a rating if you [[Wikipedia:Citing sources|cite it with a reference]].''' For further information on sources, see [[Wikipedia:WikiProject Albums]]<!-- should this be a more general link since this is songs and albums now? -->. For the guide on transitioning from Infoboxes to AlbumRatings, see [[Wikipedia:WikiProject Albums/Moving infobox reviews into article space]].</div>
}}
{{lua|Module:Music ratings}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[</nowiki>[[Wikipedia:Wikidata]]<nowiki>]]) -->
 
{{AlbumMusic ratings
| rev1 = [[AllMusic]]
| rev1Scorerev1score = {{Rating|4|5}}<{{sup>|[1]</sup>}}
| rev2 = ''[[IGNRolling Stone]]''
| rev2Scorerev2score = 9/10<{{sup>|[32]</sup>}}
| rev3 = Jesus Freak Hideout
| rev3Score = {{Rating|4.5|5}}<sup>[2]</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==
This template provides a brief summary and overview of the critical consensus of song and album reviews. It is used to display only brief and objectively-verifiable ratings, such as "{{rating|4|5}}", "B+", or "7/10". It cannot capture the general sense of a review that does not include any kind of scale, so do not include language like "Very favorable" or "(mixed)" in the template, as this would be [[WP:OR|original research]].
 
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.
 
Line 22 ⟶ 26:
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 accurately. 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|AllmusicAllMusic}} template.
 
For reviewsreview ataggregators [[AnyDecentMusic?]] and [[Metacritic]] it is convenient to use "the fields {{Code|ADM}} and {{code|MC="}} in the template., respectively.
 
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 noteNote that the [[minus sign]] character ([[−]]) is not the same thing as a [[hyphen]] ([[-]]), so "B–", not "B-". They appear similar but you can use the proper character by inputting {{code|&amp;minus;}} or using the {{code|Insert}} menu that is available in the editing window on Wikipedia; it is located near other such arithmetic operators like <×> and <÷>.
 
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. [httphttps://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==
<syntaxhighlight lang="wikitext">
<pre>
{{AlbumMusic ratings
| title =
| subtitle =
<!-- Aggregate scores -->
| ADM =
Line 48 ⟶ 52:
| aggregate3 =
| aggregate3score =
<!-- ... -->
<!-- Reviewers -->
| rev1 =
| rev1Scorerev1score =
| rev2 =
| rev2Scorerev2score =
| rev3 =
| rev3Scorerev3score =
| rev4 =
| rev4score =
| rev5 =
| rev5score =
| rev6 =
| rev6score =
| rev7 =
| rev7score =
| rev8 =
| rev8score =
| rev9 =
| rev9score =
| rev10 =
| rev10score =
<!-- ... -->
<!-- Article needs reviews expanded into prose -->
| noprose = <!--yes-->
}}
</syntaxhighlight>
</pre>
 
== Parameters ==
Line 65 ⟶ 84:
 
:; ''rev#''
:: theThe name of the reviewer. [[Wikipedia:WikiProject Albums/Article body#Critical reception|It is recommended to include no more than 10 reviews]] <!-- should this be a more general link since this isn't just for albums now? -->, but you can add more in exceptional circumstances. For instance, a particularly popular song or album which has been re-released and has several prominent reviews over decades' time.
:; ''rev#Scorescore''
:: theThe rating given by the reviewer.
 
All of the following fields are optional:
 
:; ''title''
:: canCan be used to provide a custom title for the table, otherwise, it will default to "Professional ratings".
:; ''subtitle''
:: usedUsed 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''
:: setsSets the width of the table; default is 24.2em, to match the width of the song and album infoboxinfoboxes in most browsers and skins.
:; ''ADM''
:: [[AnyDecentMusic?]] score.
:; ''MC''
:: [[Metacritic]] score.
:; ''aggregate1aggregate#''
:: Name of a [[review aggregator]].
:; ''aggregate1scoreaggregate#score''
:: ScoreThe fromrating given by the review aggregator specified in ''aggregate1''.
:; ''aggregate2'', ''aggregate2score'', ''aggregate3'', ''aggregate3score'', etc.
:: Names and scores from other review aggregators
:; ''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 albummusic ratings that need to be turned into prose]].
 
==Example==
For example, entering
 
<prediv style="overflow:auto">
<syntaxhighlight lang="wikitext">
{{Album ratings
{{Music 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>
| 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|access-date=2 September 2012}}</ref>
| rev1 = [[AllMusic]]
| rev1Scorerev1score = {{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 = ''[[RobertQ Christgau(magazine)|Q]]''
| rev2Scorerev2score = B{{Rating|4|5}}<ref name="RCQ">{{cite webmagazine |firstlast=RobertDoe |lastfirst=ChristgauJane |title=Review: ''Dirt'' |url=http://www.robertchristgau.com/get_artist.php?name=Alice+in+Chains |publishermagazine=[[RobertQ Christgau(magazine)|Q]] |accessdateissue=3165 January|date=February 20102002 |page=120}}</ref>
| rev3 = ''[[QRobert (magazine)|QChristgau]]''
| rev3Scorerev3score = {{Rating|4|5}}B<ref name="QRC">{{cite journalweb |lastfirst=DoeRobert |firstlast=JaneChristgau |title=Review: ''Dirt'' |journalurl=http://www.robertchristgau.com/get_artist.php?name=Alice+in+Chains |publisher=[[QRobert (magazine)|QChristgau]] |issue=65 |access-date=February31 2002January |page=1202010}}</ref>
}}
</syntaxhighlight>
</pre>
</div>
 
will render
 
{{AlbumMusic 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|accessdateaccess-date=2012-09-02}}</ref>
| rev1 = [[AllMusic]]
| rev1Scorerev1score = {{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>
| rev2rev3 = [[Robert Christgau]]
| rev2Scorerev3score = 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]] |accessdateaccess-date=31 January 2010}}</ref>
| rev3rev2 = ''[[Q (magazine)|Q]]''
| rev3Scorerev2score = {{Rating|4|5}}<ref name="Q">{{cite journalmagazine |last=Doe |first=Jane |title=Review: ''Dirt'' |journalmagazine=[[Q (magazine)|Q]] |issue=65 |date=February 2002 |page=120}}</ref>
}}
{{clear}}
Line 120 ⟶ 139:
and generate the following footnotes with the sources:
{{reflist}}
 
==Tracking categories==
*{{clc|Pages using music ratings with unknown parameters}}
*{{clc|Articles with music ratings that need to be turned into prose}}
*{{clc|Pages using music ratings with duplicate score parameters }}
 
==Template data==
Line 125 ⟶ 149:
<templatedata>
{
"description": "This template creates a table with reviews for songs and 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": "First1st reviewer",
"type": "string",
"required": true,
Line 134 ⟶ 158:
},
"rev1score": {
"label": "First1st reviewer's rating",
"type": "string",
"required": true,
"description": "The rating given by the first reviewer. ",
"aliases": [
"rev1Score"
]
},
"rev2": {
"label": "Second2nd 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": "Second2nd 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.",
"aliases": [
"rev2Score"
]
},
"titlerev3": {
"label": "Table3rd titlereviewer",
"type": "string"
},
"rev3score": {
"label": "3rd reviewer's rating",
"type": "string",
"aliases": [
"description": "A custom title for the table, replacing \"professional ratings\"."
"rev3Score"
]
},
"subtitlerev4": {
"label": "Table4th subtitlereviewer",
"type": "string"
},
"rev4score": {
"label": "4th reviewer's rating",
"type": "string",
"aliases": [
"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."
"rev4Score"
]
},
"widthrev5": {
"label": "Table5th widthreviewer",
"type": "string"
},
"rev5score": {
"label": "5th reviewer's rating",
"type": "string",
"aliases": [
"description": "The width of the table."
"rev5Score"
]
},
"MCrev6": {
"label": "Metacritic6th scorereviewer",
"type": "string"
},
"rev6score": {
"label": "6th reviewer's rating",
"type": "string",
"aliases": [
"description": "The Metacritic score. Appears under the \"Aggregate scores\" header."
"rev6Score"
]
},
"noproserev7": {
"label": "Article7th lacks prose sectionreviewer",
"type": "string"
},
"rev7score": {
"label": "7th reviewer's rating",
"type": "string",
"aliases": [
"description": "Set this to \"yes\" to flag articles that have an album ratings table without a prose reviews section."
"rev7Score"
]
},
"rev8": {
"label": "8th reviewer",
"type": "string"
},
"rev8score": {
"label": "8th reviewer's rating",
"type": "string",
"aliases": [
"rev8Score"
]
},
"rev9": {
"label": "9th reviewer",
"type": "string"
},
"rev9score": {
"label": "9th reviewer's rating",
"type": "string",
"aliases": [
"rev9Score"
]
},
"rev10": {
"label": "10th reviewer",
"type": "string"
},
"rev10score": {
"label": "10th reviewer's rating",
"type": "string",
"aliases": [
"rev10Score"
]
},
"ADM": {
Line 178 ⟶ 271:
"description": "The AnyDecentMusic? score. Appears under the \"Aggregate scores\" header.",
"type": "string"
},
"MC": {
"label": "Metacritic score",
"type": "string",
"description": "The Metacritic score. Appears under the \"Aggregate scores\" header."
},
"aggregate1": {
"label": "First1st review aggregator",
"description": "The name of the first review aggregator.",
"type": "string"
},
"aggregate1score": {
"label": "First1st review aggregator's rating",
"description": "The rating given by the first review aggregator.",
"type": "string"
},
"aggregate2": {
"label": "Second2nd review aggregator",
"description": "The name of the second review aggregator.",
"type": "string"
},
"aggregate2score": {
"label": "Second2nd review aggregator's rating",
"description": "The rating given by the second review aggregator.",
"type": "string"
},
"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."
},
"align": {
"label": "Table align",
"description": "The value is \"left\" if you want to place the table on the left.",
"type": "line",
"autovalue": "left"
},
"state": {
"label": "Table state (collapse)",
"description": "Automatically collapses the template and adds a \"show\" button.",
"type": "line",
"autovalue": "collapsed",
"suggestedvalues": [
"collapsed"
],
"deprecated": "[[MOS:COLLAPSE]]"
},
"noprose": {
"label": "Article lacks prose section",
"type": "line",
"description": "Set to yes if there is just a single ratings template in the reception section and prose text is missing",
"autovalue": "yes"
}
},
"format": "block",
"paramOrder": [
"rev1",
"rev1score",
"rev2",
"rev2score",
"rev3",
"rev3score",
"rev4",
"rev4score",
"rev5",
"rev5score",
"rev6",
"rev6score",
"rev7",
"rev7score",
"rev8",
"rev8score",
"rev9",
"rev9score",
"rev10",
"rev10score",
"ADM",
"MC",
"aggregate1",
"aggregate1score",
"aggregate2",
"aggregate2score",
"title",
"subtitle",
"width",
"align",
"noprose",
"state"
]
}
</templatedata>
 
==See also==
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
*[[:Template:TV ratings]]
*[[:Template:Film and game ratings]]
 
<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia ratingRating templates|Music]]
[[Category:WikiProject Albums templates]]
[[Category:Metacritic templates]]
 
}}</includeonly>