View source for Template:Rating/doc

{{Documentation subpage}}
{{Intricate template}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[</nowiki>[[Wikipedia:Wikidata]]<nowiki>]]) -->
This template is designed to provide an image rating system, defaulting to stars. The template accepts ratings of up to ten, with more than six appearing reduced in size.

==When to use this template==
The template works with whole and half ratings (e.g. 0, 0.5, 1, 1.5, etc.). Other rating fractions (e.g. 3.2, 7.25) will be rounded, and the page on which the template resides will be inserted into the maintenance category [[:Category:Pages with incorrect use of Rating template]]. Use {{para|score}} to provide explanatory text for ratings that the original source does not express in whole or half increments.

Please only use this template if the rating was originally expressed with the images used. For example, if a reviewer awards something a rating of "4" (expressed in digits not stars) on a scale of 5, you should simply write it as "4" or "4/5" in your article, depending on how it is presented by the source. '''Do not''' use <nowiki>{{rating|4|5}}</nowiki> where the source does not use stars, because it is inaccurate and misleading.  Note that ratings on a scale of 10 can be hard to read if expressed visually with images.

==Parameters==
===Default===
These are the only parameters you need to show star ratings, the default symbols.
* The ''first'' unnamed parameter is the number of the rating received.
* The ''second'' unnamed parameter is optional, and is the maximum possible for the rating system. This will show empty or blank elements for the remainder above the rating, and changes the text in the tooltip to add "/''x''".

;Examples
{|
| {{rating|4|5}}   || {{tnull|rating|4|5}}
|-
| {{rating|0|3}}   || {{tnull|rating|0|3}}
|-
| {{rating|3.5|6}} || {{tnull|rating|3.5|6}}
|-
| {{rating|8|8}}   || {{tnull|rating|8|8}}
|-
| {{rating|5|10}}  || {{tnull|rating|5|10}}
|-
| {{rating|3}}     || {{tnull|rating|3}}
|}

===Optional===
These parameters are optional, and can change the appearance of the rating or its tooltip.
* {{para|score}} is used to change the alt text when mousing over the rating, in the case where "x/x" is not accurate or more information can be added.
* {{para|full}}, {{para|half}} and {{para|empty}} are used to change the images from the default stars to images you specify for each case. You don't have to fill out parameters for images you won't use, but omitting ones you will use results in stars being used for the unspecified portion (e.g. {{tnull|1=rating|2=2|3=5|4=full=Disc Plain red.svg}} makes {{rating|2|5|full=Disc Plain red.svg}}). Just the image name should be used without prepending "File:" or "Image:".
*:'''Important: Image files must be public domain only, as they are not linked back to their image description pages.'''
* {{para|rating}} should be used to name the new rating symbol if you change the images.
* {{para|rating-plural}} accepts non-standard pluralization in the tooltip to be used instead of adding "s" in simple cases. For instance, you could use this to change the default "thumb ups" to "thumbs up".
* {{para|size}} can be used to adjust the width at which the rating symbols display. The template defaults to symbols 11 pixels wide for up to five images and 7 pixels wide for more than five. Use the amount of pixels with "px" appended (i.e. "15px" not simply "15").

;Examples
{|
| {{rating|3|5|score=3/5 stars in a 0–5 star scale}}
| {{tnull|1=rating|2=3|3=5|4={{hilite|score}}=3/5 stars in a 0–5 star scale}}
|-
| {{rating|3|5|size=15px}}
| {{tnull|1=rating|2=3|3=5|4={{hilite|size}}=15px}}
|-
| {{rating|4|5|full=Gold medal icon blank.svg|empty=Silver medal icon blank.svg|rating=medal}}
| {{tnull|1=rating|2=4|3=5|4={{hilite|full}}=Gold medal icon blank.svg|5={{hilite|empty}}=Silver medal icon blank.svg|6={{hilite|rating}}=medal}}
|-
| {{rating|3.5|5|full=U+25CF.svg|half=U+25D0.svg|empty=U+25CB.svg|rating=mark}}
| {{tnull|1=rating|2=3.5|3=5|4={{hilite|full}}=U+25CF.svg|5={{hilite|half}}=U+25D0.svg|6={{hilite|empty}}=U+25CB.svg|7={{hilite|rating}}=mark}}
|-
| {{rating|2.5|5|full=Disc Plain red.svg|half=Cercle rouge 100%.svg|empty=Plain Disc 20% grey.svg|rating=mark}}
| {{tnull|1=rating|2=2.5|3=5|4={{hilite|full}}=Disc Plain red.svg|5={{hilite|half}}=Cercle rouge 100%.svg|6={{hilite|empty}}=Plain Disc 20% grey.svg|7={{hilite|rating}}=mark}}
|-
| {{rating|2|full=Symbol thumbs up.svg|rating=thumb up|rating-plural=thumbs up}}
| {{tnull|1=rating|2=2|3={{hilite|full}}=Symbol thumbs up.svg|4={{hilite|rating}}=thumb up|5={{hilite|rating-plural}}=thumbs up}}
|-
| {{rating|2|6|full=Symbol thumbs up.svg|empty=Symbol thumbs down.svg|rating=thumb up|rating-plural=thumbs up|score=2 thumbs up, but 4 thumbs down, giving this a rating of 2/6|size=12px}}
| {{tnull|1=rating|2=2|3=6|4={{hilite|full}}=Symbol thumbs up.svg|5={{hilite|empty}}=Symbol thumbs down.svg|6={{hilite|rating}}=thumb up|7={{hilite|rating-plural}}=thumbs up|8={{hilite|score}}=2 thumbs up, but 4 thumbs down, giving this a rating of 2/6|9={{hilite|size}}=12px}}
|}

==TemplateData==
{{TemplateDataHeader}}
<templatedata>
{
        "description": "A template to provide an image rating system",
        "params": {
                "1": {
                        "label": "Received",
                        "description": "Number of stars (or other images) received",
                        "type": "number",
                        "required": true
                },
                "2": {
                        "label": "Possible",
                        "description": "Total possible stars (or other images; defaults to parameter 1)",
                        "type": "number",
                        "required": false
                },
                "score": {
                        "label": "Score",
                        "description": "Text displayed when hovering over the rating",
                        "type": "string",
                        "required": false
                },
                "full": {
                        "label": "Full alternate",
                        "description": "Alternate image for a full star, without the File: prefix",
                        "type": "string",
                        "default": "Star full.svg",
                        "required": false
                },
                "half": {
                        "label": "Half alternate",
                        "description": "Alternate image for a half star, without the File: prefix",
                        "type": "string",
                        "default": "Star half.svg",
                        "required": false
                },
                "empty": {
                        "label": "Empty alternate",
                        "description": "Alternate image for an empty star, without the File: prefix",
                        "type": "string",
                        "default": "Star empty.svg",
                        "required": false
                },
                "rating": {
                        "label": "Rating symbol",
                        "description": "Unit for alternate images",
                        "type": "string",
                        "default": "star",
                        "required": false
                },
                "rating-plural": {
                        "label": "Plural rating symbol",
                        "description": "Plural form of the rating parameter if it is not just adding an \"s\"",
                        "type": "string",
                        "required": false
                },
                "size": {
                        "label": "Images size",
                        "description": "Size of the images, in pixels",
                        "type": "string",
                        "default": "11px",
                        "required": false
                }
        }
}
</templatedata>

==See also==
*{{tl|Rating-Christgau}} (for ratings by music critic [[Robert Christgau]])

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