View source for Template:Rotten Tomatoes data/doc

{{Documentation subpage}} <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{for2|citations|{{tl|Cite Rotten Tomatoes}}|external links|{{tl|Rotten Tomatoes}}|inline prose|{{tl|Rotten Tomatoes prose}}}}
{{Lua|Module:Rotten Tomatoes data}}
{{Template shortcut|RT data|Rt data|Rotten tomatoes data}}

'''{{TEMPLATENAME}}''' retrieves (the most recent) [[Rotten Tomatoes]] data from [[Wikipedia:Wikidata|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 [https://www.wikidata.org/wiki/Q59653#P444 here].

== Usage ==
{{tlc|{{TEMPLATENAME}}| ''command'' | qid{{=}}...}}<br/>
{{tlc|{{TEMPLATENAME}}| ''command'' | title{{=}}...}}

Command options are described in {{section link||Examples}}. The optional parameter <code>qid</code> should be the [[Wikidata:Wikidata:Identifiers|Q-identifier]] of the Wikidata item to be accessed, e.g. <code>Q943338</code>. Alternatively, one can use the parameter <code>title</code> which should be the title of the Wikipedia article whose connected Wikidata item is to be accessed, e.g. <code>American Psycho (film)</code>. By default, when neither <code>qid</code> nor <code>title</code> 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 [https://www.wikidata.org/wiki/Q59653#P444 here].''' An error message is produced for missing data. See {{slink|Wikipedia:Wikidata|Access_from_Wikipedia}} for how to access the Wikidata item connected to an article.

=== Examples ===
In the following examples we use the film [[Hitch (film)|Hitch]] which has a corresponding Wikidata item {{Q|Q943338}}.
* The <code>score</code> command produces the Tomatometer score.
** {{tlc|{{TEMPLATENAME}}|score|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |score|qid = Q943338}}
*  The <code>title</code> of a Wikipedia article can be given instead of <code>qid</code>.
** {{tlc|{{TEMPLATENAME}}|score|title{{=}}Hitch (film)}} ⇒ {{{{TEMPLATENAME}} |score|title = Hitch (film)}}
*  The <code>count</code> command produces the number of critic reviews. The parameter <code>spell</code> can be used to apply {{tl|Spellnum per MOS}} to the count.
** {{tlc|{{TEMPLATENAME}}|count|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |count|qid = Q943338}}
** {{tlc|{{TEMPLATENAME}}|count|spell{{=}}y|title{{=}}Meadowland (film)}} ⇒ {{{{TEMPLATENAME}} |count|spell=y|title=Meadowland (film)}}
*  The <code>average</code> command produces the average rating.
** {{tlc|{{TEMPLATENAME}}|average|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |average|qid = Q943338}}
* The <code>table</code> command is convenient for use in tables to provide a quick overview of a score and reviews.
** {{tlc|{{TEMPLATENAME}}|table|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |table|qid = Q943338}}
*  The <code>access date</code> (or <code>accessdate</code> or <code>access-date</code>) command produces the {{Q|P813}} date from the reference if it exists, and otherwise produces the {{Q|P585}} if it exists.
** {{tlc|{{TEMPLATENAME}}|access date|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |access date|qid = Q943338}}
** {{tlc|{{TEMPLATENAME}}|access date|df{{=}}dmy|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |access date|df=dmy|qid = Q943338}}
** {{tlc|{{TEMPLATENAME}}|access date|df{{=}}ymd|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |access date|df=ymd|qid = Q943338}}
** {{tlc|{{TEMPLATENAME}}|access date|df{{=}}iso|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |access date|df=iso|qid = Q943338}}
*  The <code>date</code> command produces the {{Q|P585}} if it exists, and otherwise produces the {{Q|P813}} date from the reference if it exists. Use the <code>access date</code> command for citations. The <code>date</code> command exists mostly in case the {{Q|P585}} differs from the {{Q|P813}} date for some reason.
** {{tlc|{{TEMPLATENAME}}|date|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |date|qid = Q943338}}
*  The <code>as of</code> (or <code>asof</code>) command wraps the template {{tl|As of}}, except that ''any'' values given for the year, month, and day parameters are converted to the corresponding value from the <code>date</code> command.
** {{tlc|{{TEMPLATENAME}}|as of|year|month|day|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |as of |year|month|day|qid = Q943338}}
** {{tlc|{{TEMPLATENAME}}|as of|y|m|d|lc{{=}}y|df{{=}}us|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |as of |y|m|d|lc=y|df=us|qid = Q943338}}
** {{tlc|{{TEMPLATENAME}}|as of|a|b|lc{{=}}y|df{{=}}us|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |as of |a|b|lc=y|df=us|qid = Q943338}}
*  The <code>prose</code> command produces the result of the template {{tl|Rotten Tomatoes prose}} with autofilled parameters.
** {{tlc|{{TEMPLATENAME}}|prose|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}}|prose|qid = Q943338}}
*  The <code>rtid</code> command produces the item's {{Q|P1258}} value.
** {{tlc|{{TEMPLATENAME}}|rtid|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |rtid|qid = Q943338}}
** {{tlc|{{TEMPLATENAME}}|rtid|noprefix{{=}}y|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |rtid|noprefix=y|qid = Q943338}}
*  The <code>url</code> command produces the full Rotten Tomatoes URL using the item's {{Q|P1258}} value and [[Wikidata:Property:P1258#P1630|the property's formatter URL]].
** {{tlc|{{TEMPLATENAME}}|url|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |url|qid = Q943338}}
* The <code>edit</code> command wraps the template {{tl|EditAtWikidata}}, linking to <code>pid=P444</code>.
** {{tlc|{{TEMPLATENAME}}|edit|qid{{=}}Q943338}} ⇒ {{{{TEMPLATENAME}} |edit|qid = Q943338}}

