Mob: Created page with "{{Documentation subpage}} {{TOC limit|3}} == Usage == The purpose of the '''{{tl|Television episode ratings}}''' template is to add a formatted ratings table to pages for television series, specifically either the main article, list of episodes article, or individual season articles, displaying the ratings for each episode of a season, for..."

2024-01-15T02:20:18Z

Created page with "{{Documentation subpage}}  {{TOC limit|3}} == Usage == The purpose of the '''{{tl|Television episode ratings}}''' template is to add a formatted ratings table to pages for television series, specifically either the main article, list of episodes article, or individual season articles, displaying the ratings for each episode of a season, for..."

New page

{{Documentation subpage}}

{{TOC limit|3}}

== Usage ==
The purpose of the '''{{tl|Television episode ratings}}''' template is to add a formatted ratings table to pages for television series, specifically either the main article, list of episodes article, or individual season articles, displaying the ratings for each episode of a season, for up to 50 episodes. The template can start from the [[0th]] episode, in the case of a special episode preceding the first episode.

===Syntax===
<syntaxhighlight lang="wikitext">{{Television episode ratings
| title = TEXT
| width = NUMBER
| fontsize = NUMBER

| show_series = TEXT
| show_timeslot = TEXT
| noshare = TEXT
| hide_rs = TEXT
| hide_viewers = TEXT
| hide_dvr = TEXT
| hide_dvrv = TEXT
| hide_total = TEXT
| hide_totalv = TEXT
| refs_col = TEXT

| n{0-50} = TEXT
| series{0-5} = TEXT
| title{0-50} = TEXT
| date{0-50} = DATE
| timeslot{0-50} = TEXT
| timeslot_length{0-50} = NUMBER
| rs{0-50} = NUMBER
| rsds{0-50} = NUMBER
| viewers{0-50} = NUMBER
| dvr{0-50} = NUMBER
| dvrv{0-50} = NUMBER
| total{0-50} = NUMBER
| totalv{0-50} = NUMBER
| ref{0-50} = REFERENCE
| next{0-50} = TEXT
}}</syntaxhighlight>

===Examples===

