Template:Infobox television episode/doc
![]() | This is a documentation subpage for Template:Infobox television episode. It may contain usage information, categories and other content that is not part of the original template page. |
![]() | This template is used on approximately 13,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
![]() | This infobox should italicize the article title automatically. If this is not required, add |italic_title=no to the list of parameters. |
![]() | This template adds an automatically generated short description. If the automatic short description is not optimal, replace it by adding {{Short description}} at the top of the article. |
![]() | This template uses Lua: |
![]() | This template uses TemplateStyles: |
Infobox television episode is used to create an infobox which summarizes the main information of a particular television episode or internet video.
Usage
[edit]The infobox may be added by pasting the template as shown below into an article, typically at the top of an article above the lead section. This infobox creates a short description based on the data provided to the infobox. For more information on this, see the documentation at Template:Television episode short description.
"Infobox television episode/doc" | |
---|---|
{{{series}}} episode | |
[[File:{{{image}}}|frameless|alt={{{image_alt}}}|upright=1]] {{{caption}}} | |
Episode no. | Season {{{season}}} Series {{{series no}}} Episode {{{episode}}} |
Directed by | {{{director}}} |
Written by | {{{writer}}} |
Story by | {{{story}}} |
Teleplay by | {{{teleplay}}} |
Based on | {{{based_on}}} |
Narrated by | {{{narrator}}} |
Presented by | {{{presenter}}} |
Featured music | {{{music}}} |
Cinematography by | {{{photographer}}} |
Editing by | {{{editor}}} |
Production code | {{{production}}} |
Original air date | {{{airdate}}} |
Running time | {{{length}}} |
Guest appearance | |
{{{guests}}} | |
{{Infobox television episode
| series = <!-- without italics or formatting. -->
| image = <!-- bare filename only. Wikilinking, "File:", and pixel size not required. -->
| image_size = <!-- raw number. "px" not required. -->
| image_alt =
| caption =
| season =
| series_no =
| episode =
| director =
| writer =
| story =
| teleplay =
| based_on =
| narrator =
| presenter =
| music =
| photographer =
| editor =
| production =
| airdate = <!-- {{Start date|YYYY|MM|DD}} -->
| length =
| guests =
| prev =
| next =
| season_article =
| episode_list =
}}
Maintenance
[edit]If you encounter a usage of the template which you want to quickly restore to the above standard, use {{subst:Infobox television episode/subst}}
.
Parameters
[edit]Link people to their article or redirect. For most of the fields below,[a] if there are multiple entries, separate them using bulleted lists (*
). When adding data to fields, do not use small text as this reduces the size of the text to below 85% of the page font size. See Wikipedia:Manual of Style/Accessibility#Text for more information.
Parameter | Explanation |
---|---|
italic_title | A "no" value will disable the automatic italicization of the series name in the parenthesis. This parameter should not be used most of the time. |
title | The title of the episode. Should not be used if the title is the same as the article title as the infobox handles this automatically. The title is automatically put within quotation marks. If the title should not be in quotation marks, use |rtitle= instead.
|
rtitle | The number of the episode or a descriptive title for the article. Used in situations where the episode does not have a title (such as Episode 1094 or Final episode of The Colbert Report) or an article which covers two episodes (such as Whoami and Hello, Elliot). The title is not styled and has no quotation marks. |
series | The name of the TV series this episode is part of, with a link to the series' main article. Series name is automatically italicized. |
not_dab | A parameter that is used when the series name has parenthesis which are part of the title, such as Randall and Hopkirk (Deceased). |
image | An image, if needed. Wikilinking, "File:", and pixel size not required. Remember, virtually all TV screenshots are copyrighted, so they must be low resolution, and be accompanied by a non-free use rationale. There is no blanket allowance for an image per episode. A non-free screenshot should be used only if it meets the Wikipedia:Non-free content criteria, i.e. typically if it is required to illustrate a crucial element of the episode that is the object of explicit, sourced analytical commentary and where that commentary is in genuine need of visual support. |
image_size | Image size in pixels. Should be 250 or less. If not specified, image defaults to frameless (220px). "px" is not required. |
image_upright | Use of this parameter is preferred to using |image_size= , as it allows auto-sizing of images according to user preferences. By default, the infobox image scales to |image_upright=1 (which is 1 × 220px if the default thumbnail size has not been changed at Special:Preferences). For upright posters, a value of |image_upright=1 is recommended.
The size should not be set to a value that would result in an image width greater than 300px. See help below for guidance on determining the value to be used. |
image_alt | Alt text for image per WP:MOSALT. |
caption | A caption explaining the image. |
season | The number of the season this episode is part of. |
series_no | The number of the series this episode is part of. Use either |season= or |series_no= , but not both. Typically, "series" is used for television series produced within the United Kingdom while "season" is used for American television series.
|
episode | The number of the episode within the season. |
segment | The number or letter of the segment. If the segment is not numbered, use |segment=yes .
|
director | The director(s) of this episode. |
writer | The writer(s) of this episode. |
story | The writer(s) of the episode's story. Use this field instead of the normal writer field if television episodes divide writing credits between teleplay and story writers. |
teleplay | The writer(s) of the episode's teleplay. Use this field instead of the normal writer field if television episodes divide writing credits between teleplay and story writers. |
based_on | The original work the episode is based on. Use {{Based on}} to add the title of the source material and the name(s) of the source material writer(s). Use this field in conjunction with teleplay and story where applicable. This field should be used if the episode is based on previously produced or published material, such as books, plays, articles, old screenplays, etc. and should not be used where the source material is ambiguous. This field should not be used for general adaptations, such as The Flash episodes being based on characters from DC Comics, however, do use it if a specific episode of that series is a direct adaptation of a specific comic. |
narrator | The narrator(s) of this episode. |
presenter | The person who fronts (hosts) the show. |
music | The music of this episode. Use {{Work by author}} to add the title of the song and the name(s) of the song performer. Television episodes often include numerous songs; only include the most notable (typically songs playing during key scenes). |
photographer | The director(s) of photography of this episode. |
editor | The editor(s) of this episode. |
production | The production code or number of this episode. |
airdate | The original airing date of the episode; use {{Start date}}. |
release_date | The original release date of the episode. This should be used for episodes released on streaming services such as Netflix; use {{Start date}}. |
length | The original length of the episode, including credits, in minutes. It should indicate runtime (without commercials), or with commercials. |
guests_title | Text for display in guests header (default = Guest appearance(s)). |
guests | Guest star(s) in the episode. Include the name of the character the guest actor portrays using a single space, "as", and another single space: actor as character .
|
module | An optional parameter to add a nested infobox to. |
prev | The title of the previous episode. If an article or redirect exist, link to it. If one does not exist, consider creating a redirect to the episode anchor in the season article. If a redirect isn't created directly link to the season article with an anchor to that episode. If this is the first episode of the TV series, leave blank. The title is automatically put within quotation marks, unless |rprev= is used.
|
rprev | The number of the previous episode or a descriptive title for the article. If an article or redirect exist, link to it. If one does not exist, consider creating a redirect to the episode anchor in the season article. If a redirect isn't created directly link to the season article with an anchor to that episode. If this is the first episode of the TV series, leave blank. The title is styled without quotation marks. |
next | The title of the next episode. If an article or redirect exist, link to it. If one does not exist, consider creating a redirect to the episode anchor in the season article. If a redirect isn't created directly link to the season article with an anchor to that episode. If this is the last episode of the TV series, leave blank. The title is automatically put within quotation marks, unless |rnext= is used.
|
rnext | The number of the next episode or a descriptive title for the article. If an article or redirect exist, link to it. If one does not exist, consider creating a redirect to the episode anchor in the season article. If a redirect isn't created directly link to the season article with an anchor to that episode. If this is the last episode of the TV series, leave blank. The title is styled without quotation marks. |
season_article | Title of the season article, usually in the form of "<showname> season #" article. Use plain text, the template will automatically format and link the article. |
episode_list | Title of the list of episodes article. Should only be used if the automatically generated link is not correct. If the automatically generated link is a red link, please create the correct redirect. A manual link is usually in the form of "List of <showname> episodes" article. Use plain text, the template will automatically format and link the article. |
Deprecated parameters
[edit]The |awards=
parameter was removed in July 2021 (discussion).
The |producer=
parameter was removed in August 2024 (discussion).
Controlling line-breaking in embedded bulletless lists
[edit]Template {{nbsp}}
may be used with {{wbr}}
and {{nowrap}}
to control line-breaking in bulletless lists embedded in the infobox (e.g. cast and other credits lists), to prevent wrapped long entries from being confused with multiple entries. See Template:Wbr/doc#Controlling line-breaking in infoboxes for details.
Calculating "image_upright"
[edit]The |image_upright=
parameter, and |image2_upright=
and |logo_upright=
where applicable, are provided so as to facilitate the use of scalable images in this infobox, in accordance with the instructions at WP:IMAGESIZE, which advises against the use of "px" (for example: thumb|300px
), as this forces a fixed image width.
Scalable images respect the user's base preference, which may have been selected for that user's particular devices. Module:InfoboxImage, which is used in this infobox, accommodates the use of scaling. However, setting the appropriate scale is slightly more complex than setting a raw "px" value. This guide provides a quick conversion table to make the process of setting a scale easier. It is based on a default thumbnail setting of 220px.
170px
→upright=0.75
180px
→upright=0.8
190px
→upright=0.85
200px
→upright=0.9
210px
→upright=0.95
220px
→upright=1
230px
→upright=1.05
240px
→upright=1.1
250px
→upright=1.15
260px
→upright=1.2
270px
→upright=1.23
280px
→upright=1.25
290px
→upright=1.3
300px
→upright=1.35
TemplateData
[edit]TemplateData documentation used by VisualEditor and other tools
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
See a monthly parameter usage report for Template:Infobox television episode in articles based on its TemplateData.
TemplateData for Infobox television episode Infobox used on articles about television episodes or internet videos.
|
Example
[edit]"Subway" | |
---|---|
Homicide: Life on the Street episode | |
![]() Frank Pembleton talks to John Lange, a man pinned between a subway train and platform. | |
Episode no. | Season 6 Episode 7 |
Directed by | Gary Fleder |
Written by | James Yoshimura |
Cinematography by | Alex Zakrzewski |
Production code | 604 |
Original air date | December 5, 1997 |
Guest appearances | |
| |
{{Infobox television episode
| title = Subway
| series = [[Homicide: Life on the Street]]
| image = NYCSub 7 Vernon Jackson 3.jpg
| image_alt = A man wearing a white shirt and blank pants kneels and speaks to a man in a blue shirt who is pinned between a subway train car and a platform. Emergency equipment lies in front of them, while the obscured figures of firefighters and emergency personnel stand behind them.
| caption = [[Frank Pembleton]] talks to John Lange, a man pinned between a subway train and platform.
| season = 6
| episode = 7
| director = [[Gary Fleder]]
| writer = [[James Yoshimura]]
| photographer = [[Alex Zakrzewski]]
| production = 604
| airdate = {{Start date|1997|12|05}}
| guests =
* [[Vincent D'Onofrio]] as John Lange
* [[Shari Elliker]] as witness
* Bruce MacVittie as Larry Biedron
* Laura MacDonald as Sarah Flannigan
* Lisa Matthews as witness
* Wendee Pratt as Joy Tolson
| prev = [[Saigon Rose]]
| next = [[All Is Bright (Homicide: Life on the Street)|All Is Bright]]
| season_article = Homicide: Life on the Street season 6
| episode_list = List of Homicide: Life on the Street episodes
}}
Microformat
[edit]The HTML mark-up produced by this template includes an hCalendar microformat that makes event details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.
- Classes used
The HTML classes of this microformat include:
- attendee
- contact
- description
- dtend
- dtstart
- location
- organiser
- summary
- url
- vevent
nor collapse nested elements which use them.
Tracking categories
[edit]- Category:Pages using infobox television episode with incorrectly formatted values (36)
- Category:Pages using infobox television episode with non-matching title (5)
- Category:Pages using infobox television episode with nonstandard dates (47)
- Category:Pages using infobox television episode with unknown parameters (3,788)
- Category:Pages using infobox television episode with unlinked values (1,086)
- Category:Pages using infobox television episode with unnecessary list markup (5,363)
- Category:Pages using infobox television episode with unnecessary manual displaytitle (2)
- Category:Pages using infobox television episode with unnecessary title parameter (0)
- Category:Pages using infobox television episode with image-related values without an image (1)
- Category:Pages using infobox television with flag icon (0)
- Category:Pages using infobox television episode with the based on parameter (167)
- Category:Television episode articles with short description with no series name (0)
- Category:Television episode articles with short description with no season number (1,048)
- Category:Television episode articles with short description with no episode number (13)
See also
[edit]Notes
[edit]- ^ The following fields use the plainlist class:
|director=
,|writer=
,|story=
,|teleplay=
,|narrator=
,|presenter=
,|music=
,|photographer=
,|editor=
,|production=
,|release_date=
, and|airdate=
.