Template:YouTube/doc: Difference between revisions

Template:YouTube/doc (view source)

Revision as of 19:41, 13 November 2012

1,102 bytes added , 13 November 2012

no edit summary

Mbc07

Administrators

15,188

edits

@@ Line 3: / Line 3: @@
 ==Usage==
 The YouTube template should be called in the following way:
-*<code><nowiki>{{YouTube|<videoID>|<title>|<new row?>}}</nowiki></code>
+*<code><nowiki>{{YouTube|<videoID>|<title>|<options>}}</nowiki></code>
 where
 *<code>Video ID</code> is the ID is the bold part of the URL (<nowiki>http://www.youtube.com/watch?v=</nowiki>'''VqNcksMfAjM''')
 *<code>Title</code> (optional) is the caption for the video
-*<code>new row?</code> (optional) should always be <code>br</code> when used. This parameter tell the template if it should create a new row or not.
+*<code>options</code> (optional) control some other functionalities of this template. Specifying <code>br</code> in this parameter tell the template to create a new row after embedding the video. Specifying <code>link</code> makes the template return only a hiperlink to watch the video on YouTube.
 ==Examples==
-* Specifying video ID and title. Titles longer than the box will automatically be truncated. We are embedding only one video, so we should add the <code>br</code> tag to the 3rd parameter. In this example, <code><nowiki>{{YouTube|VqNcksMfAjM|The Legend of Zelda: The Wind Waker Intro with title longer than box|br}}</nowiki></code> will produce this:
+* Embed a video by specifying video ID and title. Titles longer than the box will automatically be truncated. We are embedding only one video, so we should add the <code>br</code> tag to the 3rd parameter. In this example, <code><nowiki>{{YouTube|VqNcksMfAjM|The Legend of Zelda: The Wind Waker Intro with title longer than box|br}}</nowiki></code> will produce this:
 {{YouTube|VqNcksMfAjM|The Legend of Zelda: The Wind Waker Intro with title longer than box|br}}
-* Specifying only video ID. We are embedding only one video, so we should add the <code>br</code> tag to the 3rd parameter. In this example, <code><nowiki>{{YouTube|VqNcksMfAjM||br}}</nowiki></code> make the template use URL as title since no title was entered:
+* Embed a video by specifying only video ID, so the 2nd parameter is null. We are embedding only one video, so we should add the <code>br</code> tag to the 3rd parameter. In this example, <code><nowiki>{{YouTube|VqNcksMfAjM||br}}</nowiki></code> make the template use URL as title since no title was entered:
 {{YouTube|VqNcksMfAjM||br}}
+* Return a hiperlink to watch the video on YouTube by specifying video ID and title. We want only the hiperlink, so we should add the <code>link</code> tag to the 3rd parameter. In this example, <code><nowiki>{{YouTube|VqNcksMfAjM|The Legend of Zelda: The Wind Waker Intro|link}}</nowiki></code> will produce this:
+{{YouTube|VqNcksMfAjM|The Legend of Zelda: The Wind Waker Intro|link}}
+* Return a hiperlink to watch the video on YouTube by specifying only video ID. We want only the hiperlink, so we should add the <code>link</code> tag to the 3rd parameter. In this example, <code><nowiki>{{YouTube|VqNcksMfAjM||link}}</nowiki></code> make the template use URL as title since no title was entered:
+{{YouTube|VqNcksMfAjM||link}}
 ==Notes==
+* To use only video ID and an option, you must null the 2nd parameter by using ||, like this: <code><nowiki>{{YouTube|<videoID>||<options>}}</nowiki></code>
 * Using multiple calls will make the videos be side-by-side (the last video should ALWAYS include the <code>br</code> tag to the 3rd parameter):
 {{YouTube|VqNcksMfAjM|The Legend of Zelda: The Wind Waker Intro}}