Template:Episode list/doc

Episode list creates a table row, for use in a list of episodes tables, primarily for television. This template can be used in conjunction with Episode table which creates a consistent and Manual of Style ready table, or with a manually created table. See walk-through for further explanation.

Usage
Episode list may be added by pasting it as shown below into an article, either inside an Episode table template, or be placed inside a manually created table. The number and the type of columns a table has, is defined by the table header, and is not defined by this template. In order for this template to provide a table column for a given episode, parameters must either be included or excluded. An included parameter, although empty, will provide a cell for that field (and thus a column), while excluding a parameter will not provide a cell for that field. Empty cells will be automatically filled with "TBA" or "N/A".

TemplateData
{	"description": "This template creates a table row, for use in a list of episodes, primarily for television. The number, and use, of columns a table has, is defined by the beginning wikitext of that table (further explained below), and is not defined by this template. In order for this template to provide a table column for a given episode, parameters must either be included or excluded. An included parameter, although empty, will provide a cell for that field (and thus column), while excluding a parameter will not provide a cell for that field. Empty cells will be automatically filled with . It is used within .", "params": { "1": {			"label": "Article name", "type": "string", "required": true, "suggested": true, "deprecated": false, "description": "The title of the article the table is located in." },		"NumParts": { "label": "Number of parts", "type": "number", "required": false, "suggested": false, "deprecated": false, "description": "The number of titles an episode has or the number of serials a story has." },		"EpisodeNumber": { "label": "Episode number", "type": "number", "required": false, "suggested": true, "deprecated": false, "description": "A number representing the episode's order in the series. For example, the first episode would be  or , and so on." },		"EpisodeNumber2": { "label": "Second episode number", "type": "number", "required": false, "suggested": true, "deprecated": false, "description": "A second episode number column. Typically used to indicate the episode's order in the season. This parameter can also be useful for when a series aired in a different order." },		"Title": { "label": "Title", "type": "wiki-page-name", "required": false, "suggested": true, "deprecated": false, "description": "The title of the episode. The title will appear in \"quotes\" when rendered, so it is not necessary to place them in quotes beforehand. Only link to an episode article if it has already been created." },		"RTitle": { "label": "Title reference (or title raw)", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "Unformatted parameter that can be used to add a reference after \"Title\", or can be used as a \"raw title\" to replace \"Title\" completely. Future episodes should include a reference in this field to comply with Unformatted parameter that can be used to add a reference after Title, or can be used as a \" title\" to replace Title completely. Future episodes should include a reference in this field to comply with Verifiability." },		"AltTitle": { "label": "Alternative title", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "An alternative title, such as a title that was originally changed. The title will appear in \"quotes\" when rendered. If Title is also present, it will be listed below." },		"RAltTitle": { "label": "Alternative title's reference (or alternative title raw)", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "Unformatted parameter that can be used to add a reference after AltTitle, or can be used as a \" title\" to replace AltTitle completely." },		"TranslitTitle": { "label": "Transliteration title", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "The title of the episode transliteration (Romanization) to Latin characters." },		"NativeTitle": { "label": "Native title", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "The title of the episode in the native language." },		"NativeTitleLangCode": { "label": "Native title language code", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "The language code of the native title language." },		"Aux1": { "label": "Extra column 1", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "General purpose parameter. The meaning is specified by the column header." },		"DirectedBy": { "label": "Directed by", "type": "string", "required": false, "suggested": true, "deprecated": false, "description": "Name of the episode's director." },		"WrittenBy": { "label": "Written by", "type": "string", "required": false, "suggested": true, "deprecated": false, "description": "Name of the credited episode's writer(s)." },		"Aux2": { "label": "Extra column 2", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "General purpose parameter. The meaning is specified by the column header." },		"Aux3": { "label": "Extra column 3", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "General purpose parameter. The meaning is specified by the column header." },		"OriginalAirDate": { "label": "Original air date", "type": "string", "required": false, "suggested": true, "deprecated": false, "description": "The date the episode first aired, or is scheduled to air. Format date using Start date; use y for day-first format; omit for month-first." },		"AltDate": { "label": "Second notable air date", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "The next notable air date, such as the first air date of an anime in English. Format date per MOS:DATE. Do not use Start date if OriginalAirDate is present." },		"ProdCode": { "label": "Production code", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "The production code in the series." },		"Viewers": { "label": "Number of viewers", "type": "string", "required": false, "suggested": true, "deprecated": false, "description": "The number of viewers who watched the episode. Should include a reference." },		"Aux4": { "label": "Extra column 4", "type": "content", "required": false, "suggested": false, "deprecated": false, "description": "General purpose parameter. The meaning is specified by the column header." },		"ShortSummary": { "label": "Short summary", "type": "string", "required": false, "suggested": true, "deprecated": false, "description": "A short 100–200 word plot summary of the episode. Make summaries specific to that episode (as in, a description that would normally not be confused with another episode). Episode summaries must not be copied from other sources, as this violates WP:COPYRIGHT. " },		"LineColor": { "label": "Border color", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "Colors the separator line between episode entries. If not defined the color defaults to \" \"." },		"TopColor": { "label": "Top color", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "Colors the main row of information (that is, not the ShortSummary row). If not defined, it defaults to the wikitable standard background shading of \" \", except when ShortSummary is used, and then it defaults to \" \"." },		"RowColor": { "label": "Row banding color override", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "This parameter is a \"switch\" that must only be defined when the EpisodeNumber value is not a regular number (e.g. \"12–13\" for two episodes described in one table entry). When transcluding the table from a season article into a main episode list article, irregular EpisodeNumber values break up the striping effect the template introduces. If the first episode number is even, set on. If the first episode number is odd, set off. All further uses of Template:Episode list in the table must also have the RowColor parameters defined to alternate between  and   to avoid further breakages in the striping." },		"Title_1": { "label": "Title in multi-part episode", "type": "wiki-page-name", "required": false, "suggested": true, "deprecated": false, "description": "The title of the episode. Used when NumParts is used, as there are multiple titles for an episode, and should be used instead of Title. The number of titles should not exceed the number set in NumParts." },		"Title_2": { "inherits": "Title_1" },		"Title_3": { "inherits": "Title_1" },		"Title_4": { "inherits": "Title_1" },		"Title_5": { "inherits": "Title_1" },		"Title_6": { "inherits": "Title_1" },		"Title_7": { "inherits": "Title_1" },		"Title_8": { "inherits": "Title_1" },		"Title_9": { "inherits": "Title_1" },		"RTitle_1": { "label": "Title reference (or title raw) in multi-part episode", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "Unformatted parameter that can be used to add a reference after Title, or can be used as a \" title\" to replace Title completely. Used when NumParts is used, as there are multiple titles for an episode, and should be used instead of RTitle. The number of titles should not exceed the number set in NumParts." },		"RTitle_2": { "inherits": "RTitle_1" },		"RTitle_3": { "inherits": "RTitle_1" },		"RTitle_4": { "inherits": "RTitle_1" },		"RTitle_5": { "inherits": "RTitle_1" },		"RTitle_6": { "inherits": "RTitle_1" },		"RTitle_7": { "inherits": "RTitle_1" },		"RTitle_8": { "inherits": "RTitle_1" },		"RTitle_9": { "inherits": "RTitle_1" },		"AltTitle_1": { "label": "Alternative title in multi-part episode", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "An alternative title, such as a title that was originally changed. Used when NumParts is used, as there are multiple titles for an episode, and should be used instead of AltTitle. The number of titles should not exceed the number set in NumParts." },		"AltTitle_2": { "inherits": "AltTitle_1" },		"AltTitle_3": { "inherits": "AltTitle_1" },		"AltTitle_4": { "inherits": "AltTitle_1" },		"AltTitle_5": { "inherits": "AltTitle_1" },		"AltTitle_6": { "inherits": "AltTitle_1" },		"AltTitle_7": { "inherits": "AltTitle_1" },		"AltTitle_8": { "inherits": "AltTitle_1" },		"AltTitle_9": { "inherits": "AltTitle_1" },		"RAltTitle_1": { "label": "Alternative title's reference (or alternative title raw) in multi-part episode", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "Unformatted parameter that can be used to add a reference after AltTitle, or can be used as a \" title\" to replace AltTitle completely. Used when NumParts is used, as there are multiple titles for an episode, and should be used instead of RAltTitle. The number of titles should not exceed the number set in NumParts." },		"RAltTitle_2": { "inherits": "RAltTitle_1" },		"RAltTitle_3": { "inherits": "RAltTitle_1" },		"RAltTitle_4": { "inherits": "RAltTitle_1" },		"RAltTitle_5": { "inherits": "RAltTitle_1" },		"RAltTitle_6": { "inherits": "RAltTitle_1" },		"RAltTitle_7": { "inherits": "RAltTitle_1" },		"RAltTitle_8": { "inherits": "RAltTitle_1" },		"RAltTitle_9": { "inherits": "RAltTitle_1" },		"TranslitTitle_1": { "label": "Transliteration title in multi-part episode", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "The title of the episode transliteration (Romanization) to Latin characters. Used when NumParts is used, as there are multiple titles for an episode, and should be used instead of TranslitTitle. The number of titles should not exceed the number set in NumParts." },		"TranslitTitle_2": { "inherits": "TranslitTitle_1" },		"TranslitTitle_3": { "inherits": "TranslitTitle_1" },		"TranslitTitle_4": { "inherits": "TranslitTitle_1" },		"TranslitTitle_5": { "inherits": "TranslitTitle_1" },		"TranslitTitle_6": { "inherits": "TranslitTitle_1" },		"TranslitTitle_7": { "inherits": "TranslitTitle_1" },		"TranslitTitle_8": { "inherits": "TranslitTitle_1" },		"TranslitTitle_9": { "inherits": "TranslitTitle_1" },		"NativeTitle_1": { "label": "Native title in multi-part episode", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "The title of the episode in the native language. Used when NumParts is used, as there are multiple titles for an episode, and should be used instead of NativeTitle. The number of titles should not exceed the number set in NumParts." },		"NativeTitle_2": { "inherits": "NativeTitle_1" },		"NativeTitle_3": { "inherits": "NativeTitle_1" },		"NativeTitle_4": { "inherits": "NativeTitle_1" },		"NativeTitle_5": { "inherits": "NativeTitle_1" },		"NativeTitle_6": { "inherits": "NativeTitle_1" },		"NativeTitle_7": { "inherits": "NativeTitle_1" },		"NativeTitle_8": { "inherits": "NativeTitle_1" },		"NativeTitle_9": { "inherits": "NativeTitle_1" },		"Aux1_1": { "label": "Extra column 1", "type": "string", "required": false, "suggested": false, "deprecated": false, "description": "The title of the serial. Used when NumParts is used, as there are multiple titles for an episode, and should be used instead of Aux1. The number of titles should not exceed the number set in NumParts." },		"Aux1_2": { "inherits": "Aux1_1" },		"Aux1_3": { "inherits": "Aux1_1" },		"Aux1_4": { "inherits": "Aux1_1" },		"Aux1_5": { "inherits": "Aux1_1" },		"Aux1_6": { "inherits": "Aux1_1" },		"Aux1_7": { "inherits": "Aux1_1" },		"Aux1_8": { "inherits": "Aux1_1" },		"Aux1_9": { "inherits": "Aux1_1" },		"OriginalAirDate_1": { "label": "Original air date", "type": "date", "required": false, "suggested": true, "deprecated": false, "description": "The date the episode first aired, or is scheduled to air. Used when NumParts is used, as there are multiple serials in a story, and should be used instead of OriginalAirDate. The number of dates should not exceed the number set in NumParts." },		"OriginalAirDate_2": { "inherits": "OriginalAirDate_1" },		"OriginalAirDate_3": { "inherits": "OriginalAirDate_1" },		"OriginalAirDate_4": { "inherits": "OriginalAirDate_1" },		"OriginalAirDate_5": { "inherits": "OriginalAirDate_1" },		"OriginalAirDate_6": { "inherits": "OriginalAirDate_1" },		"OriginalAirDate_7": { "inherits": "OriginalAirDate_1" },		"OriginalAirDate_8": { "inherits": "OriginalAirDate_1" },		"OriginalAirDate_9": { "inherits": "OriginalAirDate_1" },		"Viewers_1": { "label": "Number of viewers", "type": "string", "required": false, "suggested": true, "deprecated": false, "description": "The number of viewers who watched the episode. Used when NumParts is used, as there are multiple serials in a story, and should be used instead of Viewers. The number of dates should not exceed the number set in NumParts." },		"Viewers_2": { "inherits": "Viewers_1" },		"Viewers_3": { "inherits": "Viewers_1" },		"Viewers_4": { "inherits": "Viewers_1" },		"Viewers_5": { "inherits": "Viewers_1" },		"Viewers_6": { "inherits": "Viewers_1" },		"Viewers_7": { "inherits": "Viewers_1" },		"Viewers_8": { "inherits": "Viewers_1" },		"Viewers_9": { "inherits": "Viewers_1" },		"Aux4_1": { "label": "Extra column 4", "type": "content", "required": false, "suggested": false, "deprecated": false, "description": "General purpose parameter. The meaning is specified by the column header. Used when NumParts is used, as there are multiple serials in a story, and should be used instead of Aux4. The number of dates should not exceed the number set in NumParts." },		"Aux4_2": { "inherits": "Aux4_1" },		"Aux4_3": { "inherits": "Aux4_1" },		"Aux4_4": { "inherits": "Aux4_1" },		"Aux4_5": { "inherits": "Aux4_1" },		"Aux4_6": { "inherits": "Aux4_1" },		"Aux4_7": { "inherits": "Aux4_1" },		"Aux4_8": { "inherits": "Aux4_1" },		"Aux4_9": { "inherits": "Aux4_1" }	},	"format": "\n" }

