Template:Rip/doc

"We Are Number One - LazyTown: The Video Game"
Basic information
Rip link	YouTube
Playlist	LazyTown: The Video Game ()
Upload date	September 13, 2016
Length	2:20
Ripper(s)	NBGMusic
Releases
Album(s)	GilvaSunner's Highest Quality Video Game Rips: Volume 7: Part mm2wood ()
Track(s)	"we are number one but with outdated memes over it"
Description
Music	We Are Number One
Composer	Máni Svavarsson
Platform	PC
	Please read the channel description.

Title (Example Mix) - Grand Dad Game
	File:Example.jpg
Basic information
Rip link	Example.com
Playlist	Grand Dad Game ()
Upload date	GiIvaSunner: January 1, 0001; SiIvaGunner: January 2, 0001
Event	Example Event
Length	0:00
Ripper(s)	John Doe
Releases
Album(s)	Doe's Album ()
Track(s)	Nutshack Track
Description
Music label	Title (Example Mix)
Composer label	Jane Smith
Performer label	The Performer
Arranger label	The Arranger
Platform label	PC
	Please read the example.

**"Rip/doc"**
	File:Example.jpg
Basic information
Rip link	Example.com
Playlist	Grand Dad Game ()
Upload date	January 1, 0001
Event	Example Event
Length	0:01
Ripper(s)	John Doe
Description
Music	Title (Example Mix)
Composer	Jane Smith
Platform	PC
	Please read the example.

This is a template documentation subpage for Template:Rip.
It contains usage information, categories, and other content that is not part of the original template.

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.

{{Rip
|image=

|link=
|playlist=
|playlist id=
|upload=
|length=
|author=

|album=
|track=

|music=
|composer=
|platform=
|catchphrase=
}}

Full syntax

{{Rip
|title=
|image=
|link=
|playlist=
|playlist id=
|upload=
|giivasunner upload=
|event=
|length=
|author=

|audio=

|album=
|track=

|music=
|composer=
|performer=
|arranger=
|platform=
|catchphrase=

|music label=
|composer label=
|performer label=
|arranger label=
|platform label=
|playlist label=
}}

Basic parameters

All of the following parameters are optional, but some parameters will only appear if other parameters are also valid:

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.¹
playlist= The playlist(s) of the rip. It should be the name of a category on the channel.¹.
- 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.¹
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).

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")

¹ These parameters can automatically format text into links if they are given proper values.

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.²
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)

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]"

¹ This parameter can automatically format text into links if it is given proper values.
² This parameter can have multiple values given to it as long as they are separated with the delimiter ";" (e.g. "valueOne; valueTwo").

Overriding

The automatic categorization can be overridden using override

- override={{NAMESPACE}} allows any page to be categorized.
- any other value (e.g. override=yes) 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 override (see the Overriding section above)
Category:Rips: [always]
A subcategory of Category:Rips by month (in the format of "MONTH YEAR rips"): upload, giivasunner upload
A subcategory of Category:Playlists: playlist if it does not contain "?", "[" or "]"
A subcategory of Category:Albums: album if it does not contain "<", ">", "[" or "]"
A subcategory of Category:Rips by author: author if it does not contain "<", ">", "[" or "]"
If album is blank, the rip is added to Category:Non-album rips
If author is blank, the rip is added to Category:Uncredited rips

Dependencies

This template relies on the following:

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

