Template:YouTube/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

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.

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
  1. * {{YouTube|9bZkp7q19f0}}
  2. * {{YouTube|id=9bZkp7q19f0}}

Examples (2 parameters):

  1. * {{YouTube|9bZkp7q19f0|"Gangnam Style"}}
  2. * {{YouTube|id=9bZkp7q19f0|title="Gangnam Style"}}

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
  1. * {{YouTube|c=UC-9-kyTW8ZkZNDHQJ6FgpwQ}}
  2. * {{YouTube|channel=UC-9-kyTW8ZkZNDHQJ6FgpwQ}}

Example (2 parameters):

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

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
  1. * {{YouTube|h=PewDiePie}}
  2. * {{YouTube|handle=PewDiePie}}

Example (2 parameters):

  1. * {{YouTube|h=PewDiePie|PewDiePie}}
  2. * {{YouTube|handle=PewDiePie|title=PewDiePie}}

Example (3 parameters):

https://www.youtube.com/@officialBEG
  1. * {{YouTube|handle=officialBEG|title=Brown Eyed Girls|suffix='}}

With username

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
  1. * {{YouTube|u=pewdiepie}}
  2. * {{YouTube|user=pewdiepie}}

Example (2 parameters):

  1. * {{YouTube|u=pewdiepie|PewDiePie}}
  2. * {{YouTube|user=pewdiepie|title=PewDiePie}}

Example (3 parameters):

https://www.youtube.com/user/officialBEG
  1. * {{YouTube|user=officialBEG|title=Brown Eyed Girls|suffix='}}

With custom URL

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
  1. * {{YouTube|custom=officialBEG}}

Example (2 parameters):

  1. * {{YouTube|custom=officialBEG|Brown Eyed Girls}}
    Brown Eyed Girls's channel 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
  1. * {{YouTube|s=SCWdVLvom3QaFGxEKNASntaA}}
  2. * {{YouTube|show=SCWdVLvom3QaFGxEKNASntaA}}

Example (2 parameters):

  1. * {{YouTube|s=SCWdVLvom3QaFGxEKNASntaA|Star Trek: The Original Series}}
  2. * {{YouTube|show=SCWdVLvom3QaFGxEKNASntaA|title=Star Trek: The Original Series}}

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
  1. * {{YouTube|p=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE}}
  2. * {{YouTube|playlist=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE}}

Example (2 parameters):

  1. * {{YouTube|p=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE|Learn Something New}}
  2. * {{YouTube|playlist=PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE|title=Learn Something New}}

Suppress wikilink

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

* {{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.

* {{YouTube}}

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

* {{YouTube|ID=test}}

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

<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 }, "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", "suggested": true }, "handle": { "label": "YouTube channel handle", "description": "The user name which appears after https://www.youtube.com/@ in the URL", "aliases": [ "h" ], "example": "PewDiePie", "type": "string" }, "user": { "label": "YouTube channel user's name", "description": "The user name which appears after https://www.youtube.com/user/ in the URL", "aliases": [ "u" ], "example": "pewdiepie", "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" }, "show": { "label": "YouTube show id", "description": "The show id which appears after https://www.youtube.com/show/ in the URL", "aliases": [ "s" ], "example": "SCWdVLvom3QaFGxEKNASntaA", "type": "string", "suggested": true }, "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", "suggested": true }, "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" } }, "paramOrder": [ "id", "time", "channel", "handle", "user", "custom", "show", "playlist", "title", "suffix", "link" ], "format": "inline" }</templatedata>

Tracking categories

See also