====Basic example====
{{collapse top|Code}}
<syntaxhighlight lang="wikitext">{{Television episode ratings
| title1 = [[#ep1|Pilot]]
| date1 = September 22, 2014
| rs1 = 3.2/9
| viewers1 = 13.83
| dvr1 = 1.8
| dvrv1 = 5.32
| total1 = 5.0
| totalv1 = 19.22

| title2 = [[#ep2|Single Point of Failure]]
| date2 = September 29, 2014
| rs2 = 3.1/8
| viewers2 = 13.36
| dvr2 = 1.5
| dvrv2 = 4.56
| total2 = 4.6
| totalv2 = 17.94

| title3 = [[#ep3|A Cyclone]]
| date3 = October 6, 2014
| rs3 = 2.6/7
| viewers3 = 12.05
| dvr3 = 1.3
| dvrv3 = 4.49
| total3 = 3.9
| totalv3 = 16.54

| title4 = [[#ep4|Shorthanded]]
| date4 = October 13, 2014
| rs4 = 2.4/6
| viewers4 = 11.51
| dvr4 = 1.2
| dvrv4 = 4.18
| total4 = 3.6
| totalv4 = 15.69
}}</syntaxhighlight>
{{collapse bottom}}

{{Television episode ratings
| title1 = [[#ep1|Pilot]]
| date1 = September 22, 2014
| rs1 = 3.2/9
| viewers1 = 13.83
| dvr1 = 1.8
| dvrv1 = 5.32
| total1 = 5.0
| totalv1 = 19.22

| title2 = [[#ep2|Single Point of Failure]]
| date2 = September 29, 2014
| rs2 = 3.1/8
| viewers2 = 13.36
| dvr2 = 1.5
| dvrv2 = 4.56
| total2 = 4.6
| totalv2 = 17.94

| title3 = [[#ep3|A Cyclone]]
| date3 = October 6, 2014
| rs3 = 2.6/7
| viewers3 = 12.05
| dvr3 = 1.3
| dvrv3 = 4.49
| total3 = 3.9
| totalv3 = 16.54

| title4 = [[#ep4|Shorthanded]]
| date4 = October 13, 2014
| rs4 = 2.4/6
| viewers4 = 11.51
| dvr4 = 1.2
| dvrv4 = 4.18
| total4 = 3.6
| totalv4 = 15.69
}}

====Extra options====
Hiding columns, Width, Font size, Timeslot, TBD & N/A cells, References, Multiple episodes
{{collapse top|Code}}
<syntaxhighlight lang="wikitext">{{Television episode ratings
| width = 100
| fontsize = 90

| show_timeslot = y
| hide_rs = y
| hide_dvr = y
| hide_total = y
| refs_col = y

| title1 = [[#ep1|Pilot]]
| date1 = September 22, 2014
| timeslot1 = Monday 8:00 p.m.
| viewers1 = 13.83
| dvrv1 = 5.32
| totalv1 = 19.22
| ref1 = {{dummyref|1}}

| title2 = [[#ep2|Single Point of Failure]]
| date2 = September 23, 2014
| timeslot2 = Tuesday 8:00 p.m.
| timeslot_length2 = 2
| viewers2 = 13.36
| dvrv2 = 4.56
| totalv2 = 17.94
| ref2 = {{dummyref|2}}

| title3 = [[#ep3|A Cyclone]]
| date3 = September 30, 2014
| viewers3 = 12.05
| dvrv3 = 4.49
| totalv3 = 16.54
| ref3 = {{dummyref|3}}

| title4 = [[#ep4|Shorthanded]]
| date4 = October 6, 2014
| timeslot4 = Monday 8:00 p.m.
| dvrv4 = n/a
| totalv4 = n/a
| next4 = y
}}</syntaxhighlight>
{{collapse bottom}}

{{Television episode ratings
| width = 100
| fontsize = 90

| show_timeslot = y
| hide_rs = y
| hide_dvr = y
| hide_total = y
| refs_col = y

| title1 = [[#ep1|Pilot]]
| date1 = September 22, 2014
| timeslot1 = Monday 8:00 p.m.
| viewers1 = 13.83
| dvrv1 = 5.32
| totalv1 = 19.22
| ref1 = {{dummyref|1}}

| title2 = [[#ep2|Single Point of Failure]]
| date2 = September 23, 2014
| timeslot2 = Tuesday 8:00 p.m.
| timeslot_length2 = 2
| viewers2 = 13.36
| dvrv2 = 4.56
| totalv2 = 17.94
| ref2 = {{dummyref|2}}

| title3 = [[#ep3|A Cyclone]]
| date3 = September 30, 2014
| viewers3 = 12.05
| dvrv3 = 4.49
| totalv3 = 16.54
| ref3 = {{dummyref|3}}

| title4 = [[#ep4|Shorthanded]]
| date4 = October 6, 2014
| timeslot4 = Monday 8:00 p.m.
| dvrv4 = n/a
| totalv4 = n/a
| next4 = y
}}

== Parameters==
{| class="wikitable"
|+Template parameters
! scope="col" | Type
! scope="col" colspan="2" | Parameter
! scope="col" | Description
! scope="col" | Type
! scope="col" | Status
|-
! scope="row" | Title
| Title
| title
| The title of the series in the table's caption, which uses {{tl|Screen reader-only}} to not be displayed in a browser but be voiced by a screen reader, defaults to the page name. Set this parameter (in plain text) to change the series' title if it should not be the page name. ''Format'': Text
| Text
| Optional
|-
! scope="row" | Show caption
| Show caption
| show_caption
| To override {{tl|Screen reader-only}} and display the caption in a browser, especially when the table is not directly below a heading. ''Format'': y
| Text
| Optional
|-
! scope="row" | Width
| Width
| width
| Width of the ratings table, as a percentage without the % sign, if it is required to be something other than the automatic width. ''Format'': 100
| Number
| Optional
|-
! scope="row" | Font size
| Font size
| fontsize
| Font size of the ratings table, as a percentage without the % sign, if it is required to be something other than the automatic size. ''Format'': 100
| Number
| Optional
|-
! scope="row" rowspan="10" | Toggle Columns
| Series
| show_series
| Whether or not to show the "Series" column instead of the "title" column. ''Format'': y
| Text
| Optional
|-
| Timeslot
| show_timeslot
| Whether or not to show the Timeslot column, if it is required. This field should only be used for shows that frequently change timeslots, such as reality shows; do not use for one-offs, such as special timeslot premieres, finales, or crossover episodes. ''Format'': y
| Text
| Optional
|-
| Rating/share
| hide_rs
| Whether or not to hide the Rating/share column, if it is not required. ''Format'': y
| Text
| Optional
|-
| Viewers
| hide_viewers
| Whether or not to hide the Viewers column, if it is not required. ''Format'': y
| Text
| Optional
|-
| DVR
| hide_dvr
| Whether or not to hide the DVR column, if it is not required. ''Format'': y
| Text
| Optional
|-
| DVR viewers
| hide_dvrv
| Whether or not to hide the DVR viewers column, if it is not required. ''Format'': y
| Text
| Optional
|-
| Total
| hide_total
| Whether or not to hide the Total column, if it is not required. ''Format'': y
| Text
| Optional
|-
| Total viewers
| hide_totalv
| Whether or not to hide the Total viewers column, if it is not required. ''Format'': y
| Text
| Optional
|-
| References
| refs_col
| Whether or not to show the unsortable ending References column, if it is required. ''Format'': y
| Text
| Optional
|-
| No Share
| noshare
| Inclusion removes "/share" from the [[Nielsen ratings|Rating/share]] column header, changing it to [[Nielsen ratings|Rating]], especially for use with cable series. ''Format'': y
| Text
| Optional
|-
! scope="row" rowspan="15" | Values
| Number
| n{0-5}
| Allow for modification of the number entry, in the case of a special or different numbering scheme.
| Text
| Optional
|-
| TV series name
| series{0-5}
| The name of the TV series. Used in articles like "[[Elseworlds (Arrowverse)|Elseworlds]]"
| Text
| Required
|-
| Title
| title{0-50}
| The title of the episode, linked to the ratings part of the episode article if exists. ''Format'': <nowiki>[[Pilot#ep1|Pilot]]</nowiki>
| Link
| Required
|-
| Date
| date{0-50}
| The date that the episode originally aired, matching the date in the episode table. ''Format'': September 22, 2014 ''Note'': Using {{tl|Start date}} does not allow for correct sorting of dates.
| Date
| Required
|-
| Timeslot
| timeslot{0-50}
| The timeslot for the episode, including the day of the week and hour. ''Format'': Wednesday 9:00 pm
| Text
| Optional
|-
| Timeslot length
| timeslot_length{0-50}
| How many consecutive episodes that the series has stayed in the same timeslot for. ''Format'': 2 ''Exclusion'': 1
| Number
| Optional
|-
| Rating/share
| rs{0-50}
| The rating/share for the episode, sourced accordingly. ''Format'': 3.2/9 ''Exclusion'': {{tlx|N/A|TBD}} or {{tlx|N/A}} when set to ''n/a''
| Number
| Optional
|-
| Rating/share data sort
| rsds{0-50}
| Manually set the datasort value for rating/share data. ''Format'': 123
| Number
| Optional
|-
| Viewers
| style="white-space:nowrap" | viewers{0-50}
| The viewers (in millions) for the episode, sourced accordingly. ''Format'': 13.83 ''Exclusion'': {{tlx|N/A|TBD}} or {{tlx|N/A}} when set to ''n/a''
| Number
| Optional
|-
| DVR
| dvr{0-50}
| The DVR rating for the episode, sourced accordingly. ''Format'': 1.8 ''Exclusion'': {{tlx|N/A|TBD}} or {{tlx|N/A}} when set to ''n/a''
| Number
| Optional
|-
| DVR viewers
| dvrv{0-50}
| The DVR viewers for the episode, sourced accordingly. ''Format'': 5.32 ''Exclusion'': {{tlx|N/A|TBD}} or {{tlx|N/A}} when set to ''n/a''
| Number
| Optional
|-
| Total
| total{0-50}
| The total rating for the episode, sourced accordingly. ''Format'': 5.0 ''Exclusion'': {{tlx|N/A|TBD}} or {{tlx|N/A}} when set to ''n/a''
| Number
| Optional
|-
| Total viewers
| totalv{0-50}
| The total viewers for the episode, sourced accordingly. ''Format'': 19.22 ''Exclusion'': {{tlx|N/A|TBD}} or {{tlx|N/A}} when set to ''n/a''
| Number
| Optional
|-
| References
| ref{0-50}
| The reference for viewer values for the episode; they will only if the References column is included. ''Format'': Typical reference
| Reference
| Optional
|-
| Next episode
| next{0-50}
| Determine whether the ratings apply for two episodes under the same name, and if so, list the episode number as "x/x+1". ''Format'': y ''Example'': {{para|next4|y}} will display the fourth episode's number as "4/5".
| Text
| Optional
|}

== Related templates ==
* {{tl|Australian television episode ratings}}

<includeonly>{{Sandbox other||

[[Category:Television ratings templates|Episode]]
}}</includeonly>

Template:Television episode ratings/doc - Revision history