Complete usage walk-through
To create an episode list, first create the table columns with the use of Episode table as following:

The complete code will look like this:

Standard
To create an episode list with the columns: episode number in series, episode number in season, title, director, writer, show-specific parameter, air date, production code and number of U.S. viewers – add the following code:

Non-English titles
To create an episode list which includes a native title and/or transliterated title – add the following code:

Episode with multiple titles
To create an episode list which includes an episode with multiple titles – add the following code:

Serials
To create an episode list for a serial (such as those used in Doctor Who) – add the following code:

Transclusion of the list on another page
When a TV series article is split into season pages, create each season's episode list on the corresponding season article. If the series also has a "List of episodes" article, do not re-create the tables in it, and instead transclude the table from the season articles to the list of episodes article.

For example, the TV series Lost has season articles for each of its seasons. An episode table is located in each of its season articles, such as Lost (season 1) and Lost (season 2). Each season is then then transcluded to List of Lost episodes.

When transcluded onto any other article, the episode summaries are removed, and the background row color alternates between light and dark gray, depending on the value of EpisodeNumber. Occasionally, a multi-part episode will skew the pattern between odd and even numbers, to rectify this, use the RowColor parameter. A on input will color the row dark gray, like an even number normally would, on the "List of X episodes" page, while a off input will color the row light gray, like an odd number normally would.

