Template:Series overview/doc
From Ava Zinn Wiki
 |
This is a documentation subpage for Template:Series overview. It contains usage information, categories and other content that is not part of the original template page. |
 |
This template is used on 3,200+ pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
|
This template uses (or will be using) Lua programming language.
Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates. |
Contents
Usage[edit]
The purpose of this template is to easily add a series overview table (as per WP:TVOVERVIEW) for television series' that require it, in either a simple format (i.e. just episodes and dates) or with extra information (e.g. networks, ratings, etc).
Syntax[edit]
Main overview[edit]
{{Series overview
| seasonT = TEXT
| caption = TEXT
| infoheader = TEXT
| info{A-Z} = TEXT
| color* = COLOR
| link* = TEXT
| linkT* = TEXT
| linkR* = TEXT
| aux{A-Z}* = TEXT
| episodes* = NUMBER
| start* = DATE
| end* = DATE
| network* = TEXT
| info{A-Z}* = TEXT
}}
Specials[edit]
Singular[edit]
{{Series overview
| color*S = COLOR
| link*S = TEXT
| linkT*S = TEXT
| linkR*S = TEXT
| aux{A-Z}*S = TEXT
| episodes*S = NUMBER
| start*S = DATE
| end*S = DATE
| network*S = TEXT
| info{A-Z}*S = TEXT
}}
Multiple[edit]
{{Series overview
| color*S{A-Z} = COLOR
| link*S{A-Z} = TEXT
| linkT*S{A-Z} = TEXT
| linkR*S{A-Z} = TEXT
| aux{A-Z}*S{A-Z} = TEXT
| episodes*S{A-Z} = NUMBER
| start*S{A-Z} = DATE
| end*S{A-Z} = DATE
| network*S{A-Z} = TEXT
| info{A-Z}*S{A-Z} = TEXT
}}
Split season[edit]
{{Series overview
| color* = COLOR
| link* = TEXT
| linkT* = TEXT
| linkR* = TEXT
| aux{A-Z}* = TEXT
| episodes* = NUMBER
| network* = TEXT
| info{A-Z}* = TEXT
| color*{A-Z} = COLOR
| aux{A-Z}*{A-Z} = TEXT
| episodes*{A-Z} = NUMBER
| start*{A-Z} = DATE
| end*{A-Z} = DATE
| network*{A-Z} = TEXT
| info{A-Z}*{A-Z} = TEXT
}}
* indicates any number that is a positive integer, starting from one for regular/split seasons, and zero for specials.
Examples[edit]
Basic example[edit]
| Code |
|---|
{{Series overview
| color1 = #74E387
| link1 = #Season 1
| episodes1 = 26
| start1 = {{Start date|2012|9|8}}
| end1 = {{End date|2013|6|15}}
| color2 = #004000
| link2 = #Season 2
| episodes2 = 26
| start2 = {{Start date|2013|9|13}}
| end2 = {{End date|2014|6|21}}
| color3 = #000000
| link3 = #Season 3
| episodes3 = 26
| start3 = {{Start date|2014|9|19}}
| end3 = {{End date|2015|6|26}}
}}
|
| Season | Episodes | Originally aired | ||
|---|---|---|---|---|
| First aired | Last aired | |||
| 1 | 26 | September 8, 2012 | June 15, 2013 | |
| 2 | 26 | September 13, 2013 | June 21, 2014 | |
| 3 | 26 | September 19, 2014 | June 26, 2015 | |
Alternate link text with caption and raw link text[edit]
| Code |
|---|
{{Series overview
| caption = Series overview
| color1 = #74E387
| link1 = #Season 1
| linkT1 = Chapter One
| episodes1 = 26
| start1 = {{Start date|2012|9|8}}
| end1 = {{End date|2013|6|15}}
| color2 = #004000
| link2 = #Season 2
| linkT2 = Chapter Two
| episodes2 = 26
| start2 = {{Start date|2013|9|13}}
| end2 = {{End date|2014|6|21}}
| color3 = #000000
| link3 = #Season 3
| linkT3 = Chapter Three
| linkR3 = {{dummy ref|1}}
| episodes3 = 26
| start3 = {{Start date|2014|9|19}}
| end3 = {{End date|2015|6|26}}
}}
|
| Season | Episodes | Originally aired | ||
|---|---|---|---|---|
| First aired | Last aired | |||
| 1 | 26 | September 8, 2012 | June 15, 2013 | |
| 2 | 26 | September 13, 2013 | June 21, 2014 | |
| 3 | 26 | September 19, 2014 | June 26, 2015 | |
Series/Season & "dd mmm yyyy" dates[edit]
The top-left cell displays either Series or Season, determined if the |df= parameter of the first {{Start date}} template is set. If it is included (|df=y), the cell will display Series, otherwise the cell will display Season. This can be overridden by setting either |seriesT= or |seasonT= to custom text.
| Code |
|---|
{{Series overview
| color1 = #74E387
| link1 = #Season 1
| episodes1 = 26
| start1 = {{Start date|2012|9|8|df=y}}
| end1 = {{End date|2013|6|15|df=y}}
| color2 = #004000
| link2 = #Season 2
| episodes2 = 26
| start2 = {{Start date|2013|9|13|df=y}}
| end2 = {{End date|2014|6|21|df=y}}
| color3 = #000000
| link3 = #Season 3
| episodes3 = 26
| start3 = {{Start date|2014|9|19|df=y}}
| end3 = {{End date|2015|6|26|df=y}}
}}
|
| Season | Episodes | Originally aired | ||
|---|---|---|---|---|
| First aired | Last aired | |||
| 1 | 26 | 8 September 2012 | 15 June 2013 | |
| 2 | 26 | 13 September 2013 | 21 June 2014 | |
| 3 | 26 | 19 September 2014 | 26 June 2015 | |
Split season[edit]
| Code |
|---|
{{Series overview
| color1 = #74E387
| link1 = #Season 1
| episodes1 = 26
| start1 = {{Start date|2012|9|8}}
| end1 = {{End date|2013|6|15}}
| color2 = #004000
| link2 = #Season 2
| episodes2 = 26
| start2 = {{Start date|2013|9|13}}
| end2 = {{End date|2014|6|21}}
| link3 = #Season 3
| episodes3 = 38
| color3A = #000000
| episodes3A = 13
| start3A = {{Start date|2014|9|19}}
| end3A = {{End date|2014|12|24}}
| color3B = #00004A
| episodes3B = 12
| start3B = {{Start date|2015|2|15}}
| end3B = {{End date|2015|6|26}}
| color3C = #00008A
| episodes3C = 13
| start3C = {{Start date|2015|11|4}}
| end3C = {{End date|2016|1|31}}
}}
|
| Season | Episodes | Originally aired | ||
|---|---|---|---|---|
| First aired | Last aired | |||
| 1 | 26 | September 8, 2012 | June 15, 2013 | |
| 2 | 26 | September 13, 2013 | June 21, 2014 | |
| 3 | 38 | TBA | TBA | |
Specials[edit]
| Code |
|---|
{{Series overview
| color1 = #74E387
| link1 = #Season 1
| episodes1 = 26
| start1 = {{Start date|2012|9|8}}
| end1 = {{End date|2013|6|15}}
| color2 = #004000
| link2 = #Season 2
| episodes2 = 26
| start2 = {{Start date|2013|9|13}}
| end2 = {{End date|2014|6|21}}
| color3 = #000000
| link3 = #Season 3
| episodes3 = 26
| start3 = {{Start date|2014|9|19}}
| end3 = {{End date|2015|6|26}}
| color3S = #00004A
| link3S = #Special
| linkT3S = S
| episodes3S = 1
| start3S = {{Start date|2015|10|21}}
}}
|
| Season | Episodes | Originally aired | ||
|---|---|---|---|---|
| First aired | Last aired | |||
| 1 | 26 | September 8, 2012 | June 15, 2013 | |
| 2 | 26 | September 13, 2013 | June 21, 2014 | |
| 3 | 26 | September 19, 2014 | June 26, 2015 | |
And with the |episodes parameter removed and the link text changed.
| Season | Episodes | Originally aired | ||
|---|---|---|---|---|
| First aired | Last aired | |||
| 1 | 26 | September 8, 2012 | June 15, 2013 | |
| 2 | 26 | September 13, 2013 | June 21, 2014 | |
| 3 | 26 | September 19, 2014 | June 26, 2015 | |
Special first, followed by season one[edit]
| Code |
|---|
{{Series overview
| color0S = #00004A
| link0S = #Special
| linkT0S = S
| episodes0S = 1
| start0S = {{Start date|2011|10|21}}
| color1 = #74E387
| link1 = #Season 1
| episodes1 = 26
| start1 = {{Start date|2012|9|8}}
| end1 = {{End date|2013|6|15}}
| color2 = #004000
| link2 = #Season 2
| episodes2 = 26
| start2 = {{Start date|2013|9|13}}
| end2 = {{End date|2014|6|21}}
| color3 = #000000
| link3 = #Season 3
| episodes3 = 26
| start3 = {{Start date|2014|9|19}}
| end3 = {{End date|2015|6|26}}
}}
|
| Season | Episodes | Originally aired | ||
|---|---|---|---|---|
| First aired | Last aired | |||
| 1 | 26 | September 8, 2012 | June 15, 2013 | |
| 2 | 26 | September 13, 2013 | June 21, 2014 | |
| 3 | 26 | September 19, 2014 | June 26, 2015 | |
Extra information[edit]
| Code |
|---|
{{Series overview
| infoheader = [[Nielsen ratings]]
| infoA = Rank
| infoB = Rating
| infoC = Average viewership<br />(in millions)
| color1 = #74E387
| link1 = #Season 1
| episodes1 = 26
| start1 = {{Start date|2012|9|8}}
| end1 = {{End date|2013|6|15}}
| infoA1 = 55
| infoB1 = 11.8
| infoC1 = 3.2
| color2 = #004000
| link2 = #Season 2
| episodes2 = 26
| start2 = {{Start date|2013|9|13}}
| end2 = {{End date|2014|6|21}}
| infoA2 = 65
| infoB2 = 9.2
| color3 = #000000
| link3 = #Season 3
| episodes3 = 26
| start3 = {{Start date|2014|9|19}}
| end3 = {{End date|2015|6|26}}
| infoA3 = 63
}}
|
| Season | Episodes | Originally aired | Nielsen ratings | ||||||
|---|---|---|---|---|---|---|---|---|---|
| First aired | Last aired | Rank | Rating | Average viewership (in millions) | |||||
| 1 | 26 | September 8, 2012 | June 15, 2013 | ||||||
| 2 | 26 | September 13, 2013 | June 21, 2014 | ||||||
| 3 | 26 | September 19, 2014 | June 26, 2015 | ||||||
Single column with only the |infoheader parameter.
| Season | Episodes | Originally aired | Average viewership (in millions) | ||
|---|---|---|---|---|---|
| First aired | Last aired | ||||
| 1 | 26 | September 8, 2012 | June 15, 2013 | ||
| 2 | 26 | September 13, 2013 | June 21, 2014 | ||
| 3 | 26 | September 19, 2014 | June 26, 2015 | ||
Multiple networks[edit]
| Code |
|---|
{{Series overview
| color1 = #74E387
| link1 = #Season 1
| episodes1 = 26
| start1 = {{Start date|2012|9|8}}
| end1 = {{End date|2013|6|15}}
| network1 = [[The WB]]
| color2 = #004000
| link2 = #Season 2
| episodes2 = 26
| start2 = {{Start date|2013|9|13}}
| end2 = {{End date|2014|6|21}}
| color3 = #000000
| link3 = #Season 3
| episodes3 = 26
| start3 = {{Start date|2014|9|19}}
| end3 = {{End date|2015|6|26}}
| network3 = [[The CW]]
}}
|
| Season | Episodes | Originally aired | ||
|---|---|---|---|---|
| First aired | Last aired | |||
| 1 | 26 | September 8, 2012 | June 15, 2013 | |
| 2 | 26 | September 13, 2013 | June 21, 2014 | |
| 3 | 26 | September 19, 2014 | June 26, 2015 | |
Auxiliary columns[edit]
| Code |
|---|
{{Series overview
| auxA = Title
| auxB = Stories
| color1 = #74E387
| link1 = #Season 1
| auxA1 = ''First''
| auxB1 = 13
| episodes1 = 26
| start1 = {{Start date|2012|9|8}}
| end1 = {{End date|2013|6|15}}
| color2 = #004000
| link2 = #Season 2
| auxA2 = ''Second''
| auxB2 = 14
| episodes2 = 26
| start2 = {{Start date|2013|9|13}}
| end2 = {{End date|2014|6|21}}
| color3 = #000000
| link3 = #Season 3
| auxA3 = ''Third''
| auxB3 = 15
| episodes3 = 26
| start3 = {{Start date|2014|9|19}}
| end3 = {{End date|2015|6|26}}
}}
|
| Season | Episodes | Originally aired | ||
|---|---|---|---|---|
| First aired | Last aired | |||
| 1 | 26 | September 8, 2012 | June 15, 2013 | |
| 2 | 26 | September 13, 2013 | June 21, 2014 | |
| 3 | 26 | September 19, 2014 | June 26, 2015 | |
Released[edit]
| Code |
|---|
{{Series overview
| released = y
| color1 = #74E387
| link1 = #Season 1
| episodes1 = 26
| start1 = {{Start date|2012|9|8}}
| end1 = start
| color2 = #004000
| link2 = #Season 2
| episodes2 = 26
| start2 = {{Start date|2013|9|13}}
| end2 = {{End date|2014|6|21}}
| color3 = #000000
| link3 = #Season 3
| episodes3 = 26
| start3 = {{Start date|2014|9|19}}
| end3 = start
}}
|
| Season | Episodes | Originally aired | ||
|---|---|---|---|---|
| First aired | Last aired | |||
| 1 | 26 | September 8, 2012 | start | |
| 2 | 26 | September 13, 2013 | June 21, 2014 | |
| 3 | 26 | September 19, 2014 | start | |
End dates omitted with the |allreleased parameter set.
| Season | Episodes | Originally aired | ||
|---|---|---|---|---|
| First aired | Last aired | |||
| 1 | 26 | September 8, 2012 | TBA | |
| 2 | 26 | September 13, 2013 | TBA | |
| 3 | 26 | September 19, 2014 | TBA | |
Parameters[edit]
|
Key for alternate rows: |
= Parameter available for split seasons as {parameter}* and {parameter}*{A-Z} |
= Parameter available for split seasons only as {parameter}*{A-Z} |
= Parameter available for specials as {parameter}*S or {parameter}*S{A-Z} |
| Parameter | Description | Type | Status | ||
|---|---|---|---|---|---|
| Caption | caption | An appropriate caption for the table, normally something like "Series overview". Required if the table is not the first or only item in the section. When a caption is not required on the page where the table is located, but is on a page where the table is transcluded, the caption may be wrapped in <includeonly> and </includeonly>. | Text | Optional | |
| Header titles | Season/Series | seasonT | Set to change custom text in the cell where Series/Season is typically displayed. Format: Series Alternate: seriesT |
Text | Optional |
| Info header | infoheader | The header of the extra information (e.g. Nielsen ratings) for the series in question. If there is only one extra column of extra info, use this parameter. Format: Nielsen ratings |
Text | Optional | |
| Info sub-headers | info{A-Z} | The sub-headers of the extra information (e.g. Viewers (in millions)) for the series in question. 26 columns are available for extra information (labelled infoA ... infoZ). Format: Viewers (in millions) |
Text | Optional | |
| Auxiliary | aux{A-Z} | The titles of the auxiliary columns. 26 columns are available for auxiliary columns (labelled auxA ... auxZ). Format: Title |
Text | Optional | |
| Season specifics | Color | color* | The color of the season table for the season in question. Format: black / #000000 |
Color | Required |
| Link | link* | The link to the season in question. Transclusion format: <includeonly>List of iZombie episodes</includeonly>#Season 1 (2015) Non-transclusion format: #Season 1 (2015) |
Text | Required | |
| Link Text | linkT* | Alternate text to display in the season link rather than the season number. Format: Special |
Text | Optional | |
| Raw Link Text | linkR* | Additional text to display next to the season link, outside of the link itself. Good for references or notes. Format: {{efn}} |
Text | Optional | |
| Auxiliary | aux{A-Z}* | Auxiliary columns for season titles, etc. This column spans rows when succeeding auxiliary parameters are not set. Format: Coven |
Text | Optional | |
| Episodes | episodes* | The number of episodes in the season in question. Format: 22 Exclusion: {{N/A|TBA}}
|
Number | Optional | |
| Start date | start* | The start date of the season in question. Format: {{Start date|2015|3|17}}Exclusion: {{N/A|TBA}}
|
Date | Optional | |
| End date | end* | The end date of the season in question. If equal to start (i.e. the season was aired/released on the same day), the date spans over two columns. Not included if the "allreleased" parameter is set. Format: {{End date|2015|6|9}}Exclusion: {{N/A|TBA}}
|
Date/Text | Optional | |
| Network | network* | The network that multiple seasons have aired under, if a series has aired on two or more networks. The span of the network column is calculated automatically. Format: ABC |
Text | Optional | |
| Info | info{A-Z}* | The values of the extra information (e.g. Ratings) for the season in question. Note: Information cell parameters will be automatically set to {{N/A|TBA}} if set for a previous season (e.g. info1A) but not included for the current season (e.g. info2A).Format: 28 |
Text | Optional | |
| Release | Released | released | Determines whether the television series in question was released online or aired. Changes "Originally/First/Last aired" to "Originally/First/Last released". Format: y |
Text | Optional |
| All Released | allreleased | Determines whether the television series has all episodes in every season released on the same day (e.g. Orange Is the New Black). Format: y |
Text | Optional | |
* indicates any number that is a positive integer, starting from one for regular/split seasons, and zero for specials.
