Template:Episode table/doc
This is a documentation subpage for Template:Episode table. It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
This template uses Module:Episode table, a script written in the Lua programming language. Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates. |
Usage
The purpose of the {{Episode table}} template is to easily add header row to episode tables for television series, with up to 13 different columns, and optionally set the widths of these columns, and includes the {{Episode list}} template in the "episode" parameter. Cells are included by declaring the specific variable in one of two ways: title=
includes the "Title" cell with no set width, and title=30
includes the "Title" cell with a width of 30%.
Syntax
Parameters |
---|
{{Episode table |caption = TEXT |background = COLOR |total_width = WIDTH |overall = WIDTH |series = WIDTH |season = WIDTH |title = WIDTH |aux1 = WIDTH |director = WIDTH |writer = WIDTH |aux2 = WIDTH |aux3 = WIDTH |airdate = WIDTH |altdate = WIDTH |prodcode = WIDTH |viewers = WIDTH |aux4 = WIDTH |country = COUNTRY |released = TEXT |viewers_type = TEXT |overallT = TEXT |seriesT = TEXT |seasonT = TEXT |titleT = TEXT |aux1T = TEXT |directorT = TEXT |writerT = TEXT |aux2T = TEXT |aux3T = TEXT |airdateT = TEXT |altdateT = TEXT |prodcodeT = TEXT |viewersT = TEXT |aux4T = TEXT |overallR = REFERENCE |seriesR = REFERENCE |seasonR = REFERENCE |titleR = REFERENCE |aux1R = REFERENCE |directorR = REFERENCE |writerR = REFERENCE |aux2R = REFERENCE |aux3R = REFERENCE |airdateR = REFERENCE |altdateR = REFERENCE |prodcodeR = REFERENCE |viewersR = REFERENCE |aux4R = REFERENCE |episodes = EPISODE LISTS/PART ROWS }} |
Examples
- Standard columns:
{{Episode table|caption=This is a caption|background=#B40000 |overall=5 |season=5 |title=17 |director=11 |writer=37 |airdate=10 |prodcode=6 |viewers=9 |country=U.S.}}
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part |
- All columns:
{{Episode table |overall= |season= |title= |aux1= |director= |writer= |aux2= |aux3= |airdate= |altdate= |prodcode= |viewers= |aux4= |country= |aux1T=Foreign title |aux2T=Guest writer |aux3T=Featured character |aux4T=Online viewers |altdateT=UK airdate}}
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part |
- With {{Episode list}}:
Code |
---|
{{Episode table |background = #005F6C |overall = 6 |series = 6 |title = 20 |director = 14 |writer = 15 |airdate = 16 |prodcode = 8 |viewers = 9 |aux4 = 6 |country = UK |overallT = Story |seriesT = Episode |aux4T = AI |aux4R = {{dummyref}} |episodes = {{Episode list |EpisodeNumber = 203 |EpisodeNumber2 = 1 |Title = [[The Eleventh Hour (Doctor Who)|The Eleventh Hour]] |DirectedBy = Adam Smith |WrittenBy = [[Steven Moffat]] |OriginalAirDate = {{Start date|2010|4|3|df=y}} |ProdCode = 1.1 |Viewers = 10.09 |Aux4 = 86 |LineColor = 005F6C }} {{Episode list |EpisodeNumber = 204 |EpisodeNumber2 = 2 |Title = [[The Beast Below]] |DirectedBy = [[Andrew Gunn (director)|Andrew Gunn]] |WrittenBy = Steven Moffat |OriginalAirDate = {{Start date|2010|4|10|df=y}} |ProdCode = 1.2 |Viewers = 8.42 |Aux4 = 86 |LineColor = 005F6C }} }} |
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
203 | 1 | "The Eleventh Hour" | Adam Smith | Steven Moffat | 3 April 2010 | 1.1 | 10.09 | 86 | ||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
204 | 2 | "The Beast Below" | Andrew Gunn | Steven Moffat | 10 April 2010 | 1.2 | 8.42 | 86 |
Parted seasons
<section begin=parted />For seasons which have been split into parts, use {{Episode table/part}}, as per the examples below.
{{Episode table/part|1|#183E54}}
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part |
{{Episode table/part|Athelstan's Journal|#061453|nopart=y}}
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
Part | ||||||||||||
' |
<section end=parted />
Parameters
Each cell parameter has an alias to match the parameters used in {{Episode list}}. In the Cell Inclusion & Widths rows, the original parameter is listed, followed by its episode-list alias. This means that this:
{{Episode table |background=#B40000 |overall=5 |season=5 |title=17 |director=11 |writer=37 |airdate=10 |prodcode=6 |viewers=9 |country=U.S.}}
will produce exactly the same as this:
{{Episode table |background=#B40000 |EpisodeNumber=5 |EpisodeNumber2=5 |Title=17 |DirectedBy=11 |WrittenBy=37 |OriginalAirDate=10 |ProdCode=6 |Viewers=9 |country=U.S.}}
Parameter | Description | Type | Status | ||
---|---|---|---|---|---|
Table caption | caption | When the table is not the first or only content in the section, a caption should be provided that describes in general the content of the table. e.g. NCIS season 11 episodes
|
Wikitext | Optional | |
Background color | background | The background color of the header row. If no color is specified, the background defaults to #CCCCFF. Format: white / #FFFFFF |
String | Optional | |
Total width | total_width | Table width defaults to 100%. For tables that are less than 100%, set this field as necessary. Format: 75 |
Number | Optional | |
Cell Inclusion & Widths* | Overall Number | overall EpisodeNumber |
The inclusion (and optionally the width) of the "No." / "No. overall" cell. Use |forceoverall=y to force this column to display "No. overall" when season /series is not set.Format: 10 / <blank> |
Number | Optional |
Season | season EpisodeNumber2 |
The inclusion (and optionally the width) of the "No. in season" cell. (Inclusion will set "No." cell to "No. overall" if overallT is unset.) Format: 10 / <blank> Note: "series" and "season" cannot be included in the same table. |
Number | Optional | |
Series | series EpisodeNumber2Series |
The inclusion (and optionally the width) of the "No. in series" cell. (Inclusion will set "No." cell to "No. overall" if overallT is unset.) Format: 10 / <blank> Note: "series" and "season" cannot be included in the same table. |
Number | Optional | |
Title | title Title |
The inclusion (and optionally the width) of the "Title" cell. Format: 10 / <blank> |
Number | Optional | |
Aux1 | aux1 Aux1 |
The inclusion (and optionally the width) of the "Aux1" cell. Format: 10 / <blank> |
Number | Optional | |
Director | director DirectedBy |
The inclusion (and optionally the width) of the "Directed by" cell. Format: 10 / <blank> |
Number | Optional | |
Writer | writer WrittenBy |
The inclusion (and optionally the width) of the "Written by" cell. Format: 10 / <blank> |
Number | Optional | |
Aux2 | aux2 Aux2 |
The inclusion (and optionally the width) of the "Aux2" cell. Format: 10 / <blank> |
Number | Optional | |
Aux3 | aux3 Aux3 |
The inclusion (and optionally the width) of the "Aux3" cell. Format: 10 / <blank> |
Number | Optional | |
Air Date | airdate OriginalAirDate |
The inclusion (and optionally the width) of the "Original air date" cell. Format: 10 / <blank> |
Number | Optional | |
Alternate Air Date | altdate AltDate |
The inclusion (and optionally the width) of the "Alternate Air Date" cell. Format: 10 / <blank> |
Number | Optional | |
Production Code | prodcode ProdCode |
The inclusion (and optionally the width) of the "Production code" cell. Format: 10 / <blank> |
Number | Optional | |
Viewers | viewers Viewers |
The inclusion (and optionally the width) of the "Viewers" cell. Format: 10 / <blank> |
Number | Optional | |
Aux4 | aux4 Aux4 |
The inclusion (and optionally the width) of the "Aux4" cell. Format: 10 / <blank> |
Number | Optional | |
Content | Country | country | The series' originating country; displayed before "viewers". (Exclusion capitalized "Viewers"; inclusion un-capitalizes "viewers".) Format: U.S. |
String | Optional / Unrequired when viewers is not set |
Released/Aired | released | Determines whether the episodes were released online or aired. Changes the "Original air date" cell to "Original release date". Format: y |
String | Optional | |
Viewers type | viewers_type | The numeric format that viewers are grouped within the episode table. Set to "millions" by default. Including the parameter but leaving it blank will disclude the bracketed format. Format: thousands |
String | Optional | |
Variable Content | {variable}T | Custom content of any cell (e.g. overallT, titleT). Format: Any string |
String | Optional / Required when aux{1-4} and altdate set | |
Reference | {variable}R | Reference for any cell (e.g. overallR, titleR). If Wikipedia's link colours are not WCAG 2 AAA Compliant with the background colour, {{Episode table/reference}} is used. Format: Reference |
Reference | Optional | |
Episodes | episodes | An infinite number of consecutive episode rows. Format: {{Episode list}} or {{Episode table/part}} |
Template | Optional, desirable |
*: These variables can be included but not set to a value, e.g. |title=, which will include the cell but not set a width to it.