Template:Episode list/doc

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 TableTBA.

Parameters
This is where information from the template is placed when rendered (LineColor, TopColor, and RowColor are not shown, since there's no text to display):

Using the template
When using optional parameters (such as  or  ) only list the parameters that are being used, and adjust the table headers accordingly. This will help avoid confusion when one entry has a parameter filled out, and another does not. A table cell will be open for each listed parameter, whether it is filled out or not. Empty cells will be automatically filled with TableTBA.

To apply an entry to an episode listing, add this template where the episode would go in the List of episodes. The full syntax is as follows (remove the parameters that are not being used in the table):

Because this is only part of a WikiTable, you first create the "header" of the WikiTable. To do so, you should use Episode table. Please refer to that template's documentation for an in-depth description of how to use each of its parameters. An example here, to create a list with only,  ,  ,  , and   parameters, open the table as follows:

Examples
The above code would appear as follows:

A more complex case would look like the following:

Sublists
Occasionally, when dealing with a very long series, you may wish to break the list up into separate sublists, generally broken by season or years. See Manual of Style/Television for more info regarding when to split.

The name of the sublist should correspond with the article title where the list will be transcluded. For example, if you were working on List of Lost episodes, you would split it into Lost (season 1) and Lost (season 2), and each episode on the sublist would use. But, if for some reason List of Lost episodes did not exist, and all episodes were located at Lost (TV series), the sublist would be

When transcluded onto the main list, this template removes any summaries, and alternates the background row color between light and dark gray, depending on the value of EpisodeNumber. Occasionally, a multi-part episode will skew the pattern between odd and even s, to rectify this, use the   parameter. A " " input will color the row dark gray, like an even number normally would, on the "List of X episodes" page, while a " " 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. For example, referring to Lost again, the main list would have the following code under the "Episode list" header:

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.

Examples
If the following code is on Lost (season 3): &lt;onlyinclude> &lt;/onlyinclude>

If the following code is on 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|List of Lost episodes }} {{Episode list/sublist|List of Lost episodes }} {{Episode list/sublist|List of Lost episodes }}
 * RowColor       = Y
 * 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       = N
 * 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       = Y
 * EpisodeNumber  = 75
 * EpisodeNumber2 = 3
 * Title          = The Economist
 * RTitle         = &lt;ref name="episode titles"/>
 * DirectedBy     = {{TableTBA}}
 * WrittenBy      = {{TableTBA}}
 * Aux2           = {{TableTBA}}
 * OriginalAirDate = {{Start date|2008|2|14}}&lt;ref name="TV Guide"/>
 * Viewers        = {{TableTBA}}
 * ShortSummary   = Locke's group settles into the Barracks.&lt;ref name="TV Guide"/>
 * LineColor      = 00549A
 * }&lt;/onlyinclude>

And if the following code is on List of Lost episodes:

Season 4
List of Lost episodes 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:S-Episode list
 * Template:Japanese episode list
 * Template:S-Japanese episode list
 * Template:Television needs episode list