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={{big|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}}
{{Lua|Module:Cite tweet}}

A template for citing tweets posted on Twitter.

== Usage ==
{{csdoc|usage}}
{| class="wikitable" style="width: 100%"
|+ Required parameters only, in horizontal format
|- style="vertical-align:top;"
|
: <code><nowiki>{{Cite tweet |user= |number= |title=}}</nowiki></code>
{{end}}
{{csdoc|usage full}}
: <code><nowiki>{{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=}}</nowiki></code>
{{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.

== 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.}}

Note that if {{para|last}} is used, {{para|author}} is ignored:<br/>
'''<code><nowiki>{{Cite tweet |last=Mabbett |first=Andy |author=Redundant Author Name Ignored |user=Pigsonthewing |number=564068436633214977 |title=This is an example tweet. Hello, Wikipedians! |retweet=Wikimedia Foundation [Wikimedia]}}</nowiki></code>'''
: {{Cite tweet |last=Mabbett |first=Andy |author=Redundant Author Name Ignored |user=Pigsonthewing |number=564068436633214977 |title=This is an example tweet. Hello, Wikipedians! |retweet=Wikimedia Foundation [Wikimedia]}}

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=Mar 21, 2006 }}</nowiki></code>'''
: {{Cite tweet |user=jack |number=20 |title=just setting up my twttr |date=Mar 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!}}
* The tweet URL depends on {{para|user}} and {{para|number}}; if either or both are missing, the URL defaults to <nowiki>https://twitter.com/</nowiki>
* The tweet date depends on {{para|number}} for Tweets posted after November 4, 2010, if the given date parameter is off by more than a day from the calculated date, an error is displayed
* Templates are checked for {{para|ref|harv}}, which is an error. The {{para|ref}} parameter must use {{tl|harvid}} in the value. 
* The template also checks for parameters that are unsupported (e.g. misspellings of parameter names).
* Errors are tracked in [[:Category:Cite tweet templates with errors]]

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"number": {
			"label": "number",
			"description": "Numerical ID of the tweet",
			"type": "number",
			"required": true
		},
		"user": {
			"label": "username",
			"description": "Twitter account name, without the @",
			"type": "string",
			"required": true
		},
		"title": {
			"label": "tweet",
			"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": "author",
			"description": "Author's real name, if known. If not known, then the tweet is probably not an acceptable usage of a self-published source (see [[WP:SPS]])",
			"suggested": true
		},
		"author-link": {
			"aliases": [
				"authorlink"
			],
			"label": "author's article",
			"description": "Title of existing Wikipedia article about the author"
		},
		"retweet": {
			"label": "retweeted by",
			"description": "The reliable source who retweeted the tweet, if the original tweeter is not anyone particularly notable. May be wikilinked."
		},
		"date": {
			"label": "date",
			"description": "date of the tweet; do not wikilink; do not include time."
		},
		"access-date": {
			"aliases": [
				"accessdate"
			],
			"label": "access date",
			"description": "The full date when the tweet was accessed; do not wikilink"
		},
		"language": {
			"label": "language",
			"description": "The language in which the tweet is written, if not in English.",
			"example": "fr",
			"type": "string"
		},
		"location": {
			"label": "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": "string"
		},
		"archive-date": {
			"label": "archive date",
			"aliases": [
				"archivedate"
			],
			"description": "Date when the original URL was archived; do not wikilink",
			"type": "string"
		},
		"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": "script tweet",
			"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:東京タワー"
		},
		"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"
		},
		"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."
		},
		"df": {
			"label": "Date format",
			"description": "Valid values: dmy, dmy-all, mdy, mdy-all, ymd, ymd-all"
		},
		"ref": {
			"label": "Ref",
			"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"
		}
	},
	"description": "A template for citing tweets posted on Twitter",
	"paramOrder": [
		"number",
		"user",
		"title",
		"author",
		"author-link",
		"retweet",
		"date",
		"access-date",
		"language",
		"location",
		"archive-url",
		"archive-date",
		"url-status",
		"script-title",
		"trans-title",
		"link",
		"df",
		"quote",
		"ref"
	]
}
</templatedata>

== Redirects ==
# {{tlx|Cite twitter}}

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

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