View source for Template:YouTube/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE. -->
{{For|the navigation template|Template:YouTube navbox}}
{{See also|Wikipedia:External links/Perennial websites}}
{{Template shortcut|ytl}}
{{Ombox
| type      = content
| textstyle = font-size: 110%;
| text      = '''Do not use this template to link to material that [[WP:External links|violates copyright law]].'''<br />Links to such material must either be replaced with a non-copyvio link or <u>removed immediately</u>.<br>
<small>'''NOTE''': A YouTube video uploaded by a user with a verification check mark badge, indicating that it is an official channel of an established creator or organization, does not fully guarantee that it complies with copyright and [[fair use]] laws.</small>
}}
{{High-use|38420}}
{{COinS safe|n}}

This template is used to create an [[Wikipedia:External links|external link]] to YouTube in the ==External links== section. It may also be used for other YouTube links such as those in {{tl|External media}}. 

'''This is not a [[Wikipedia:Citation templates|citation template]].'''  Use {{tl|cite AV media}} to provide bibliographic citations in footnotes.  Alternatively, use {{tl|cite news}} if the video is a newscast, or {{tl|cite episode}} if the video is in an episodic format.

== Usage and examples ==

=== Video ===
Usage (one parameter):
* <code><nowiki>{{</nowiki>YouTube|''VIDEOID''}}</code>
* <code><nowiki>{{</nowiki>YouTube|id=''VIDEOID''}}</code>

Usage (two parameters):
* <code><nowiki>{{</nowiki>YouTube|''VIDEOID''|''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|id=''VIDEOID''|title=''TITLE''}}</code>

Parameter descriptions:
* ''id'' (or unnamed parameter 1) is the "YouTube video id" which appears as:
*: <kbd><span style="color:darkblue"><nowiki>https://www.youtube.com/watch?v=</nowiki>{{hilite|''VIDEOID''}}</span></kbd>
* ''title'' (or unnamed parameter 2) gives an optional description that may replace the default title (Video)

