User:Ironwestie/Rip infobox

Documentation for an iteration of Template:Rip. Originally at User:Ironwestie/Sandbox.

To suggest a change, post something on the forums.

For a more up-to-date tutorial on the template, see Template:Rip/doc and SiIvaGunner Wikia:Manual of Style/Rips.

Rip infobox

 * Description
 * A new change to Template:Rip. It allows the infobox to automatically categorize rip pages into relevant categories while also keeping its flexibility.
 * It is based off the coding structure we at the Webcomic Wiki use for Template:Infobox webcomic (see this iteration).
 * The template is split into TWO parts to allow administrators to manage how much control editors should have on the template.
 * Current Rip template
 * Currently template rip looks like:

 Title Example.jpg This is the equivalent of calling:

/data
 Basic information Releases Description
 * Note: for the purposes of showing the infobox in its entirety, optional rows and values have been included.

Basic information Releases Description

Documentation

 * Description
 * Provides a VISUAL skeleton for Template:Rip. Inspired by Template:Infobox webcomic by Ironwestie and Ineni from the Webcomics Wikia.


 * Usage
 * This template should only be used by Template:Rip and to prevent certain back-end things from being invoked inappropriately. To use this template, place the following code onto a page:


 * Full syntax

All of the following parameters are optional, but some parameters will only appear if other parameters are also valid: The following parameters override the text of their respective labels:
 * Parameters
 * title= The title of the rip
 * image= The thumbnail image of the rip.
 * link= The YouTube link of the rip.
 * playlist= The playlist of the rip
 * upload= The upload of the rip.
 * length= The length of the rip.
 * author= The ripper(s).
 * album= The Bandcamp album.
 * track= The track on Bandcamp
 * music= The music in the description
 * composer= The composer of the rip.
 * platform= The platform the ripped game is released on
 * arranger= The arranger (some rips have this)
 * performer= The performer (some rips have this)
 * catchphrase= The catchphrase in the description
 * Overriding
 * music label=
 * composer label=
 * platform label=
 * arranger label=
 * performer label=

Native (invokes /data)


Documentation

 * Description
 * Provides the "meat" of the skeleton that /data provides. It checks parameters, categorizes the page, and formats text.


 * Usage
 * 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: 1 These parameters can automatically format text into links if they are given proper values. The following parameters override the text of their respective labels. They are used for situations where the labels in the descriptions are changed (such as during National Pirate Day): The automatic categorization can also be overridden using
 * Parameters
 * title= The title of the rip
 * image= The thumbnail image of the rip. Do not include the File: prefix.
 * link= The YouTube link of the rip. It can also be a raw video ID.1
 * playlist= The playlist of the rip.1
 * playlist id= The raw YouTube ID of the rip.1
 * upload= The upload date of the rip on the SiIvaGunner channel.
 * giivasunner upload = The upload date of the rip on the original GiivaSunner channel.
 * length= The length of the rip. (X:XX)
 * author= The ripper(s).
 * album= The Bandcamp album. Should be the name of an album page on the wiki.1
 * album link= The link to the album.1
 * track= The track on Bandcamp.
 * music= The music in the description.
 * composer= The composer of the rip.
 * platform= The platform the ripped game is released on
 * arranger= The arranger (some rips have this)
 * performer= The performer (some rips have this)
 * catchphrase= The catchphrase in the description (defaults to "Please read the channel description")
 * Overriding
 * music label=
 * composer label=
 * platform label=
 * arranger label=
 * performer label=
 * 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 "]"

Examples

 * Note:The following examples do not include categorization.
 * Generic (Rip/data)


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

Requires #arraymap
Some of the things I planned to use in the template won't work on the wiki because it lacks the #arraymap text parser from Semantic MediaWiki. I'll attempt to use the Arrays or Loops extensions instead.
 * Note: This has now been replaced with Module:AlbumParam (see User:Ironwestie/Sandbox)


 * Replaced code
 * author


 * author=


 * album


 * album=


 * Replacement
 * author


 * author=

after checks for being a valid category...
 * album (incomplete)

TODO: categorization