Template:Rip/doc


 * Description
 * This is a infobox for articles about rips. To other types of videos, see Template:Video. An automatic generator for this infobox can be found at Thread:29615 and Thread:17320.


 * Changes
 * This template is used on thousands of pages, and any changes to it must be approved by an administrator or content moderator after a thorough review. Changes should be tested using Template:Rip/sandbox.

Usage

 * See also: Thread:29615, Thread:17320 and Template:D
 * Place the following code on page about a rip.


 * Full syntax

All of the following parameters are optional, but some parameters will only appear if other parameters are also valid:
 * Basic parameters
 * image= The thumbnail image of the rip. Do not include the File: prefix.
 * link= The YouTube URL of the rip. It can also be a raw video ID.1
 * playlist= The playlist(s) of the rip. It should be the name of a category on the channel.1.
 * Multiple playlists can be listed with the delimiter ";" (e.g. "Playlist One; Playlist Two"). If this is used, the playlist id parameter must be listed in this order using the same delimiter (e.g. "idOne;idTwo").
 * playlist id= The playlist URL(s) of the rip. It can also be a raw playlist ID.1
 * upload= The upload date of the rip on the SiIvaGunner channel. The date will be automatically formatted as MDY if it is in a recognized format.
 * length= The length of the rip. (XX:XX)
 * author= The ripper(s) of the track, not the original composer. A link and category will automatically be added if there is exactly one ripper credited and there are no links in the input (excluding references, which are ignored).

1 These parameters can automatically format text into links if they are given proper values.
 * Description
 * music= The music in the description.
 * composer= The composer of the rip.
 * platform= The platform the ripped game is released on
 * catchphrase= The catchphrase in the description (defaults to "Please read the channel description")


 * All parameters
 * title= The title of the rip. By default, it is the page's name surrounded by double quotation marks ("").
 * giivasunner upload = The upload date of the rip on the original GiivaSunner channel, if the rip is a re-upload. The date will be automatically formatted as MDY if it is in a recognized format.


 * event= The name of the channel event(s) the rip was uploaded on.2
 * audio= The name of the track's audio file on this wiki (without the "File:" prefix). Mainly for removed rips.
 * album= The Bandcamp album(s) the rip was released on. Should be the name of an album page on the wiki.1, 2
 * track= A link to the track on Bandcamp.


 * performer= The performer (some rips have this)
 * arranger= The arranger (some rips have this)

1 This parameter can automatically format text into links if it is given proper values.
 * Video description
 * music label= The label for "Music:"
 * composer label= The label for "Composer:"
 * performer label= The label for the performer (default: "Performed by:")
 * arranger label= The label for "Arranged by:")
 * platform label= The label for "Platform:"
 * playlist label= The label for the Playlist (default: "Playlist:"). For example, some of the Talk Like a Pirate Day rips have "Treasure Map: [link]" instead of "Playlist: [link]"

2 This parameter can have multiple values given to it as long as they are separated with the delimiter ";" (e.g. "valueOne; valueTwo"). The automatic categorization can be overridden using
 * Overriding
 * allows any page to be categorized.
 * any other value (e.g. ) will prevent the page from being categorized. Useful if the template breaks on single page.


 * Categorization
 * Automatic categorization will only occur if the page is invoked on an article in the main namespace or on a namespace specified by the parameter  (see the Overriding section above)
 * Category:Rips: [always]
 * A subcategory of Category:Rips by month (in the format of "MONTH YEAR rips"): ,
 * A subcategory of Category:Playlists:  if it does not contain "?", "[" or "]"
 * A subcategory of Category:Albums:  if it does not contain "<", ">", "[" or "]"
 * A subcategory of Category:Rips by author:  if it does not contain "<", ">", "[" or "]"

This template relies on the following:
 * Dependencies
 * Template:Rip/data -- to implement the structure
 * Module:AlbumParam -- to implement the album parameter and event parameter
 * Template:Icon -- to implement the icons that appear next to links
 * Module:PlaylistParam -- to implement using multiple playlists and playlist ids

Examples

 * Note:The following examples do not include categorization.


 * Basic parameters


 * All parameters


 * Rip (We Are Number One - LazyTown: The Video Game)