Examples (1 parameter):
: <kbd>[https://www.youtube.com/watch?v=9bZkp7q19f0 https://www.youtube.com/watch?v={{hilite|9bZkp7q19f0}}]</kbd>
# <code><nowiki>* {{</nowiki>YouTube|9bZkp7q19f0}}</code>
#* {{YouTube|9bZkp7q19f0}}
# <code><nowiki>* {{</nowiki>YouTube|id=9bZkp7q19f0}}</code>
#* {{YouTube|id=9bZkp7q19f0}}

Examples (2 parameters):
# <code><nowiki>* {{</nowiki>YouTube|9bZkp7q19f0|"Gangnam Style"}}</code>
#* {{YouTube|9bZkp7q19f0|"Gangnam Style"}}
# <code><nowiki>* {{</nowiki>YouTube|id=9bZkp7q19f0|title="Gangnam Style"}}</code>
#* {{YouTube|id=9bZkp7q19f0|title="Gangnam Style"}}

==== With timestamp ====
Usage:
* <code><nowiki>{{</nowiki>YouTube|id=''VIDEOID''|time=''TIMESTAMP''}}</code>
* <code><nowiki>{{</nowiki>YouTube|id=''VIDEOID''|t=''TIMESTAMP''}}</code>

Parameter descriptions:
* ''time'' or ''t'' is the timestamp within the video for the link target.

Examples:
* <code><nowiki>{{</nowiki>YouTube|id=9bZkp7q19f0|time=3m2s}}</code>
* <code><nowiki>{{</nowiki>YouTube|id=9bZkp7q19f0|time=122}}</code>
* <code><nowiki>{{</nowiki>YouTube|id=9bZkp7q19f0|t=3m2s}}</code>

=== Channel ===
==== With username ====
Usage (one parameter):
* <code><nowiki>{{</nowiki>YouTube|u=''USERNAME''}}</code>
* <code><nowiki>{{</nowiki>YouTube|user=''USERNAME''}}</code>

Usage (two parameters):
* <code><nowiki>{{</nowiki>YouTube|u=''USERNAME''|''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|u=''USERNAME''|title=''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|user=''USERNAME''|''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|user=''USERNAME''|title=''TITLE''}}</code>

Parameter descriptions:
* ''u'' or ''user'' is the "YouTube user's (channel) name" which appears as:
*: <kbd><span style="color:darkblue"><nowiki>https://www.youtube.com/user/</nowiki>{{hilite|''USERNAME''}}</span></kbd>
* ''title'' gives an optional description that may replace the default title (PAGENAME)
* ''suffix'' replaces the default " 's " after the channel name. It is only to be used in the rare occasion that the channel name is a compound noun ending in S, and making it possessive does not repeat the S sound. Do not use it for a brand name ending in S, for example Smosh Games, which is a singular entity. See [[MOS:POSS]] for more information.

Examples (1 parameter):
: <kbd>[https://www.youtube.com/user/pewdiepie https://www.youtube.com/user/{{hilite|pewdiepie}}]</kbd>
# <code><nowiki>* {{</nowiki>YouTube|u=pewdiepie}}</code>
#* {{YouTube|u=pewdiepie|PAGENAME}}
# <code><nowiki>* {{</nowiki>YouTube|user=pewdiepie}}</code>
#* {{YouTube|user=pewdiepie|PAGENAME}}

Example (2 parameters):
# <code><nowiki>* {{</nowiki>YouTube|u=pewdiepie|PewDiePie}}</code>
#* {{YouTube|u=pewdiepie|PewDiePie}}
# <code><nowiki>* {{</nowiki>YouTube|user=pewdiepie|title=PewDiePie}}</code>
#* {{YouTube|user=pewdiepie|title=PewDiePie}}

Example (3 parameters):
: <kbd>[https://www.youtube.com/user/officialBEG https://www.youtube.com/user/{{hilite|officialBEG}}]</kbd>
# <code><nowiki>* {{</nowiki>YouTube|user=officialBEG|title=Brown Eyed Girls|suffix='}}</code>
#* {{YouTube|user=officialBEG|title=Brown Eyed Girls|suffix='}}

==== With channel ID ====
Usage (one parameter):
* <code><nowiki>{{</nowiki>YouTube|c=''CHANNELID''}}</code>
* <code><nowiki>{{</nowiki>YouTube|channel=''CHANNELID''}}</code>

Usage (two parameters):
* <code><nowiki>{{</nowiki>YouTube|c=''CHANNELID''|''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|c=''CHANNELID''|title=''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|channel=''CHANNELID''|''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|channel=''CHANNELID''|title=''TITLE''}}</code>

Parameter descriptions:
* ''c'' or ''channel'' is the "YouTube channel id" which appears as:
*: <kbd><span style="color:darkblue"><nowiki>https://www.youtube.com/channel/</nowiki>{{hilite|''CHANNELID''}}</span></kbd>
* ''title'' gives an optional description that may replace the default title (PAGENAME)

Examples (1 parameter):
: <kbd>[https://www.youtube.com/channel/UC-9-kyTW8ZkZNDHQJ6FgpwQ https://www.youtube.com/channel/{{hilite|UC-9-kyTW8ZkZNDHQJ6FgpwQ}}]</kbd>
# <code><nowiki>* {{</nowiki>YouTube|c=UC-9-kyTW8ZkZNDHQJ6FgpwQ}}</code>
#* {{YouTube|c=UC-9-kyTW8ZkZNDHQJ6FgpwQ|PAGENAME}}
# <code><nowiki>* {{</nowiki>YouTube|channel=UC-9-kyTW8ZkZNDHQJ6FgpwQ}}</code>
#* {{YouTube|channel=UC-9-kyTW8ZkZNDHQJ6FgpwQ|PAGENAME}}

Example (2 parameters):
# <code><nowiki>* {{</nowiki>YouTube|c=UC-9-kyTW8ZkZNDHQJ6FgpwQ|#Music}}</code>
#: {{YouTube|c=UC-9-kyTW8ZkZNDHQJ6FgpwQ|#Music}}
# <code><nowiki>* {{</nowiki>YouTube|channel=UC-9-kyTW8ZkZNDHQJ6FgpwQ|title=#Music}}</code>
#* {{YouTube|channel=UC-9-kyTW8ZkZNDHQJ6FgpwQ|title=#Music}}

==== With custom URL ====
{{Wikidata property|P2397}}
Usage (one parameter):
* <code><nowiki>{{</nowiki>YouTube|custom=''CUSTOMURL''}}</code>

Usage (two parameters):
* <code><nowiki>{{</nowiki>YouTube|custom=''CUSTOMURL''|''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|custom=''CUSTOMURL''|title=''TITLE''}}</code>

Parameter descriptions:
* ''custom'' is the "YouTube custom URL" which appears as:
*: <kbd><span style="color:darkblue"><nowiki>https://www.youtube.com/c/</nowiki>{{hilite|''CUSTOMURL''}}</span></kbd>
* ''title'' gives an optional description that may replace the default title (PAGENAME)

Example (1 parameter):
: <kbd>[https://www.youtube.com/c/officialBEG https://www.youtube.com/c/{{hilite|officialBEG}}]</kbd>
# <code><nowiki>* {{</nowiki>YouTube|custom=officialBEG}}</code>
#* {{YouTube|custom=officialBEG|PAGENAME}}

Example (2 parameters):
# <code><nowiki>* {{</nowiki>YouTube|custom=officialBEG|Brown Eyed Girls}}</code>
#: {{YouTube|custom=officialBEG|Brown Eyed Girls}}

=== Show ===
Usage (one parameter):
* <code><nowiki>{{</nowiki>YouTube|s=''SHOWNAME''}}</code>
* <code><nowiki>{{</nowiki>YouTube|show=''SHOWNAME''}}</code>

Usage (two parameters):
* <code><nowiki>{{</nowiki>YouTube|s=''SHOWNAME''|''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|s=''SHOWNAME''|title=''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|show=''SHOWNAME''|''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|show=''SHOWNAME''|title=''TITLE''}}</code>

Parameter descriptions:
* ''s'' or ''show'' is the "YouTube show name" which appears as:
*: <kbd><span style="color:darkblue"><nowiki>https://www.youtube.com/show/</nowiki>{{hilite|''SHOWNAME''}}</span></kbd>
* ''title'' gives an optional description that may replace the default title (''PAGENAME'')

Examples (1 parameter):
: <kbd>[https://www.youtube.com/show/startrek https://www.youtube.com/show/{{hilite|startrek}}]</kbd>
# <code><nowiki>* {{</nowiki>YouTube|s=startrek}}</code>
#* {{YouTube|s=startrek|''PAGENAME''}}
# <code><nowiki>* {{</nowiki>YouTube|show=startrek}}</code>
#* {{YouTube|show=startrek|''PAGENAME''}}

Example (2 parameters):
# <code><nowiki>* {{</nowiki>YouTube|s=startrek|''Star Trek: The Original Series''}}</code>
#* {{YouTube|s=startrek|''Star Trek: The Original Series''}}
# <code><nowiki>* {{</nowiki>YouTube|show=startrek|title=''Star Trek: The Original Series''}}</code>
#* {{YouTube|show=startrek|title=''Star Trek: The Original Series''}}

=== Playlist ===
{{Wikidata property|P4300}}
Usage (one parameter):
* <code><nowiki>{{</nowiki>YouTube|p=''PLAYLISTID''}}</code>
* <code><nowiki>{{</nowiki>YouTube|playlist=''PLAYLISTID''}}</code>

Usage (two parameters):
* <code><nowiki>{{</nowiki>YouTube|p=''PLAYLISTID''|''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|p=''PLAYLISTID''|title=''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|playlist=''PLAYLISTID''|''TITLE''}}</code>
* <code><nowiki>{{</nowiki>YouTube|playlist=''PLAYLISTID''|title=''TITLE''}}</code>

Parameter descriptions:
* ''p'' or ''playlist'' is the "YouTube playlist id" which appears as:
*: <kbd><span style="color:darkblue"><nowiki>https://www.youtube.com/playlist?list=</nowiki>{{hilite|''PLAYLISTID''}}</span></kbd>
* ''title'' gives an optional description that may replace the default title (PAGENAME)

Examples (1 parameter):
: <kbd>[https://www.youtube.com/playlist?list=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE https://www.youtube.com/playlist?list={{hilite|PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE}}]</kbd>
# <code><nowiki>* {{</nowiki>YouTube|p=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE}}</code>
#* {{YouTube|p=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE|PAGENAME}}
# <code><nowiki>* {{</nowiki>YouTube|playlist=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE}}</code>
#* {{YouTube|playlist=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE|PAGENAME}}

Example (2 parameters):
# <code><nowiki>* {{</nowiki>YouTube|p=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE|Learn Something New}}</code>
#* {{YouTube|playlist=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE|Learn Something New}}
# <code><nowiki>* {{</nowiki>YouTube|playlist=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE|title=Learn Something New}}</code>
#* {{YouTube|playlist=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE|title=Learn Something New}}

=== Suppress wikilink ===
The link to [[YouTube]] can be suppressed with the parameter {{Para|link|no}}. Example:
: <code><nowiki>* {{</nowiki>YouTube|9bZkp7q19f0|"PSY - GANGNAM STYLE(강남스타일) M/V"|link=no}}</code>
:* {{YouTube|9bZkp7q19f0|"PSY - GANGNAM STYLE(강남스타일) M/V"|link=no}}

=== No ID in template ===
The template will display an error message if no parameters are provided.
: {{tlc|a=1|{{BASEPAGENAME}}}}
:* {{{{BASEPAGENAME}}<!-- -->}}
It will display an error message if the parameter provided is not known.
: {{tlc|a=1|{{BASEPAGENAME}}|ID{{=}}test}}
:* {{{{BASEPAGENAME}}|ID=test}}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"description": "Use this to create an external link to YouTube in the External links section. This is not a citation template.",
	"params": {
		"id": {
			"label": "YouTube video id",
			"description": "The video id which appears after https://www.youtube.com/watch?v= in the URL",
			"aliases": [
				"1"
			],
			"example": "9bZkp7q19f0",
			"type": "string",
			"suggested": true
		},
		"user": {
			"label": "YouTube user's (channel) name",
			"description": "The user name which appears after https://www.youtube.com/user/ in the URL",
			"aliases": [
				"u"
			],
			"example": "pewdiepie",
			"type": "string"
		},
		"channel": {
			"label": "YouTube channel id",
			"description": "The channel id which appears after https://www.youtube.com/channel/ in the URL",
			"aliases": [
				"c"
			],
			"example": "UC-9-kyTW8ZkZNDHQJ6FgpwQ",
			"type": "string"
		},
		"show": {
			"label": "YouTube show name",
			"description": "The show name which appears after https://www.youtube.com/show/ in the URL",
			"aliases": [
				"s"
			],
			"example": "startrek",
			"type": "string"
		},
		"playlist": {
			"label": "YouTube playlist id",
			"description": "The playlist id which appears after https://www.youtube.com/playlist?list= in the URL",
			"aliases": [
				"p"
			],
			"example": "PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE",
			"type": "string"
		},
		"title": {
			"label": "Title",
			"description": "The name of the page being linked to",
			"suggested": true,
			"aliases": [
				"2"
			],
			"example": "Gangnam Style",
			"default": "If it is a video, Video, if it is a show, the article's page name in italics, otherwise, the article's page name unformatted",
			"type": "string"
		},
		"suffix": {
			"label": "Channel title suffix",
			"description": "Text immediately after the channel title. It is only to be used in the rare occasion that the channel title is a compound noun ending in S, and making it possessive does not repeat the S sound.",
			"example": "'",
			"default": "'s",
			"type": "string"
		},
		"link": {
			"label": "Link on",
			"description": "Set this parameter to no to suppress the link to the YouTube article",
			"example": "no",
			"type": "string"
		},
		"time": {
			"aliases": [
				"t"
			],
			"label": "Timestamp",
			"description": "The timestamp within the video for the link target; usually appears after &t= in the full URL or ?t= in a shortened URL",
			"example": "3m2s",
			"type": "string"
		},
		"custom": {
			"label": "YouTube channel custom URL fragment slug",
			"description": "The channel custom URL slug which appears after https://www.youtube.com/c/ in the URL",
			"example": "youtube",
			"type": "string"
		}
	},
	"paramOrder": [
		"id",
		"time",
		"user",
		"channel",
		"custom",
		"show",
		"playlist",
		"title",
		"suffix",
		"link"
	],
	"format": "inline"
}</templatedata>

== Tracking categories ==
* {{clc|Articles using YouTube with invalid parameters}} – list of pages using this template with too many parameters, or with invalid text in the {{para|title}} parameter.
* {{clc|Pages using YouTube with unknown parameters}} – list of pages using this template with unsupported parameters

== See also ==
* {{Tl|External media}} – to link to external media, including YouTube videos
* {{Tl|Cite AV media}} – to cite a video
* {{Tl|Cite news}} – to cite a newscast
* {{Tl|Cite episode}} – to cite an episode of a show
* {{Tl|Cite serial}} – to cite a serial of a show
* {{Tl|YouTube navbox}} – navigation box for YouTube related articles
* [[WP:YOUTUBE]] – YouTube linking guideline
* [[Wikipedia:WikiProject Internet culture]] – Wikiproject covering YouTube personalities and videos
* All Wikipedia pages linked <span class="plainlinks">[https://en.wikipedia.org/w/index.php?title=Special:LinkSearch&target=http%3A%2F%2F*.youtube.com&limit=500&offset=0 to http://*.youtube.com] and [https://en.wikipedia.org/w/index.php?title=Special%3ALinkSearch&target=https%3A%2F%2F*.youtube.com to https://*.youtube.com]</span>
* <span class="plainlinks">[https://en.wikipedia.org/w/index.php?search=insource%3A%2F%3E%5C%7B%5C%7BYouTube%2Fi Search for Wikipedia articles using this template as a reference]</span>

<includeonly>{{Basepage subpage|
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Google templates]]
[[Category:Social media external link templates]]
[[Category:Television external link templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>