Template:YouTube: Difference between revisions

Browse history interactively

← Previous edit Next edit →

Content deleted Content added

VisualWikitext

Inline

Revision as of 14:31, 20 September 2011

Video on YouTube

Template documentation[view] [edit] [history] [purge]

Shortcut

{{ytl}}

Do not use this template to link to material that violates copyright law.
Links to such material must either be replaced with a non-copyvio link or removed immediately.
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.

This template is used on approximately 67,000 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 should not be used in citation templates such as Citation Style 1 and Citation Style 2, because it includes markup that will pollute the COinS metadata they produce; see Wikipedia:COinS.

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

This is not a citation template. Use {{cite AV media}} to provide bibliographic citations in footnotes. Alternatively, use {{cite news}} if the video is a newscast, or {{cite episode}} if the video is in an episodic format.

Note that this template makes it clear that it "has" various Wikidata property elements, it does not automatically "use" the information stored in Wikidata – the VIDEOID, CHANNELID, HANDLE, USERNAME, SHOWID or PLAYLISTID alphanumeric parameters mentioned below must be entered by hand in the template.

Usage and examples

Video

Usage (one parameter):

{{YouTube|VIDEOID}}
{{YouTube|id=VIDEOID}}

Usage (two parameters):

{{YouTube|VIDEOID|TITLE}}
{{YouTube|id=VIDEOID|title=TITLE}}

Parameter descriptions:

id (or unnamed parameter 1) is the "YouTube video id" which appears as:
https://www.youtube.com/watch?v=VIDEOID
title (or unnamed parameter 2) gives an optional description that may replace the default title (Video)

Examples (1 parameter):

https://www.youtube.com/watch?v=9bZkp7q19f0

* {{YouTube|9bZkp7q19f0}}
- Video on YouTube
* {{YouTube|id=9bZkp7q19f0}}
- Video on YouTube

Examples (2 parameters):

* {{YouTube|9bZkp7q19f0|"Gangnam Style"}}
- "Gangnam Style" on YouTube
* {{YouTube|id=9bZkp7q19f0|title="Gangnam Style"}}
- "Gangnam Style" on YouTube

With timestamp

Usage:

{{YouTube|id=VIDEOID|time=TIMESTAMP}}
{{YouTube|id=VIDEOID|t=TIMESTAMP}}

Parameter descriptions:

time or t is the timestamp within the video for the link target.

Examples:

{{YouTube|id=9bZkp7q19f0|time=3m2s}}
{{YouTube|id=9bZkp7q19f0|time=122}}
{{YouTube|id=9bZkp7q19f0|t=3m2s}}

Channel

With channel ID

Usage (one parameter):

{{YouTube|c=CHANNELID}}
{{YouTube|channel=CHANNELID}}

Usage (two parameters):

{{YouTube|c=CHANNELID|TITLE}}
{{YouTube|c=CHANNELID|title=TITLE}}
{{YouTube|channel=CHANNELID|TITLE}}
{{YouTube|channel=CHANNELID|title=TITLE}}

Parameter descriptions:

c or channel is the "YouTube channel id" which appears as:
https://www.youtube.com/channel/CHANNELID
title gives an optional description that may replace the default title (PAGENAME)

Examples (1 parameter):

https://www.youtube.com/channel/UC-9-kyTW8ZkZNDHQJ6FgpwQ

* {{YouTube|c=UC-9-kyTW8ZkZNDHQJ6FgpwQ}}
- Video on YouTube
* {{YouTube|channel=UC-9-kyTW8ZkZNDHQJ6FgpwQ}}
- PAGENAME's channel on YouTube

Example (2 parameters):