For the purpose of transclusion, each sublist must make use of  tags, with the opening tag just before the WikiTable, and the closing tag at the very end of the table. This prevents the lead, external links, templates, categories, interwiki links, and all other unnecessary information from being transcluded onto the main list.

When transcluding onto the main list, you should make use of Main.

Transclusion examples
On a season article, such as Lost (season 3), the code should be as follows:

&lt;onlyinclude> &lt;/onlyinclude>

And similar for the other season articles of the series, such as Lost (season 4):

&lt;onlyinclude> {{Episode table |background=#00549A |overall= |season= |title= |director= |writer= |aux2= |aux2T=Featured character(s) |airdate= |viewers= |country=U.S. |episodes= {{Episode list/sublist|Lost (season 4) }} {{Episode list/sublist|Lost (season 4) }}
 * EpisodeNumber  = 73
 * EpisodeNumber2 = 1
 * Title          = The Beginning of the End
 * DirectedBy     = Jack Bender
 * WrittenBy      = Damon Lindelof & Carlton Cuse
 * Aux2           = Hurley
 * OriginalAirDate = {{Start date|2008|1|31}}
 * Viewers        = 17.77&lt;ref name="rankings"/>
 * ShortSummary   = The survivors of 815 split into two groups led by Jack and Locke.
 * LineColor      = 00549A
 * RowColor       = on
 * EpisodeNumber  = 74
 * EpisodeNumber2 = 2
 * Title          = Confirmed Dead
 * DirectedBy     = Stephen Williams
 * WrittenBy      = Drew Goddard & Brian K. Vaughan
 * Aux2           = Faraday
 * OriginalAirDate = {{Start date|2008|2|7}}
 * Viewers        = 16.96&lt;ref name="rankings"/>
 * ShortSummary   = A science team from the freighter arrives on the island.
 * LineColor      = 00549A
 * RowColor       = off
 * }&lt;/onlyinclude>

The following code should appear on List of Lost episodes:

Season 2
Note the colon at the beginning of the transclusions; this is necessary when transcluding an article. If you tried to transclude Lost (season 1), without using the colon, you would get, a redlink to a nonexistent template.

The above code will appear as follows:


 * Season 3


 * Season 4

Tips
It may be helpful to include a hidden message that will appear when someone edits the article. Placed above the table headers and under the article section, such as:

==Episodes== &lt;onlyinclude> {{Episode table

This message won't be visible when normally viewing the article. A message such as this notes where one can get help for the template.

Microformat
For shows where each episode is from a different, single, specific place (for example, Time Team, one of the Aux fields can contain the coordinates, applied using coord.

Subpages
"Hacks" of this template, also known as "forks", are discouraged. Any discussion regarding forks should occur on this template's, not the fork's or article's, talk page.

Episode list templates

 * WikiProject Television/Episode lists
 * Template:Episode list
 * Template:Television needs episode list