{{Rip
|image= Example.jpg
|link= [http://www.example.com Example.com]
|playlist= Grand Dad Game
|playlist id= LL9ecwl3FTG66jIKA9JRDtmg
|upload= January 1, 0001
|event = Example Event
|length= 0:01
|author= John Doe

|music= Title (Example Mix)
|composer= Jane Smith
|platform= PC
|catchphrase= Please read the example.
}}

All parameters

{{Rip
|title= Title (Example Mix) - Grand Dad Game
|image= Example.jpg
|link= [http://www.example.com Example.com]
|playlist= Grand Dad Game
|playlist id= LL9ecwl3FTG66jIKA9JRDtmg
|upload= January 2, 0001
|giivasunner upload= January 1, 0001
|event = Example Event
|length= 0:00
|author= John Doe
|album= Doe's Album
|track= Nutshack Track

|music= Title (Example Mix)
|composer= Jane Smith
|platform= PC
|arranger= The Arranger
|performer= The Performer
|catchphrase= Please read the example.

|music label= Music label
|composer label= Composer label
|platform label= Platform label
|arranger label= Arranger label
|performer label= Performer label
}}

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

{{Rip
|title= "We Are Number One - LazyTown: The Video Game"
|image= LazyTown- The Video Game.jpg
|link=-tvs8a_hOQo
|playlist=LazyTown: The Video Game
|playlist id= PLL0CQjrcN8D1Aw--XhSDjUJsX-w7lSG5W
|upload= September 13, 2016
|length=2:20
|author= NBGMusic
|album=GilvaSunner's Highest Quality Video Game Rips: Volume 7: Part mm2wood
|track="[https://gilvasunner.bandcamp.com/track/we-are-number-one-but-with-outdated-memes-over-it we are number one but with outdated memes over it]"
|music=We Are Number One
|composer= Máni Svavarsson
|platform=PC
|catchphrase=Please read the channel description.
}}

TemplateData

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.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Title	`title`	The title of the rip. By default, it is the page's name surrounded by double quotation marks (""). Default "{{PAGENAME}}" Example Title (Example Mix) - Grand Dad Game	Content	optional
Caption	`caption`	The caption of the rip	Content	optional
Image	`image`	The thumbnail image of the rip. Do not include the ''File:'' prefix. Example Example.jpg	File	suggested
Link	`link`	The YouTube URL of the rip. It can also be a raw rip ID. Example [http://www.example.com Example.com]	Content	suggested
Playlist	`playlist`	The playlist(s) of the rip. It should be the name of a category on the channel.	Content	suggested
Playlist ID	`playlist id`	The playlist URL(s) of the rip. It can also be a raw playlist ID. Example PLL9ecwl3FTG66jIKA9JRDtmg	Content	suggested
GiIvaSunner Upload	`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. Example January 1, 0001	Content	optional
Upload	`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. Example January 2, 0001	Content	suggested
Event	`event`	The name of the channel event(s) the rip was uploaded on. Example Example Event	Content	suggested
Audio	`audio`	The name of the track's audio file on this wiki (without the "File:" prefix). Mainly for removed rips.	File	optional
Length	`length`	The length of the rip. (''XX:XX'') Example 0:00	Content	suggested
Author	`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). Example John Doe	Content	suggested
Album	`album`	The Bandcamp album(s) the rip was released on. Should be the name of an album page on the wiki. Example Doe's Album	Content	optional
Track	`track`	A link to the track on Bandcamp. Example Nutshack Track	Content	optional
Music	`music`	The music in the description. Example Title (Example Mix)	Content	suggested
Music label	`music label`	The label for "Music:" Default Music Example Music label	Content	optional
Composer	`composer`	The composer of the rip. Example Jane Smith	Content	suggested
Composer label	`composer label`	The label for "Composer:" Default Composer	Content	optional
Platform	`platform`	The platform the ripped game is released on Example PC	Content	suggested
Platform label	`platform label`	The label for "Platform:" Default Platform Example Platform label	Content	optional
Arranger	`arranger`	The arranger (some rips have this)	Content	optional
Arranger label	`arranger label`	The label for "Arranged by:" Default Arranged by Example Arranger label	Content	optional
Performer	`performer`	The performer (some rips have this) Example The Performer	Content	optional
Perfomer label	`performer label`	The label for "Performer:" Default Performed by Example Perfomer label	Content	optional
Catchphrase	`catchphrase`	The catchphrase in the description Default Please read the channel description. Example Please read the example.	Content	suggested
Playlist label	`playlist label`	The label for "Playlist:". Default Playlist Example Treasure Map	Content	optional
Automatic categorization override	`override`	no description	Content	optional