=== Error detection ===
Certain errors are reported for missing/faulty parameters and data. For example:
* {{tlc|{{TEMPLATENAME}}|count}} ⇒ {{{{TEMPLATENAME}} |count}}
* {{tlc|{{TEMPLATENAME}}|count|title{{=}}Apple Apple Apple}} ⇒ {{{{TEMPLATENAME}} |count|title=Apple Apple Apple}}
* {{tlc|{{TEMPLATENAME}}|score|qid{{=}}Q2}} ⇒ {{{{TEMPLATENAME}} |score|qid=Q2}}

== TemplateData ==
{{Format TemplateData|1=<templatedata>
{
	"description": "Retrieves 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.",
	"params": {
		"1": {
			"label": "Command",
			"description": "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.",
			"required": true,
			"type": "string",
            "suggestedvalues": ["score", "count", "average", "rtid", "url", "date", "access date", "as of", "prose", "edit"],
            "example": "score"
		},
		"df": {
			"label": "Date format",
			"description": "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.",
			"type": "string",
            "suggestedvalues": ["mdy", "dmy", "iso", "ymd"],
			"example": "dmy",
            "default": "mdy"
		},
		"noprefix": {
			"label": "No prefix for rtid",
			"description": "Removes the Rotten Tomatoes ID prefix (e.g. \"m/\") when used with the \"rtid\" command. Give this parameter any value to remove the prefix.",
			"type": "string",
            "suggestedvalues": ["y", "yes", "true"],
			"example": "y"
		},
		"spell": {
			"label": "Spell out the count",
			"description": "Wraps the count with \"Template:Spellnum per MOS\" when used with the \"count\" command. Give this parameter any value to activate the wrapping.",
			"type": "string",
            "suggestedvalues": ["y", "yes", "true"],
			"example": "y"
		},
		"qid": {
			"label": "Wikidata Q-identifier",
			"description": "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.",
			"type": "string",
			"example": "Q943338"
		},
		"title": {
			"label": "Title of article",
			"description": "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.",
			"type": "string",
			"example": "Black Widow (2021 film)"
		}
	}
}
</templatedata>}}

== See also ==
Other templates:
*[[Template:Rotten Tomatoes prose]]
*[[Template:Cite Rotten Tomatoes]]
*[[Template:Rotten Tomatoes]]

FAQ for Rotten Tomatoes:
* https://www.rottentomatoes.com/faq

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Film templates]]
}}</includeonly>