Template:Episode list/sublist
This template is used on approximately 13,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
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[edit source]
{{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".
{{Episode list | EpisodeNumber = | EpisodeNumber2 = | Title = | RTitle = | AltTitle = | RAltTitle = | TranslitTitle = | NativeTitle = | NativeTitleLangCode = | Aux1 = | DirectedBy = | WrittenBy = | Aux2 = | Aux3 = | OriginalAirDate = <!-- {{Start date|YYYY|MM|DD|df=}} --> | AltDate = | ProdCode = | Viewers = | Aux4 = | ShortSummary = <!-- Don't add copyrighted text, e.g. from the show's website --> | LineColor = | TopColor = | RowColor = }}
No. overall | No. in season | Title | Aux1 | Directed by | Written by | Aux2 | Aux3 | Original air date | AltDate | Prod. code | U.S. viewers (millions) | Aux4 |
---|---|---|---|---|---|---|---|---|---|---|---|---|
{{{EpisodeNumber}}} | {{{EpisodeNumber2}}} | "{{{Title}}}"{{{RTitle}}} "{{{AltTitle}}}"{{{RAltTitle}}} | {{{Aux1}}} | {{{DirectedBy}}} | {{{WrittenBy}}} | {{{Aux2}}} | {{{Aux3}}} | {{{OriginalAirDate}}} | {{{AltDate}}} | {{{ProdCode}}} | {{{Viewers}}} | {{{Aux4}}} |
{{{ShortSummary}}} |
Parameters[edit source]
Parameter | Explanation |
---|---|
1 | The title of the article the table is located in. |
NumParts | The number of titles an episode has or the number of serials a story has. See examples section for usage. |
EpisodeNumber | A number representing the episode's order in the series. For example, the first episode would be 1 or 01 , and so on. When defined, the specified number also generates a link anchor, prefixed by "ep "; for example, "[[List of episodes#ep1]] " or "[[List of episodes#ep01]] ". In creating the anchor, the text specified for the number is treated literally: to generate the most straightforward versions of anchors as previously exemplified, specify only a number, omitting any use of formatting, including bold. For double-episodes where two numbers are listed and are separated by "----", "<hr />", or "<br />", the link anchor will be only the first number; that is, if the double episode spans episode numbers 87 and 88, then [[List of episodes#ep87]] will link directly to the episode.
|
EpisodeNumber2 | 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 | 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. |
|
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= .
|
RTitle | 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 Starfleet:Verifiability.
|
|
Unformatted parameter that can be used to add a reference after |Title= , or can be used as a "raw 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= .
|
AltTitle | 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.
|
|
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= .
|
RAltTitle | Unformatted parameter that can be used to add a reference after |AltTitle= , or can be used as a "raw title" to replace |AltTitle= completely.
|
|
Unformatted parameter that can be used to add a reference after |AltTitle= , or can be used as a "raw 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= .
|
TranslitTitle | The title of the episode transliteration (Romanization) to Latin characters. |
|
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= .
|
NativeTitle | The title of the episode in the native language. |
|
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= .
|
NativeTitleLangCode | The language code of the native title language. |
Aux1 | General purpose parameter. The meaning is specified by the column header. |
|
The title of the serial. Used when |NumParts= is used, as there are multiple serials in a story, and should be used instead of |Aux1= . The number of titles should not exceed the number set in |NumParts= .
|
DirectedBy | Name of the episode's director. |
WrittenBy | Name of the credited episode's writer(s). |
Aux2 | General purpose parameter. The meaning is specified by the column header. |
Aux3 | General purpose parameter. The meaning is specified by the column header. |
OriginalAirDate | The date the episode first aired, or is scheduled to air. Format date using {{Start date}}; use |df=y for day-first format; omit for month-first.
|
|
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= .
|
AltDate | 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.[N 1]
|
ProdCode | The production code in the series. When defined, this parameter also creates a link anchor, prefixed by "pc "; for example, "[[List of episodes#pc01]] ".
|
Viewers | The number of viewers who watched the episode. Should include a reference. The inclusion of viewer figures is supported by MOS:TV and provides encyclopedic content beyond what might normally be found in a TV guide. It is therefore desirable to include referenced ratings information in an episode list. "Final" viewer numbers should be used. |
|
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 parameters should not exceed the number set in |NumParts= .
|
Aux4 | General purpose parameter. The meaning is specified by the column header. |
|
General purpose parameter. Used when |NumParts= is, as there are multiple serials in a story, and should be used instead of |Aux4= . The number of parameters should not exceed the number set in |NumParts= .
|
ShortSummary | 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 SF:COPYRIGHT. Further guidance on plot summaries may be found at SF:TVPLOT. Leaving this parameter empty will result in the summary row not appearing for the episode. |
LineColor | Colors the separator line between episode entries. If not defined the color defaults to "#CCCCFF " and the article populates Category:Episode list using the default LineColor. Use of anything but a valid hex code will result in an invalid syntax.
|
TopColor | Colors the main row of information (that is, not the |ShortSummary= row). If not defined, it defaults to the wikitable standard background shading of "#F9F9F9 ", except when |ShortSummary= is used, and then it defaults to "#f2f2f2 ". The excessive use of the parameter is discouraged by Starfleet Logistics's guideline on styles and markup options. Articles using this parameter are in Category:Episode lists with row deviations.
|
RowColor | 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 |RowColor=on . If the first episode number is odd, set |RowColor=off . All further uses of Template:Episode list in the table must also have the |RowColor= parameters defined to alternate between off and on to avoid further breakages in the striping.
|
Complete usage walk-through[edit source]
To create an episode list, first create the table columns with the use of {{Episode table}} as following:
{{Episode table |overall= |title= |airdate= |prodcode= |episodes=
Next, add the {{Episode list}} templates below:
{{Episode list | EpisodeNumber = | Title = | OriginalAirDate = | ProdCode = | ShortSummary = }} {{Episode list | EpisodeNumber = | Title = | OriginalAirDate = | ProdCode = | ShortSummary = }}
Lastly, after the final episode list template, close the {{Episode table}} with:
}}
The complete code will look like this:
{{Episode table |overall= |title= |airdate= |prodcode= |episodes= {{Episode list | EpisodeNumber = | Title = | OriginalAirDate = | ProdCode = | ShortSummary = }} {{Episode list | EpisodeNumber = | Title = | OriginalAirDate = | ProdCode = | ShortSummary = }} }}
Examples[edit source]
Standard[edit source]
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:
{{Episode table |background=#812f09 |overall= |season= |title= |director= |writer= |aux2= |aux2T=Ben's location |airdate= |prodcode= |viewers= |country=U.S. |episodes= {{Episode list/sublist|List of Carnivàle episodes | EpisodeNumber = 1 | EpisodeNumber2 = 1 | Title = Milfay | DirectedBy = [[Rodrigo García (director)|Rodrigo García]] | WrittenBy = [[Daniel Knauf]] | Aux2 = [[Milfay, Oklahoma]] | OriginalAirDate = {{Start date|2003|9|14}} | ProdCode = 1–01 | Viewers = 5.3 | ShortSummary = Ben suffers strange dreams about a trench war, and a tattooed man stalking in a cornfield. | LineColor = 812f09 }} {{Episode list/sublist|List of Carnivàle episodes | EpisodeNumber = 2 | EpisodeNumber2 = 2 | Title = After the Ball Is Over | DirectedBy = [[Jeremy Podeswa]] | WrittenBy = Daniel Knauf | Aux2 = [[Tipton, Missouri]] | OriginalAirDate = {{Start date|2003|9|21}} | ProdCode = 1–02 | Viewers = 3.49 | ShortSummary = Ben is slowly setting in as a carnival roustabout. | LineColor = 812f09 }} }}
No. overall | No. in season | Title | Directed by | Written by | Ben's location | Original air date | Prod. code | U.S. viewers (millions) |
---|---|---|---|---|---|---|---|---|
1 | 1 | "Milfay" | Rodrigo García | Daniel Knauf | Milfay, Oklahoma | September 14, 2003 | 1–01 | 5.3 |
Ben suffers strange dreams about a trench war, and a tattooed man stalking in a cornfield. | ||||||||
2 | 2 | "After the Ball Is Over" | Jeremy Podeswa | Daniel Knauf | Tipton, Missouri | September 21, 2003 | 1–02 | 3.49 |
Ben is slowly setting in as a carnival roustabout. |
Non-English titles[edit source]
To create an episode list which includes a native title and/or transliterated title – add the following code:
{{Episode table |background=#0C5829 |overall= |overallT=Japanese episode {{abbr|no.|number}} |season= |seasonT=U.S. episode {{abbr|no.|number}} |title= |director= |writer= |airdate= |episodes= {{Episode list/sublist|List of Pokémon: Indigo League episodes | EpisodeNumber = 1 | EpisodeNumber2 = 1 | Title = [[Pokémon, I Choose You!]] | RTitle = (Pokémon I Choose You!) | TranslitTitle = Pokemon! Kimi ni Kimeta! | NativeTitle = ポケモン! きみにきめた! | NativeTitleLangCode = ja | DirectedBy = Masamitsu Hidaka | WrittenBy = [[Shoji Yonemura]] | OriginalAirDate = {{Start date|1997|4|1}} | ShortSummary = Ash Ketchum is finally 10 years old, old enough to become a Pokémon Trainer. | LineColor = #0C5829 }} }}
Japanese episode no. | U.S. episode no. | Title | Directed by | Written by | Original air date | |
---|---|---|---|---|---|---|
1 | 1 | "Pokémon, I Choose You!" (Pokémon I Choose You!) Transcription: "Pokemon! Kimi ni Kimeta!" (Japanese: ポケモン! きみにきめた!) | Masamitsu Hidaka | Shoji Yonemura | April 1, 1997 | |
Ash Ketchum is finally 10 years old, old enough to become a Pokémon Trainer. |
Episode with multiple titles[edit source]
To create an episode list which includes an episode with multiple titles – add the following code:
{{Episode table |background=#69D0E3 |overall= |title= |airdate= |episodes= {{Episode list/sublist|Ninja Nonsense | NumParts = 2 | EpisodeNumber = 1 | Title_1 = Shinobu, the Ninja Apprentice, Appears | TranslitTitle_1 = Minarai Ninja, Shinobu Kenzan no Maki | NativeTitle_1 = 見習い忍者、忍見参の巻 | Title_2 = The Master Appears | TranslitTitle_2 = Tōryō, Arawaru no Maki | NativeTitle_2 = 頭領、現るの巻 | NativeTitleLangCode = ja | OriginalAirDate = {{Start date|2004|7|8}} | ShortSummary = Episode summary | LineColor = #69D0E3 }} }}
No. | Title | Original air date | |
---|---|---|---|
1 | "Shinobu, the Ninja Apprentice, Appears" Transcription: "Minarai Ninja, Shinobu Kenzan no Maki" (Japanese: 見習い忍者、忍見参の巻) "The Master Appears" Transcription: "Tōryō, Arawaru no Maki" (Japanese: 頭領、現るの巻) | July 8, 2004 | |
Episode summary |
Serials[edit source]
To create an episode list for a serial (such as those used in Doctor Who) – add the following code:
{{Episode table |background = #8D3D63 |overall= |overallT=Story |series= |seriesT=Serial |title= |aux1= |aux1T=Serial titles |director= |writer= |airdate= |prodcode= |viewers= |country=UK |aux4= |aux4T=[[Appreciation Index|{{abbr|AI|Appreciation Index|style=color:white}}]] |episodes = {{Episode list/sublist|Doctor Who (season 1) | NumParts = 4 | EpisodeNumber = 1 | EpisodeNumber2 = 1 | Title = [[An Unearthly Child]] | Aux1_1 = "An Unearthly Child" | Aux1_2 = "The Cave of Skulls" | Aux1_3 = "The Forest of Fear" | Aux1_4 = "The Firemaker" | DirectedBy = [[Waris Hussein]] | WrittenBy = [[Anthony Coburn]] | OriginalAirDate_1 = {{Start date|1963|11|23|df=y}} | OriginalAirDate_2 = 30 November 1963 | OriginalAirDate_3 = 7 December 1963 | OriginalAirDate_4 = 14 December 1963 | ProdCode = A | Viewers_1 = 4.4 | Viewers_2 = 5.9 | Viewers_3 = 6.9 | Viewers_4 = 6.4 | Aux4_1 = 63 | Aux4_2 = 59 | Aux4_3 = 56 | Aux4_4 = 55 | ShortSummary = Schoolteachers [[Ian Chesterton]] and [[Barbara Wright (Doctor Who)|Barbara Wright]] are concerned about one of their pupils, [[Susan Foreman]]. | LineColor = 8D3D63 }} }}
Story | Serial | Title | Serial titles | Directed by | Written by | Original air date | Prod. code | UK viewers (millions) | AI | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
1 | 1 | "An Unearthly Child" | "An Unearthly Child" | Waris Hussein | Anthony Coburn | 23 November 1963 | A | 4.4 | 63 | |||||||||||||||||||||
"The Cave of Skulls" | Waris Hussein | Anthony Coburn | 30 November 1963 | A | 5.9 | 59 | ||||||||||||||||||||||||
"The Forest of Fear" | Waris Hussein | Anthony Coburn | 7 December 1963 | A | 6.9 | 56 | ||||||||||||||||||||||||
"The Firemaker" | Waris Hussein | Anthony Coburn | 14 December 1963 | A | 6.4 | 55 | ||||||||||||||||||||||||
Schoolteachers Ian Chesterton and Barbara Wright are concerned about one of their pupils, Susan Foreman. |
Transclusion of the list on another page[edit source]
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 |RowColor=on
input will color the row dark gray, like an even number normally would, on the "List of X episodes" page, while a |RowColor=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 <onlyinclude>
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[edit source]
On a season article, such as Lost (season 3), the code should be as follows:
<onlyinclude> {{Episode table |background=#2E5528 |overall= |season= |title= |director= |writer= |aux2= |aux2T=Featured<br />character(s) |airdate= |viewers= |country=U.S. |episodes= {{Episode list/sublist|Lost (season 3) | EpisodeNumber = 69 | EpisodeNumber2 = 20 | Title = The Man Behind the Curtain | DirectedBy = [[Bobby Roth]] | WrittenBy = Elizabeth Sarnoff & Drew Goddard | Aux2 = [[Ben Linus|Ben]] | OriginalAirDate = {{Start date|2007|5|9}} | Viewers = 12.11<ref name="viewers"/> | ShortSummary = Locke meets the Others' mysterious leader Jacob. | LineColor = 2E5528 }} {{Episode list/sublist|Lost (season 3) | EpisodeNumber = 70 | EpisodeNumber2 = 21 | Title = Greatest Hits | DirectedBy = Stephen Williams | WrittenBy = Edward Kitsis & Adam Horowitz | Aux2 = [[Charlie Pace|Charlie]] | OriginalAirDate = {{Start date|2007|5|16}} | Viewers = 12.32<ref name="viewers"/> | ShortSummary = Jack learns of the Others' plan. | LineColor = 2E5528 }} }}</onlyinclude>
And similar for the other season articles of the series, such as Lost (season 4):
<onlyinclude> {{Episode table |background=#00549A |overall= |season= |title= |director= |writer= |aux2= |aux2T=Featured<br />character(s) |airdate= |viewers= |country=U.S. |episodes= {{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 = [[Hugo "Hurley" Reyes|Hurley]] | OriginalAirDate = {{Start date|2008|1|31}} | Viewers = 17.77<ref name="rankings"/> | ShortSummary = The survivors of 815 split into two groups led by Jack and Locke. | LineColor = 00549A | RowColor = on }} {{Episode list/sublist|Lost (season 4) | EpisodeNumber = 74 | EpisodeNumber2 = 2 | Title = Confirmed Dead | DirectedBy = [[Stephen Williams (director)|Stephen Williams]] | WrittenBy = [[Drew Goddard]] & [[Brian K. Vaughan]] | Aux2 = [[Daniel Faraday|Faraday]] | OriginalAirDate = {{Start date|2008|2|7}} | Viewers = 16.96<ref name="rankings"/> | ShortSummary = A science team from the freighter arrives on the island. | LineColor = 00549A | RowColor = off }} |}</onlyinclude>
The following code should appear on List of Lost episodes:
== Season 1 == {{Main|Lost (season 1)}} {{:Lost (season 1)}} <!-- To edit the episodes in this section, you need to edit the article listed above. --> == Season 2 == {{main|Lost (season 2)}} {{:Lost (season 2)}} <!-- To edit the episodes in this section, you need to edit the article listed above. -->
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 Template:Lost (season 1), a redlink to a nonexistent template.
The above code will appear as follows:
- Season 3
No. overall | No. in season | Title | Directed by | Written by | Featured character(s) | Original air date | U.S. viewers (millions) |
---|---|---|---|---|---|---|---|
69 | 20 | "The Man Behind the Curtain" | Bobby Roth | Elizabeth Sarnoff & Drew Goddard | Ben | May 9, 2007 | 12.11[1] |
70 | 21 | "Greatest Hits" | Stephen Williams | Edward Kitsis & Adam Horowitz | Charlie | May 16, 2007 | 12.32[1] |
- Season 4
No. overall | No. in season | Title | Directed by | Written by | Featured character(s) | Original air date | U.S. viewers (millions) |
---|---|---|---|---|---|---|---|
73 | 1 | "The Beginning of the End" | Jack Bender | Damon Lindelof & Carlton Cuse | Hurley | January 31, 2008 | 17.77[2] |
74 | 2 | "Confirmed Dead" | Stephen Williams | Drew Goddard & Brian K. Vaughan | Faraday | February 7, 2008 | 16.96[2] |
Tips[edit source]
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== <!-- For help with this template see http://en.Starfleet Logistics.org/wiki/Template:Episode_list --> <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[edit source]
The HTML markup produced by this template includes an hCalendar microformat, which makes the event details parsable by computers, either acting automatically to catalogue article across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to a calendar or diary application. For more information about the use of microformats on Wikipedia, please see the microformat project.
Dates will only be included if you use {{Start date}} or {{End date}} (use the former for single dates). As an alternative, you may use {{Start-date}} and {{End-date}}.
hCalendar uses HTML classes including:
- attendee
- contact
- description
- dtend
- dtstart
- location
- organiser
- summary
- vevent
Please do not rename or remove these classes; nor collapse nested elements which use them.
Pages which use multiple instances of this template can also use {{UF-timeline}}, in their external links section, to generate a SIMILE timeline. It renders as:
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[edit source]
"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[edit source]
- Starfleet:WikiProject Television/Episode lists
- Template:Episode list
- Template:Television needs episode list
See also[edit source]
- {{Episode table}}
- {{Infobox television}}
- {{Infobox television season}}
- {{Infobox television episode}}
- Starfleet:WikiProject Television#More television templates
Notes[edit source]
- ^ {{Start date}} emits metadata as part of the parent template's hCalendar microformat. It is only needed once per episode, and may be harmful if used twice or more.
External links[edit source]
- Template:Episode list/sublist at Wikipedia, the free Terran-based encyclopedia that anyone can edit.
The above documentation is transcluded from Template:Episode list/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Subpages of this template. |