View source for Template:Cite tweet/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Notice |image=Ambox important.svg |heading={{large|Tweets are usually unacceptable as sources.}} | Tweets and other self-published material may be acceptable if the conditions specified at [[WP:SPS]] or [[WP:TWITTER]] are met. For further information, see the [[Wikipedia:Verifiability]] policy and the [[Wikipedia:Identifying reliable sources]] guideline.}}
{{High-use}}
{{CS1 wrapper |type= |base=Cite web}}
{{Template redirect|Cite twitter|Cite X}}
{{Lua|Module:Cite tweet}}
{{csdoc|cs1}}

A template for citing [[Tweet (social media)|tweets]] posted on [[Twitter]].

== Usage ==
{{csdoc|usage}}
{| class="wikitable" style="width: 100%"
|+ Required parameters only, in horizontal format
|- style="vertical-align:top;"
|
:<syntaxhighlight lang="wikitext" copy="1">{{Cite tweet |user= |number= |title=}}</syntaxhighlight>
{{end}}
{{csdoc|usage full}}
:<syntaxhighlight lang="wikitext" copy="1">{{Cite tweet |author= (or |last= |first= ) |author-link= |user= |number= |date= |title= |script-title= |trans-title= |language= |retweet= |location= |access-date= |link= |url-status= |archive-url= |archive-date= |quote= |ref=}}</syntaxhighlight>
{{end}}
{{A note}} When known, the author's real name should be specified in the {{para|author}} parameter (or {{para|last}} and {{para|first}}). If their real name is not known, then the tweet is probably not an [[WP:SPS|acceptable usage of a self-published source]].

=== Using {{tl|sfn}} and {{tl|harvid}} ===
To use this template with shortened footnotes (e.g. the {{tl|sfn}} template), add {{para|ref}} with {{tl|harvid}} in the parameter value, like this:

:<code><nowiki>{{Cite tweet |ref={{harvid|Porck|2017}} |last=Porck |first=Thijs |user=thijsporck |number=889205416596471811 |date=23 July 2017 |title=Spotted in Marvel's Doctor Strange: Sutton Hoo Helmet replica! |access-date=5 December 2017}}</nowiki></code>

This reference would be cited as <code><nowiki>{{sfn|Porck|2017}}</nowiki></code>.

=== Optional {{para|date}} parameter ===
Unlike most citation templates, the {{para|date}} parameter is optional. This is because the date can be calculated directly from the Tweet's ID using [[Module:TwitterSnowflake]] (wrapped with [[Template:TwitterSnowflake]]).

If the {{para|date}} parameter is off by more than one day from what the calculated date is, the template will output an error. This can be fixed by removing or correcting the date parameter.

If the Tweet was posted before November 4, 2010, the date cannot be calculated from the ID {{--}} the template will output an error if no date is provided. The template will also provide incorrect dates for tweets posted before November 4, 2010.

== Examples ==
'''<code><nowiki>{{Cite tweet |user=Pigsonthewing |number=564068436633214977 |title=This is an example tweet. Hello, Wikipedians!}}</nowiki></code>'''
: {{Cite tweet |user=Pigsonthewing |number=564068436633214977 |title=This is an example tweet. Hello, Wikipedians!}}
'''<code><nowiki>{{Cite tweet |author=Andy Mabbett |user=Pigsonthewing |number=564068436633214977 |title=This is an example tweet. Hello, Wikipedians!}}</nowiki></code>'''
: {{Cite tweet |author=Andy Mabbett |user=Pigsonthewing |number=564068436633214977 |title=This is an example tweet. Hello, Wikipedians!}}
'''<code><nowiki>{{Cite tweet |author=Andy Mabbett |user=Pigsonthewing |number=564068436633214977 |title=This is an example tweet. Hello, Wikipedians! |retweet=Wikimedia Foundation [Wikimedia]}}</nowiki></code>'''
: {{Cite tweet |author=Andy Mabbett |user=Pigsonthewing |number=564068436633214977 |title=This is an example tweet. Hello, Wikipedians! |retweet=Wikimedia Foundation [Wikimedia]}}

If the author has a Wikipedia article, use of {{para|author-link}} is recommended:<br/>
'''<code><nowiki>{{Cite tweet |author=Elon Musk |author-link=Elon Musk |user=elonmusk |number=743097337782763521 |title=Looks like thrust was low on 1 of 3 landing engines. High g landings v sensitive to all engines operating at max.}}</nowiki></code>'''
: {{Cite tweet |author=Elon Musk |author-link=Elon Musk |user=elonmusk |number=743097337782763521 |title=Looks like thrust was low on 1 of 3 landing engines. High g landings v sensitive to all engines operating at max.}}

This tweet was posted before November 4, 2010, so {{para|date}} is necessary:<br/>
'''<code><nowiki>{{Cite tweet |user=jack |number=20 |title=just setting up my twttr |date=March 21, 2006 }}</nowiki></code>'''
: {{Cite tweet |user=jack |number=20 |title=just setting up my twttr |date=March 21, 2006 |author-link=Jack Dorsey }}

== Error detection ==
* The parameters {{para|user}}, {{para|number}}, and {{para|title}} are '''{{red|required}}'''. If omitted or left blank, errors will be reported. For example:
*: '''<code><nowiki>{{Cite tweet |title=I'm an incomplete citation!}}</nowiki></code>'''
*:: {{Cite tweet |title=I'm an incomplete citation!}}

===Missing or empty |user= ===
The {{para|user}} parameter is required. The tweet URL is derived from the {{para|user}} and {{para|number}} parameters. If {{para|user}} or {{para|number}}  are missing, the URL defaults to <nowiki>https://twitter.com/</nowiki> Copy the twitter handle (minus the "@" symbol) into this parameter.

===Missing or empty |number= ===
The {{para|number}} parameter is required. The tweet URL and date are derived from {{para|number}}. If {{para|user}} or {{para|number}}  are missing, the URL defaults to <nowiki>https://twitter.com/</nowiki> Copy the long number behind the final <code>/</code> of the tweet's URL into this parameter. For example, if the Tweet URL is <code><nowiki>https://twitter.com/pigsonthewing/status/</nowiki>'''<nowiki>564068436633214977</nowiki>'''<nowiki></nowiki></code>, the template requires <code><nowiki>|number=</nowiki>'''<nowiki>564068436633214977</nowiki>'''<nowiki></nowiki></code>

===Invalid |number= ===
This error indicates that the required {{para|number}} parameter does not match a tweet's URL. Copy the long number behind the final <code>\</code> of the tweet's URL into this parameter. For example, if the Tweet URL is <code><nowiki>https://twitter.com/pigsonthewing/status/</nowiki>'''<nowiki>564068436633214977</nowiki>'''<nowiki></nowiki></code>, the template requires <code><nowiki>|number=</nowiki>'''<nowiki>564068436633214977</nowiki>'''<nowiki></nowiki></code>

===|date= required===
The {{para|date}} parameter is required for tweets posted before November 4, 2010. The {{para|date}} parameter is optional for tweets posted after November 4, 2010, as the date is determined from the {{para|number}} parameter. For earlier tweets, manually type the date into {{para|date}}.

===|date= / |number= mismatch===
The tweet date is derived from the {{para|number}} parameter for tweets posted after November 4, 2010. If the optional {{para|date}} parameter is used and off by more than a day from the calculated date, an error is displayed. If the {{para|number}} is correct, remove or correct the {{para|date}}.

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"number": {
			"label": "Tweet number",
			"description": "Numerical ID of the tweet",
			"type": "number",
			"required": true
		},
		"user": {
			"label": "User handle",
			"description": "Twitter account name, without the @",
			"type": "string",
			"required": true
		},
		"title": {
			"label": "Tweet contents",
			"description": "Partial or entire content of the tweet, optionally including hashtags (#), at signs (@), and links. Note: double quote marks (\") should be replaced with single quote marks (') because the entire title will display surrounded by double quotes.",
			"type": "string",
			"required": true
		},
		"author": {
			"label": "Tweet author",
			"description": "Author's real name, if known. Will not change to the last name, first name format.",
			"type": "string"
		},
		"author-link": {
			"aliases": [
				"authorlink"
			],
			"label": "Author's article",
			"description": "Title of existing Wikipedia article about the author",
			"type": "wiki-page-name"
		},
		"retweet": {
			"label": "Retweeted by",
			"description": "The reliable source who retweeted the tweet, if the original tweeter is not anyone particularly notable. May be wikilinked.",
			"type": "string"
		},
		"date": {
			"label": "Date",
			"description": "Date of the tweet; do not wikilink; do not include time.",
			"type": "date",
			"suggested": true
		},
		"access-date": {
			"aliases": [
				"accessdate"
			],
			"label": "Access date",
			"description": "The full date when the tweet was accessed; do not wikilink",
			"type": "date",
			"suggested": true
		},
		"language": {
			"label": "Language",
			"description": "The language in which the tweet is written, if not in English.",
			"example": "fr",
			"type": "string"
		},
		"location": {
			"label": "Tweet location",
			"description": "The location from which a tweet was sent.",
			"example": "London",
			"type": "string"
		},
		"archive-url": {
			"label": "Archive URL",
			"aliases": [
				"archiveurl"
			],
			"description": "The URL of an archived copy of a web page, if or in case the URL becomes unavailable; requires 'archive-date'",
			"type": "url"
		},
		"archive-date": {
			"label": "Archive date",
			"aliases": [
				"archivedate"
			],
			"description": "Date when the original URL was archived; do not wikilink",
			"type": "date"
		},
		"url-status": {
			"label": "URL status",
			"description": "If set to 'live', the title displays as the live link; if set to dead, the title displays as the archive link",
			"type": "string"
		},
		"script-title": {
			"label": "Tweet script",
			"description": "For tweets in languages that do not use a Latin-based alphabet (Arabic, Chinese, Cyrillic, Greek, Hebrew, Japanese, Korean, Vietnamese, etc). Prefix with two-character ISO639-1 language code followed by a colon, e.g. for Japanese use: ja:...",
			"example": "ja:東京タワー",
			"type": "string"
		},
		"trans-title": {
			"label": "Translated tweet",
			"description": "An English language translation, if the tweet cited is in a foreign language; use of 'language' parameter is recommended",
			"type": "string"
		},
		"link": {
			"label": "Link to Twitter article?",
			"description": "Set to \"no\" to not link to the Wikipedia article for Twitter. Useful for preventing overlinking when more than one tweet is cited.",
			"type": "boolean"
		},
		"df": {
			"label": "Date format",
			"description": "Valid values: dmy, dmy-all, mdy, mdy-all, ymd, ymd-all",
			"type": "string"
		},
		"ref": {
			"label": "Ref anchor",
			"description": "An anchor identifier; can be made the target of wikilinks to full references",
			"type": "string"
		},
		"quote": {
			"label": "Quote",
			"description": "Relevant text quoted from the source; displays last, enclosed in quotes; must include terminating punctuation",
			"type": "string"
		},
		"first": {
			"aliases": [
				"first1"
			],
			"label": "First name",
			"description": "The first name of the author, if known. If not known, then the tweet is probably not an acceptable usage of a self-published source (see WP:SPS).",
			"type": "string",
			"suggested": true
		},
		"last": {
			"label": "Last name",
			"description": "The last name of the author.",
			"type": "string",
			"suggested": true
		}
	},
	"description": "A template for citing tweets posted on Twitter.",
	"paramOrder": [
		"number",
		"user",
		"title",
		"first",
		"last",
		"author",
		"author-link",
		"retweet",
		"date",
		"access-date",
		"language",
		"location",
		"archive-url",
		"archive-date",
		"url-status",
		"script-title",
		"trans-title",
		"link",
		"df",
		"quote",
		"ref"
	],
	"format": "{{_ |_=_}}"
}
</templatedata>

== See also ==
* {{tlx|Tweet}}
* {{tlx|Cite Twitter profile}}
* [[WP:TWITTER]]

== Tracking category ==
* {{clc|Cite tweet templates with errors}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Citation Style 1 specific-source templates‎]]
[[Category:Twitter templates]]
}}</includeonly>