* {{YouTube|c=UC-9-kyTW8ZkZNDHQJ6FgpwQ|#Music}}
Video on YouTube
* {{YouTube|channel=UC-9-kyTW8ZkZNDHQJ6FgpwQ|title=#Music}}
- #Music's channel on YouTube

With handle

Usage (one parameter):

{{YouTube|h=HANDLE}}
{{YouTube|handle=HANDLE}}

Usage (two parameters):

{{YouTube|h=HANDLE|TITLE}}
{{YouTube|h=HANDLE|title=TITLE}}
{{YouTube|handle=HANDLE|TITLE}}
{{YouTube|handle=HANDLE|title=TITLE}}

Parameter descriptions:

h or handle is the "YouTube channel handle" which appears as:
https://www.youtube.com/@HANDLE
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):

https://www.youtube.com/@PewDiePie

* {{YouTube|h=PewDiePie}}
- Video on YouTube
* {{YouTube|handle=PewDiePie}}
- Video on YouTube

Example (2 parameters):

* {{YouTube|h=PewDiePie|PewDiePie}}
- Video on YouTube
* {{YouTube|handle=PewDiePie|title=PewDiePie}}
- PewDiePie on YouTube

Example (3 parameters):

https://www.youtube.com/@officialBEG

* {{YouTube|handle=officialBEG|title=Brown Eyed Girls|suffix='}}
- Brown Eyed Girls on YouTube

With legacy username

legacy username is deprecated in favor of handle by YouTube

Usage (one parameter):

{{YouTube|u=USERNAME}}
{{YouTube|user=USERNAME}}

Usage (two parameters):

{{YouTube|u=USERNAME|TITLE}}
{{YouTube|u=USERNAME|title=TITLE}}
{{YouTube|user=USERNAME|TITLE}}
{{YouTube|user=USERNAME|title=TITLE}}

Parameter descriptions:

u or user is the "YouTube channel user's name" which appears as:
https://www.youtube.com/user/USERNAME
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):

https://www.youtube.com/user/pewdiepie

* {{YouTube|u=pewdiepie}}
- PAGENAME's channel on YouTube
* {{YouTube|user=pewdiepie}}
- PAGENAME's channel on YouTube

Example (2 parameters):

* {{YouTube|u=pewdiepie|PewDiePie}}
- PewDiePie's channel on YouTube
* {{YouTube|user=pewdiepie|title=PewDiePie}}
- PewDiePie's channel on YouTube

Example (3 parameters):

https://www.youtube.com/user/officialBEG

* {{YouTube|user=officialBEG|title=Brown Eyed Girls|suffix='}}
- Brown Eyed Girls's channel on YouTube

With custom URL

custom URL is deprecated in favor of handle by YouTube

Usage (one parameter):

{{YouTube|custom=CUSTOMURL}}

Usage (two parameters):

{{YouTube|custom=CUSTOMURL|TITLE}}
{{YouTube|custom=CUSTOMURL|title=TITLE}}

Parameter descriptions:

custom is the "YouTube channel custom URL" which appears as:
https://www.youtube.com/c/CUSTOMURL
title gives an optional description that may replace the default title (PAGENAME)

Example (1 parameter):

https://www.youtube.com/c/officialBEG

* {{YouTube|custom=officialBEG}}
- Video on YouTube

Example (2 parameters):

* {{YouTube|custom=officialBEG|Brown Eyed Girls}}
Eyed Girls Video on YouTube

Show

Usage (one parameter):

{{YouTube|s=SHOWID}}
{{YouTube|show=SHOWID}}

Usage (two parameters):

{{YouTube|s=SHOWID|TITLE}}
{{YouTube|s=SHOWID|title=TITLE}}
{{YouTube|show=SHOWID|TITLE}}
{{YouTube|show=SHOWID|title=TITLE}}

Parameter descriptions:

s or show is the "YouTube show name" which appears as:
https://www.youtube.com/show/SHOWID
title gives an optional description that may replace the default title (PAGENAME)

Examples (1 parameter):

https://www.youtube.com/show/SCWdVLvom3QaFGxEKNASntaA

* {{YouTube|s=SCWdVLvom3QaFGxEKNASntaA}}
- PAGENAME show on YouTube
* {{YouTube|show=SCWdVLvom3QaFGxEKNASntaA}}
- PAGENAME show on YouTube

Example (2 parameters):

* {{YouTube|s=SCWdVLvom3QaFGxEKNASntaA|Star Trek: The Original Series}}
- Star Trek: The Original Series show on YouTube
* {{YouTube|show=SCWdVLvom3QaFGxEKNASntaA|title=Star Trek: The Original Series}}
- Star Trek: The Original Series show on YouTube

Playlist

Usage (one parameter):

{{YouTube|p=PLAYLISTID}}
{{YouTube|playlist=PLAYLISTID}}

Usage (two parameters):

{{YouTube|p=PLAYLISTID|TITLE}}
{{YouTube|p=PLAYLISTID|title=TITLE}}
{{YouTube|playlist=PLAYLISTID|TITLE}}
{{YouTube|playlist=PLAYLISTID|title=TITLE}}

Parameter descriptions:

p or playlist is the "YouTube playlist id" which appears as:
https://www.youtube.com/playlist?list=PLAYLISTID
title gives an optional description that may replace the default title (PAGENAME)

Examples (1 parameter):

https://www.youtube.com/playlist?list=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE

* {{YouTube|p=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE}}
- Video on YouTube
* {{YouTube|playlist=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE}}
- Video on YouTube

Example (2 parameters):

* {{YouTube|p=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE|Learn Something New}}
- Something New Video on YouTube
* {{YouTube|playlist=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE|title=Learn Something New}}
- Learn Something New on YouTube

Suppress wikilink

The link to YouTube can be suppressed with the parameter |link=no. Example:

* {{YouTube|9bZkp7q19f0|"PSY - GANGNAM STYLE(강남스타일) M/V"|link=no}}

"PSY - GANGNAM STYLE(강남스타일) M/V" on YouTube

No ID in template

The template will display an error message if no parameters are provided.

* {{YouTube}}

Video on YouTube

It will display an error message if the parameter provided is not known.

* {{YouTube|ID=test}}

Video on YouTube

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:YouTube in articles based on its TemplateData.

TemplateData for YouTube

Use this to create an external link to YouTube in the External links section. This is not a citation template.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
YouTube video id	`id` `1`	The video id which appears after https://www.youtube.com/watch?v= in the URL Example 9bZkp7q19f0	String	suggested
Timestamp	`time` `t`	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	String	optional
YouTube channel id	`channel` `c`	The channel id which appears after https://www.youtube.com/channel/ in the URL Example UC-9-kyTW8ZkZNDHQJ6FgpwQ	String	suggested
YouTube channel handle	`handle` `h`	The user name which appears after https://www.youtube.com/@ in the URL Example PewDiePie	String	optional
YouTube legacy username	`user` `u`	The user name which appears after https://www.youtube.com/user/ in the URL Example pewdiepie	String	optional
YouTube channel custom URL fragment slug	`custom`	The channel custom URL slug which appears after https://www.youtube.com/c/ in the URL Example youtube	String	optional
YouTube show id	`show` `s`	The show id which appears after https://www.youtube.com/show/ in the URL Example SCWdVLvom3QaFGxEKNASntaA	String	suggested
YouTube playlist id	`playlist` `p`	The playlist id which appears after https://www.youtube.com/playlist?list= in the URL Example PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE	String	suggested
Title	`title` `2`	The name of the page being linked to 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 Example Gangnam Style	String	suggested
Channel title suffix	`suffix`	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. Default 's Example '	String	optional
Link on	`link`	Set this parameter to no to suppress the link to the YouTube article Example no	String	optional

Tracking categories

Category:Articles using YouTube with invalid parameters (57) – list of pages using this template with too many parameters, or with invalid text in the |title= parameter.
Category:Pages using YouTube with unknown parameters (0) – list of pages using this template with unsupported parameters.

@@ Line 1: / Line 1: @@
 [http://www.youtube.com/{{#if:{{{user|{{{u|{{{channel|}}}}}}}}}
- |user/{{{user|{{{u|{{{channel|}}}}}}}}} {{{title|{{#if:{{{1|}}}|{{{1}}}|{{PAGENAME}}}}}}} channel]
+ |user/{{{user|{{{u|{{{channel|}}}}}}}}} {{{title|{{#if:{{{1|}}}|{{{1}}}|{{PAGENAME}}}}}}}'s channel]
  |{{#if:{{{s|{{{show|}}}}}}
   |show/{{{s|{{{show|}}}}}} {{{title|{{#if:{{{1|}}}|{{{1}}}|''{{PAGENAME}}''}}}}}] show

Revision as of 14:31, 20 September 2011

Usage and examples

Video

With timestamp

Channel

With channel ID

With handle

With legacy username

With custom URL

Show

Playlist

Suppress wikilink

No ID in template

TemplateData

Tracking categories

See also