Template:Rotten Tomatoes data/doc
This is a documentation subpage for Template:Rotten Tomatoes data. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 5,300 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
Rotten Tomatoes data retrieves (the most recent) Rotten Tomatoes data from Wikidata. Currently available only for movies.
For this template to work properly, the Wikidata item to be accessed should have Rotten Tomatoes data available, e.g. as shown here.
Usage
[edit]{{Rotten Tomatoes data|command|qid=...}}
{{Rotten Tomatoes data|command|title=...}}
Command options are described in § Examples. The optional parameter qid
should be the Q-identifier of the Wikidata item to be accessed, e.g. Q943338
. Alternatively, one can use the parameter title
which should be the title of the Wikipedia article whose connected Wikidata item is to be accessed, e.g. American Psycho (film)
. By default, when neither qid
nor title
are provided, the item connected to the current article is accessed.
For this template to work properly, the Wikidata item to be accessed should have Rotten Tomatoes data available, e.g. as shown here. An error message is produced for missing data. See Wikipedia:Wikidata § Access from Wikipedia for how to access the Wikidata item connected to an article.
Examples
[edit]In the following examples we use the film Hitch which has a corresponding Wikidata item Hitch (Q943338).
- The
score
command produces the Tomatometer score.{{Rotten Tomatoes data|score|qid=Q943338}}
⇒ 69%
- The
title
of a Wikipedia article can be given instead ofqid
.{{Rotten Tomatoes data|score|title=Hitch (film)}}
⇒ 69%
- The
count
command produces the number of critic reviews. The parameterspell
can be used to apply {{Spellnum per MOS}} to the count.{{Rotten Tomatoes data|count|qid=Q943338}}
⇒ 188{{Rotten Tomatoes data|count|spell=y|title=Meadowland (film)}}
⇒ twenty-five
- The
average
command produces the average rating.{{Rotten Tomatoes data|average|qid=Q943338}}
⇒ 6.3/10
- The
table
command is convenient for use in tables to provide a quick overview of a score and reviews.{{Rotten Tomatoes data|table|qid=Q943338}}
⇒ 69% (188 reviews)
- The
access date
(oraccessdate
oraccess-date
) command produces the retrieved (P813) date from the reference if it exists, and otherwise produces the point in time (P585) if it exists.{{Rotten Tomatoes data|access date|qid=Q943338}}
⇒ June 24, 2024{{Rotten Tomatoes data|access date|df=dmy|qid=Q943338}}
⇒ 24 June 2024{{Rotten Tomatoes data|access date|df=ymd|qid=Q943338}}
⇒ 2024 June 24{{Rotten Tomatoes data|access date|df=iso|qid=Q943338}}
⇒ 2024-06-24
- The
date
command produces the point in time (P585) if it exists, and otherwise produces the retrieved (P813) date from the reference if it exists. Use theaccess date
command for citations. Thedate
command exists mostly in case the point in time (P585) differs from the retrieved (P813) date for some reason.{{Rotten Tomatoes data|date|qid=Q943338}}
⇒ June 24, 2024
- The
as of
(orasof
) command wraps the template {{As of}}, except that any values given for the year, month, and day parameters are converted to the corresponding value from thedate
command. - The
prose
command produces the result of the template {{Rotten Tomatoes prose}} with autofilled parameters.{{Rotten Tomatoes data|prose|qid=Q943338}}
⇒ On the review aggregator website Rotten Tomatoes, 69% of 188 critics' reviews are positive, with an average rating of 6.3/10.
- The
rtid
command produces the item's Rotten Tomatoes ID (P1258) value.{{Rotten Tomatoes data|rtid|qid=Q943338}}
⇒ m/hitch{{Rotten Tomatoes data|rtid|noprefix=y|qid=Q943338}}
⇒ hitch
- The
url
command produces the full Rotten Tomatoes URL using the item's Rotten Tomatoes ID (P1258) value and the property's formatter URL.{{Rotten Tomatoes data|url|qid=Q943338}}
⇒ https://www.rottentomatoes.com/m/hitch
- The
edit
command wraps the template {{EditAtWikidata}}, linking topid=P444
.{{Rotten Tomatoes data|edit|qid=Q943338}}
⇒
Error detection
[edit]Certain errors are reported for missing/faulty parameters and data. For example:
{{Rotten Tomatoes data|count}}
⇒ No Wikidata item connected to current page. Need qid or title argument.{{Rotten Tomatoes data|count|title=Apple Apple Apple}}
⇒ Article "Apple Apple Apple" does not exist or has no Wikidata item.{{Rotten Tomatoes data|score|qid=Q2}}
⇒ RT data for "score" unavailable.
TemplateData
[edit]TemplateData for Rotten Tomatoes data
Parameter | Description | Type | Status | |
---|---|---|---|---|
Command | 1 | Command which tells this template what value to return. For usage examples and explanations, see the full documentation at "Template:Rotten Tomatoes data/doc". The "score" command returns the Tomatometer score, e.g. 99%. The "count" command returns the number of reviews, e.g. 112. The "average" command returns the average rating, e.g. 5.5/10. The "table" command returns the score and count in the format "XX% (YYY reviews)". The "rtid" command returns the Rotten Tomatoes ID, e.g. m/titanic. The "url" command returns the url, e.g. https://www.rottentomatoes.com/m/titanic. The "date" command returns the date on which the Tomatometer score was accurate, e.g. October 1, 2021. The "access date" command returns the date on which the Tomatometer score was retrieved and added to Wikidata, e.g. October 1, 2021. The "as of" command turns the rest of this template into a wrapper for "Template:As of" and returns the result of that template, except that any values given for the year, month, or day are converted to the corresponding value from the "date" command. The "prose" command returns the result of "Template:Rotten Tomatoes prose" with autofilled parameters. The "edit" command returns the result of "Template:EditAtWikidata", linked to property P444.
| String | required |
Date format | df | Date format for the "date" and "access date" commands. Options are "mdy" (May 4, 2021), "dmy" (4 May 2021), "iso" (2021-05-04), and "ymd" (2021 May 4). If omitted, the "mdy" format is used.
| String | optional |
No prefix for rtid | noprefix | Removes the Rotten Tomatoes ID prefix (e.g. "m/") when used with the "rtid" command. Give this parameter any value to remove the prefix.
| String | optional |
Spell out the count | spell | Wraps the count with "Template:Spellnum per MOS" when used with the "count" command. Give this parameter any value to activate the wrapping.
| String | optional |
Wikidata Q-identifier | qid | Q-identifier of the Wikidata item to be accessed. If both "qid" and "title" are omitted, the item connect to the current page is accessed. Only one of the parameters "qid" and "title" should be used.
| String | optional |
Title of article | title | Title of the Wikipedia article whose connected Wikidata item is to be accessed. If both "qid" and "title" are omitted, the item connect to the current page is accessed. Only one of the parameters "qid" and "title" should be used.
| String | optional |
Tracking category
[edit]See also
[edit]Other templates:
FAQ for Rotten Tomatoes: