Template:Qref/doc

This template can be used in order to make quick references to a chapter and/or an episode, an SBS volume, a cover story, a databook, Color Walk, or a movie of One Piece.

Dependencies
The template uses Qref/contents, Which volume, Which cover and Which excard.

Usage
Shortened parameters are also available:

The order of priority of the sources is the following: This means that the SBS parameter will appear only if there are no Chapter and Episode set, and so on.
 * 1) Chapter & Episode
 * 2) Volume
 * 3) Cover story & Episode
 * SBS
 * 1) Databook
 * 2) Color Walk
 * 3) Novel
 * 4) One-Shot
 * 5) Weekly Shonen Jump Issue
 * 6) One Piece Magazine Issue
 * 7) Road To Laugh Tale Issue
 * OVA
 * 1) Special
 * 2) Featurette
 * 3) Movie
 * 4) Video Game
 * 5) Live Show
 * 6) Live-Action Series
 * 7) Other
 * 8) Text only (free source)
 * "Name" is an optional parameter allowing to tag the note for it to be referred again later.
 * "Chapter2" and "Episode2" are optional parameters that allow for chapter or episode ranges to be referenced. These should be only be used where absolutely necessary.
 * "Cover2" is an optional parameter allowing the user to provide two successive volumes of a cover story.
 * "Nchap" is an optional parameter that goes with Novel, allowing the novel chapter to be specified.
 * "Gchap" is an optional parameter that goes with Game, allowing the game chapter to be specified.
 * "Page" is an optional parameter that goes with some of the other parameters, listed below.


 * Parameters supporting page:
 * Chapter
 * Volume
 * SBS
 * Databook
 * Color Walk
 * Novel
 * One-Shot
 * Jump Issue
 * Magazine
 * Road to Laugh Tale
 * Other

Numbered Sources
The following parameters use simple numbers as values. Note that some of these support text-based values as well, in which case they are detailed below.
 * Chapter
 * Volume
 * SBS
 * Color Walk
 * Magazine
 * Road to Laugh Tale
 * OVA
 * Special
 * Featurette
 * Movie
 * Live-Action Series

For the numbered parameters without immediately obvious counts, explanations are included below. Note that this only includes the numerical options, and text-based options are listed in later subsections.
 * Clarification


 * OVA
 * One Piece - Defeat Him! The Pirate Ganzack
 * One Piece: Romance Dawn Story
 * One Piece Film Strong World: Episode 0
 * Infiltrate!! Thousand Sunny
 * Special
 * Episode Special 1
 * Episode Special 2
 * Episode Special 3
 * Episode Special 4
 * Episode of Nami
 * Episode of Luffy
 * Episode of Merry
 * 3D2Y
 * Episode of Sabo
 * Adventure of Nebulandia
 * Heart of Gold
 * Episode of East Blue
 * Episode of Sky Island
 * Featurette
 * Jango's Dance Carnival
 * Dream Soccer King
 * Take Aim! The Pirate Baseball King
 * ONE PIECE 3D! Trap Coaster
 * The Great Treasure of Tongari Island
 * Movie
 * One Piece: The Movie
 * Clockwork Island Adventure
 * Chopper's Kingdom on the Island of Strange Animals
 * Dead End Adventure
 * The Cursed Holy Sword
 * Baron Omatsuri and the Secret Island
 * The Giant Mechanical Soldier of Karakuri Castle
 * Episode of Arabasta: The Desert Princess and the Pirates
 * Episode of Chopper Plus: Bloom in Winter, Miracle Sakura
 * One Piece Film: Strong World
 * One Piece 3D: Straw Hat Chase
 * One Piece Film: Z
 * One Piece Film: Gold
 * One Piece: Stampede
 * One Piece Film: Red

Databook Parameter
Here is the list of possible values for the databook parameter:
 * for One Piece Red: Grand Characters;
 * for One Piece Blue: Grand Data File;
 * for One Piece Yellow: Grand Elements;
 * for One Piece Green: Secret Pieces;
 * for One Piece Blue Deep: Characters World;
 * for Vivre Card - One Piece Visual Dictionary;
 * for the One Piece 15th Anniversary: Dive to Grand World special booklet;
 * for the One Piece Animation Logbook;
 * for One Piece Rainbow!;
 * for One Piece White!.


 * Optional Parameters:
 * : Specifies the page being referenced (number value).
 * In the case of Vivre Card being referenced:
 * : Specifies the card being referenced (number value).
 * : Species the EX card being referenced (number value).

Color Walk Parameter
Here is the list of possible values for the colorwalk parameter:
 * for One Piece Color Walk 3 Lion;
 * for One Piece Color Walk 4 Eagle;
 * for One Piece Color Walk 5 Shark;
 * for One Piece Color Walk 6 Gorilla;
 * for One Piece Color Walk 7 Tyrannosaurus;
 * for One Piece Color Walk 8 Wolf;
 * for One Piece Color Walk 9 Tiger;
 * for One Piece Color Walk 10 Dragon.

Note that the colorwalk parameter also supports number-based values.

Additionally, the colorwalk parameter allows usage of, with   representing a number from 1 to 9; this will reference the VIZ Color Walk Compendiums, with the number referring to the corresponding Japanese Color Walk volume. For example,  references One Piece Color Walk Compendium: Water Seven to Paramount War (VIZ Media), VIZ's release of Color Walk 5 Shark.


 * Optional Parameters:
 * : Specifies the page being referenced (number value).

Novel Parameter
Here is the list of possible values for the novel parameter:
 * for One Piece - Defeat Him! The Pirate Ganzack (Novel);
 * for Loguetown Arc (Novel);
 * for One Piece: Sennenryu Legend;
 * for One Piece: Film Z;
 * for One Piece: Film Red;
 * for One Piece novel Straw Hat Stories;
 * for One Piece novel A Vol. 1;
 * for One Piece novel A Vol. 2;
 * for One Piece novel Law;
 * for One Piece novel HEROINES.


 * Optional Parameters:
 * : Specifies the chapter being referenced (number value).
 * : Specifies the page being referenced (number value).

One-Shot Parameter
Here is the list of possible values for the oneshot parameter:
 * for Romance Dawn, Version 1;
 * for Romance Dawn, Version 2;
 * for Wanted! (one-shot);
 * for God's Gift for the Future;
 * for Ikki Yako;
 * for Monsters;
 * for My Plans Never Fail!!.


 * Optional Parameters:
 * : Specifies the page being referenced (number value).
 * : Allows referencing the Monsters: 103 Mercies Dragon Damnation ONA with the parameter.

Jump Parameter
The jump parameter is unique in that it rearranges the input value. To have it work correctly, the value should be formatted ; for example,.


 * Optional Parameters:
 * : Specifies the page being referenced (number value).

Special Parameter
The special parameter is primarily intended to be used with numerical values. However, it has a few text-based specifications, listed below.
 * for Glorious Island;
 * for One Piece Film: Gold Episode 0;
 * for Monsters: 103 Mercies Dragon Damnation;
 * for Emergency Planning, A Perfect Strategy for the One Piece;
 * for One Piece New Year Special: Special Report - Secret of the Straw Hat Pirates!;
 * for Long Ring Long Land Arc Abridged;
 * for One Piece Characters Log;
 * for Luffy-senpai Support Project! Barto's Secret Room!;
 * for Zoro and Sanji-senpai Admiring Project! Barto's Secret Room 2!;
 * for A Comprehensive Anatomy! The Legend of Kozuki Oden!;
 * for The Legendary Log! Red-Haired Shanks!;
 * for A Comprehensive Anatomy! Fierce Fight! The Five from the New Generation!;
 * for Great Fierce Battle Special! The Straw Hats vs. the Tobi Roppo;
 * for Great Fierce Battle Special! Zoro vs. an All-Star!;
 * for Great Fierce Battle Special! Alliance Counterattack vs. Big Mom;
 * for Luffy-senpai Support Project! Barto's Secret Room 3!;
 * for Luffy-senpai Support Project! Barto's Secret Room 4!;
 * for Special Feature! Momonosuke's Path to Becoming a Great Shogun.

Movie Parameter
The movie parameter is primarily intended to be used with numerical values. However, it has a few text-based specifications, listed below.
 * for One Piece Film: Strong World;
 * for One Piece Film: Z;
 * for One Piece Film: Gold;
 * for One Piece: Stampede;
 * for One Piece Film: Red.

Video Game Parameter
Here is the list of possible values for the game parameter:
 * for Set Sail Pirate Crew!;
 * for Legend of the Rainbow Island;
 * for One Piece: Treasure Wars;
 * for One Piece: Great Hidden Treasure of the Nanatsu Islands;
 * for One Piece: Ocean's Dream!;
 * for Chopper's Big Adventure;
 * for One Piece: Round the Land;
 * for One Piece: Unlimited Adventure;
 * for One Piece Unlimited Cruise 1;
 * for One Piece Unlimited Cruise 2;
 * for One Piece Unlimited Cruise: SP;
 * for One Piece Unlimited Cruise: SP2;
 * for One Piece: Unlimited World Red;
 * for RPG2 ~Thousand World~;
 * for One Piece: Pirate Warriors 2;
 * for One Piece: Pirate Warriors 3;
 * for One Piece: World Seeker;
 * for One Piece: Fighting Path;
 * for One Piece Odyssey;
 * for One Piece Bounty Rush;
 * for One Piece Thousand Storm;
 * for One Piece Treasure Cruise.


 * Optional Parameters:
 * : Specifies the game chapter being referenced (number value).

The game parameter has deprecated values. These are still available to support legacy usage, but should not be used when newly referencing information. If any usages are found, they should be replaced with the updated version.
 * Legacy Parameters
 * for One Piece: Unlimited Cruise. Replaced with.

Show Parameter
Here is the list of possible values for the show parameter:
 * for One Piece Premier Show 2007;
 * for One Piece Premier Show 2010;
 * for One Piece Premier Show 2012;
 * for One Piece Premier Show 2013;
 * for One Piece Premier Show 2014;
 * for One Piece Premier Show 2015;
 * for One Piece Premier Show 2016;
 * for One Piece Premier Show 2017;
 * for One Piece Premier Show 2018;
 * for One Piece Premier Show 2019;
 * for One Piece Premier Show 2021;
 * for One Piece Premier Show 2022;
 * for One Piece Premier Show 2023;
 * for Lucy & Lucy Coliseum the Battle;
 * for Bon Kurei Dance Performance Show;
 * for Zombie Pretty Fever;
 * for ONE PIECE LIVE STAGE ～Tower of Steel～;
 * for Tokyo Pirates Festival 2018;
 * for Tokyo One Piece Tower X DAZZLE;
 * for Live Action Role Playing Game;
 * for One Piece Live Attraction: Phantom;
 * for One Piece Live Attraction: Marionette;
 * for One Piece Water Battle 2014;
 * for One Piece Water Battle 2015;
 * for One Piece Water Battle 2016;
 * for One Piece Water Battle 2017;
 * for One Piece Water Battle 2018;
 * for One Piece Water Battle 2019;
 * for One Piece Pirate Sweeping Operation;
 * for WANTED;
 * for Sanji's Pirates Restaurant, in which ## signifies the year as a two-digit number.
 * For example,  signifies Sanji's Pirates Restaurant 2015.

"Other" Parameter
Here is the list of possible values for the other parameter:
 * for Wanted!;
 * for One Piece Complete Collection;
 * for Grand Times;
 * for One Para;
 * for One Piece 10th Treasures;
 * for Volume 0 "Strong World";
 * for One Piece Ten;
 * for Volume 1000 "Z";
 * for Volume 777;
 * for Volume 794;
 * for Volume 333;
 * for Volume 10089;
 * for Volume 4000000000 "RED";
 * for Volume 4／4 "UTA"
 * for One Piece Art NUE;
 * for One Piece: Great Hidden Treasure of the Nanatsu Islands;
 * for Super Kabuki II One Piece: "Great World".


 * Optional Parameters:
 * : Specifies the page being referenced (number value).

Examples
Shanks left Luffy his straw hat.
 * Complete reference
 * Shanks left Luffy his straw hat.

Puzzle's crew believes that he will become the next Pirate King.
 * Episode only reference
 * Puzzle's crew believes that he will become the next Pirate King.

Though not related by blood, Nojiko supports Nami like a real sister.
 * Chapter only reference
 * Though not related by blood, Nojiko supports Nami like a real sister.

Robin's height is 188 cm.
 * SBS Volume reference
 * Robin's height is 188 cm.

Hatchan saves Camie.
 * Cover story reference
 * Hatchan saves Camie.

Hatchan saves Camie.
 * Double cover story reference
 * Hatchan saves Camie.

Some info in the red databook.
 * Databook reference
 * Some info in the red databook.

Some info from an individual character card.
 * Vivre Card reference
 * Some info from an individual character card.

Some info from an EX Characters entry.
 * Some info from an EX Characters entry.

Some info in the third color walk.
 * Color Walk reference
 * Some info in the third color walk.

Some info in Movie 5.
 * Movie reference
 * Some info in Movie 5.

Oda loves Dragonball.
 * Free reference
 * Oda loves Dragonball.

Unnamed references are also possible (if you do not intend to create multiple page references linked to the same source):

blablabla
 * blablabla

Multiple reference When one wants to refer again to an already existing reference, the only necessary argument is the name :

Another reference to Luffy's hat
 * Another reference to Luffy's hat

TemplateData
This section hosts TemplateData, a way of defining information for MediaWiki's visual interface. It is included here as an alternate way of visualizing the different parameters. {	"params": { "page": { "type": "number", "label": "Page", "description": "Specifies a page in the reference, if applicable. Can be left blank." },		"ep": { "aliases": [ "episode" ],			"label": "Episode", "description": "Reference an episode of the anime.", "type": "number" },		"chap": { "aliases": [ "chapter" ],			"label": "Chapter", "description": "Reference a chapter. Volume number is auto-generated, and does not need to be supplied.", "type": "number" },		"name": { "aliases": [ "id" ],			"label": "Name", "description": "Adds a name to the reference. If a name is supplied, the same reference can be used later, by filling in the same name.", "type": "string", "suggested": true },		"sbs": { "label": "SBS", "description": "Reference a specific SBS.", "type": "number" },		"vol": { "aliases": [ "volume" ],			"label": "Volume", "description": "Reference a volume, outside of a chapter or SBS segment. This value does not need to be filled in to reference chapters or SBS.", "type": "number" },		"chap2": { "aliases": [ "chapter2" ],			"label": "Chapter Range", "description": "Reference a range of chapters. The first chapter in the range should be supplied to Chapter, while the last chapter should be supplied here.", "type": "number" },		"ep2": { "aliases": [ "episode2" ],			"label": "Episode Range", "description": "Reference a range of episodes. The first episode in the range should be supplied to Episode, while the last episode should be supplied here.", "type": "number" },		"cover": { "aliases": [ "coverstory" ],			"label": "Cover Story", "description": "Reference a cover story. The number supplied should be the chapter number.", "type": "number" },		"cover2": { "aliases": [ "coverstory2" ],			"label": "Cover Story Range", "description": "Reference a range of cover stories. The first cover story chapter in the range should be supplied to Cover Story, while the last cover story chapter should be supplied here.", "type": "number" },		"data": { "aliases": [ "databook" ],			"label": "Databook", "description": "Reference a databook. This parameter uses keywords to specify the source, so refer to the template documentation if necessary.", "type": "string" },		"cw": { "aliases": [ "colorwalk" ],			"label": "Color Walk", "description": "Reference a Color Walk. This parameter allows use of numbers or keywords to specify the source, so refer to the template documentation if necessary.", "type": "string" },		"card": { "label": "Vivre Card", "description": "Reference a specific Vivre Card card. For this parameter to function, Databook must be set to \"Vivre Card\".", "type": "number" },		"excard": { "label": "Vivre EX Card", "description": "Reference an EX Vivre Card. For this parameter to function, Databook must be set to \"Vivre Card\".", "type": "number" },		"novel": { "label": "Novel", "description": "Reference a novel. This parameter uses keywords to specify the source, so refer to the template documentation if necessary.", "type": "string" },		"nchap": { "label": "Novel Chapter", "description": "Reference a specific chapter of a novel. For this parameter to function, Novel must be specified.", "type": "number" },		"oneshot": { "label": "One-Shot", "description": "Reference a one-shot. This parameter uses keywords to specify the source, so refer to the template documentation if necessary.", "type": "string" },		"jump": { "label": "Weekly Shonen Jump", "description": "Reference a Weekly Shonen Jump issue. Value should be supplied as \"YEAR ##\", with \"##\" specifying the issue number. For more information, see full template documentation.", "type": "string" },		"magazine": { "label": "One Piece Magazine", "description": "Reference an issue of One Piece Magazine.", "type": "number" },		"road": { "label": "Road to Laugh Tale", "description": "Reference an issue of Road to Laugh Tale.", "type": "number" },		"ova": { "label": "OVA", "description": "Reference an OVA. This parameter allows usage of numbers or keywords to specify the source, so refer to the template documentation if necessary.", "type": "string" },		"special": { "label": "TV Special", "description": "Reference a TV Special or Recap. This parameter allows usage of numbers or keywords to specify the source, so refer to the template documentation if necessary.", "type": "string" },		"featurette": { "label": "Featurette", "description": "Reference a featurette.", "type": "number" },		"movie": { "label": "Movie", "description": "Reference a movie. This parameter allows usage of numbers or keywords to specify the source, so refer to the template documentation if necessary.", "type": "string" },		"game": { "label": "Video Game", "description": "Reference a video game. This parameter uses keywords to specify the source, so refer to the template documentation if necessary.", "type": "string" },		"gchap": { "label": "Video Game Chapter", "description": "Reference a specific chapter of a video game. For this parameter to function, Video Game must be specified.", "type": "number" },		"show": { "label": "Live Show", "description": "Reference a live show. This parameter uses keywords to specify the source, so refer to the template documentation if necessary.", "type": "string" },		"liveact": { "label": "Live-Action Series", "description": "Reference an episode of the live-action series. Specify the episode number.", "type": "number" },		"other": { "label": "Other", "description": "Reference some other piece of media. This parameter uses keywords to specify the source, so refer to the template documentation if necessary.", "type": "string" },		"text": { "aliases": [ "1"			],			"label": "Details", "description": "Supply other relevant information, for example a description of what's being referenced. Can also be used to reference something not available using one of the quick references.", "type": "string", "suggested": true }	},	"paramOrder": [ "name", "page", "chap", "chap2", "ep", "ep2", "sbs", "vol", "cover", "cover2", "data", "card", "excard", "cw", "novel", "nchap", "oneshot", "jump", "magazine", "road", "ova", "special", "featurette", "movie", "game", "gchap", "show", "liveact", "other", "text" ],	"description": "Creates a quick reference.", "format": "inline" }