Template:YouTube/doc

From HandWiki
< Template:YouTube
Revision as of 20:22, 10 November 2019 by imported>Jworkorg (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
For the navigation template, see Template:YouTube navbox.
See also: Wikipedia:External links/Perennial websites

Error: no shortcuts were specified and the |msg= parameter was not set.

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


User's channel

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 user's (channel) 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='}}

Channel

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

Show

Usage (one parameter):

  • {{YouTube|s=SHOWNAME}}
  • {{YouTube|show=SHOWNAME}}

Usage (two parameters):

  • {{YouTube|s=SHOWNAME|TITLE}}
  • {{YouTube|s=SHOWNAME|title=TITLE}}
  • {{YouTube|show=SHOWNAME|TITLE}}
  • {{YouTube|show=SHOWNAME|title=TITLE}}

Parameter descriptions:

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

Examples (1 parameter):

https://www.youtube.com/show/startrek
  1. * {{YouTube|s=startrek}}
  2. * {{YouTube|show=startrek}}

Example (2 parameters):

  1. * {{YouTube|s=startrek|Star Trek: The Original Series}}
  2. * {{YouTube|show=startrek|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. Click here to see a monthly parameter usage report for this template in articles based on this 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

ParameterDescriptionTypeStatus
YouTube video idid 1

The video id which appears after https://www.youtube.com/watch?v= in the URL

Example
9bZkp7q19f0
Stringoptional
YouTube user's (channel) nameuser u

The user name which appears after https://www.youtube.com/user/ in the URL

Example
pewdiepie
Stringoptional
YouTube channel idchannel c

The channel id which appears after https://www.youtube.com/channel/ in the URL

Example
UC-9-kyTW8ZkZNDHQJ6FgpwQ
Stringoptional
YouTube show nameshow s

The show name which appears after https://www.youtube.com/show/ in the URL

Example
startrek
Stringoptional
YouTube playlist idplaylist p

The playlist id which appears after https://www.youtube.com/playlist?list= in the URL

Example
PLrEnWoR732-DZV1Jc8bUpVTF_HTPbywpE
Stringoptional
Titletitle 1 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
Stringsuggested
Channel title suffixsuffix

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
'
Stringoptional
Link onlink

Set this parameter to no to suppress the link to the YouTube article

Example
no
Stringoptional

Tracking categories

See also

Retrieved from "https://handwiki.org/wiki/index.php?title=Template:YouTube/doc&oldid=4684"