Template:Infobox television episode/doc: Difference between revisions
Neuleinster (talk | contribs) No edit summary |
|||
Line 1: | Line 1: | ||
{{Documentation subpage}} | |||
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}} | |||
{{Auto italic title|italic_title|short=yes}} | |||
{{Auto short description}} | |||
{{Lua|Module:Check for unknown parameters|Module:Infobox television episode|Module:InfoboxImage|Module:String2}} | |||
{{Uses TemplateStyles|Template:Infobox television episode/styles.css}} | |||
| | '''Infobox television episode''' is used to create an [[WP:Infobox|infobox]] which summarizes the main information of a particular television episode or internet video. | ||
== Usage == | |||
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 [[WP:Short description|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 | ||
| | | series = {{{series}}} | ||
| | | image = {{{image}}} | ||
| image_size = {{{image_size|}}} | |||
| image_alt = {{{image_alt}}} | |||
| caption = {{{caption}}} | |||
| season = {{{season}}} | |||
| series_no = {{{series no}}} | |||
| episode = {{{episode}}} | |||
| director = {{{director}}} | |||
| writer = {{{writer}}} | |||
| story = {{{story}}} | |||
| teleplay = {{{teleplay}}} | |||
| based_on = {{{based_on}}} | |||
| narrator = {{{narrator}}} | |||
| presenter = {{{presenter}}} | |||
| producer = {{{producer}}} | |||
| music = {{{music}}} | |||
| photographer = {{{photographer}}} | |||
| editor = {{{editor}}} | |||
| production = {{{production}}} | |||
| airdate = {{{airdate}}} | |||
| length = {{{length}}} | |||
| guests = {{{guests}}} | |||
| prev = {{{prev}}} | |||
| next = {{{next}}} | |||
| season_article = {{{season_article}}} | |||
| episode_list = {{{episode_list}}} | |||
}} | |||
| | <section begin=infobox /> | ||
| | <syntaxhighlight lang="wikitext" style="overflow: auto;"> | ||
| | {{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 = | |||
| producer = | |||
| music = | |||
| photographer = | |||
| editor = | |||
| production = | |||
| airdate = <!-- {{Start date|YYYY|MM|DD}} --> | |||
| length = | |||
| guests = | |||
| prev = | |||
| next = | |||
| season_article = | |||
| episode_list = | |||
}} | |||
</syntaxhighlight> | |||
<section end=infobox /> | |||
=== Maintenance === | |||
If you encounter a usage of the template which you want to quickly restore to the above standard, use {{tlx|Infobox television episode/subst|subst=y}}. | |||
{{clear}} | |||
| | == Parameters == | ||
<section begin="Param-lead"/>Link people only if they have articles. For most of the fields below{{efn|The following fields use the plainlist class: {{para|director}}, {{para|writer}}, {{para|story}}, {{para|teleplay}}, {{para|narrator}}, {{para|presenter}}, {{para|producer}}, {{para|music}}, {{para|photographer}}, {{para|editor}}, {{para|production}}, {{para|release_date}}, and {{para|airdate}}.}}, if there are multiple entries, separate them using bulleted lists (<code>*</code>). 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.<section end="Param-lead"/> | |||
| | {| class="wikitable" | ||
| | |+ Infobox television episode parameters and basic guidelines | ||
! scope="col" | Parameter | |||
! scope="col" | Explanation | |||
|-<section begin=Parameters/> | |||
! scope="row" | 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. | |||
|-<section end=Parameters/> | |||
! scope="row" | 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 {{para|rtitle}} instead. | |||
|- | |||
! scope="row" | 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. | |||
|- | |||
! scope="row" | 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. | |||
|- | |||
! scope="row" | 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)]]. | |||
|-<section begin=Parameters/> | |||
! scope="row" | 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. {{strong|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. | |||
|- | |||
! scope="row" | image_size | |||
| Image size in pixels. Should be 250 or less. If not specified, image defaults to frameless (220px). "px" is not required. | |||
|- | |||
! scope="row" | image_upright | |||
| Use of this parameter is preferred to using {{para|image_size}}, as it allows [[Wikipedia:Autosizing images|auto-sizing of images]] according to user preferences. By default, the infobox image scales to upright=1 (which is 1 × 220px if the default thumbnail size has not been changed at [[Special:Preferences]]). For upright posters, a value of upright=1 is recommended. | |||
| | The size should not be set to a value that would result in an image width greater than 300px. See [[#Calculating "image_upright"|help below]] for guidance on determining the value to be used. | ||
| | |- | ||
! scope="row" | image_alt | |||
| Alt text for image per [[WP:MOSALT]]. | |||
|- | |||
! scope="row" | caption | |||
| A caption explaining the image. | |||
|- | |||
! scope="row" | season | |||
| The number of the season this episode is part of. | |||
|-<section end=Parameters/> | |||
! scope="row" | series_no | |||
| The number of the series this episode is part of. Use either {{para|season}} or {{para|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. | |||
|-<section begin=Parameters/> | |||
! scope="row" | episode | |||
| The number of the episode within the season. | |||
|- | |||
! scope="row" | director | |||
| The [[Film director|director(s)]] of this episode. Separate multiple people using bulleted lists (<code>*</code>). In addition, link each director to their appropriate article if possible. | |||
|- | |||
! scope="row" | writer | |||
| The [[writer]](s) of this episode. Separate multiple people using bulleted lists (<code>*</code>). In addition, link each writer to their appropriate article if possible. | |||
|- | |||
! scope="row" | story | |||
| The writer(s) of the episode's story. Separate multiple people using bulleted lists (<code>*</code>). Use this field instead of the normal writer field if television episodes divide writing credits between teleplay and story writers. | |||
|- | |||
! scope="row" | teleplay | |||
| The writer(s) of the episode's teleplay. Separate multiple people using bulleted lists (<code>*</code>). Use this field instead of the normal writer field if television episodes divide writing credits between teleplay and story writers. | |||
|- | |||
! scope="row" | based_on | |||
| The original work the episode is based on. Use {{Tl|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 (2014 TV series)|''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. | |||
|-<section end=Parameters/> | |||
! scope="row" | narrator | |||
| The [[Narration|narrator(s)]] of this episode. Separate multiple people using bulleted lists (<code>*</code>). In addition, link each narrator to their appropriate article if possible. | |||
|- | |||
! scope="row" | presenter | |||
| The person who fronts (hosts) the show. Separate multiple people using bulleted lists (<code>*</code>). | |||
|-<section begin=Parameters/> | |||
! scope="row" | producer | |||
| The [[Film producer|producer(s)]] of this episode. As television episodes typically have several credited producers, not all of whom had a direct role in the production of the episode, it is advisable to just include the [[show runner]](s). Separate multiple people using bulleted lists (<code>*</code>). In addition, link each producer to their appropriate article if possible. | |||
|- | |||
! scope="row" | music | |||
| The music of this episode. Use {{Tl|Work by author}} to add the title of the song and the name(s) of the song performer. Separate multiple music using bulleted lists (<code>*</code>). Television episodes often include numerous songs; only include the most notable (typically songs playing during key scenes). | |||
|-<section end=Parameters/> | |||
! scope="row" | photographer | |||
| The [[Cinematographer|director(s) of photography]] of this episode. Separate multiple people using bulleted lists (<code>*</code>). In addition, link each director of photography to their appropriate article if possible. | |||
|-<section begin=Parameters/> | |||
! scope="row" | editor | |||
| The [[Film editor|editor(s)]] of this episode. Separate multiple people using bulleted lists (<code>*</code>). In addition, link each editor to their appropriate article if possible. | |||
|- | |||
! scope="row" | production | |||
| The [[Production code number|production code]] or number of this episode. Separate multiple codes using bulleted lists (<code>*</code>). | |||
|- | |||
! scope="row" | airdate | |||
| The original airing date of the episode; use {{tl|Start date}}. Separate multiple dates using bulleted lists (<code>*</code>). | |||
|-<section end=Parameters/> | |||
! scope="row" | release_date | |||
| The original release date of the episode. This should be used for episodes released on streaming services such as [[Netflix]]; use {{tl|Start date}}. Separate multiple dates using bulleted lists (<code>*</code>). | |||
|-<section begin=Parameters/> | |||
! scope="row" | length | |||
| The original length of the episode, including credits, in minutes. It should indicate runtime (without commercials), or with commercials. | |||
|-<section end=Parameters/> | |||
! scope="row" | guests_title | |||
| Text for display in guests header (default = Guest appearance(s)). | |||
|-<section begin=Parameters/> | |||
! scope="row" | guests | |||
| [[Guest star]](s) in the episode. Separate multiple people using bulleted lists (<code>*</code>). If using bullets, include the name of the character the guest actor portrays using a single space, "as", and another single space: "<actor> as <character>". Link to the appropriate character article, if one exists. | |||
|-<section end=Parameters/> | |||
! scope="row" | module | |||
| An optional parameter to add a nested infobox to. | |||
|-<section begin=Parameters/> | |||
! scope="row" | 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 {{para|rprev}} is used. | |||
|-<section end=Parameters/> | |||
! scope="row" | 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. | |||
|-<section begin=Parameters/> | |||
! scope="row" | 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 {{para|rnext}} is used. | |||
|-<section end=Parameters/> | |||
! scope="row" | 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. | |||
|- | |||
! scope="row" | 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. | |||
|- | |||
! scope="row" | 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. | |||
|} | |||
=== Controlling line-breaking in embedded bulletless lists === | |||
| | Template {{tlx|nbsp}} may be used with {{tlx|wbr}} and {{tlx|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. | ||
{{#section:Template:Infobox Australian place/doc|image_upright}} | |||
| | ===TemplateData=== | ||
| | {{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}} | ||
{{TemplateData header|noheader=1}} | |||
<templatedata> | |||
{ | |||
"description": "Infobox used on articles about television episodes or internet videos.", | |||
"params": { | |||
"italic_title": { | |||
"label": "Italic title", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "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. If the title should not be in quotation marks, use \"rtitle\" instead." | |||
}, | |||
"title": { | |||
"label": "Title", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "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." | |||
}, | |||
"rtitle": { | |||
"label": "Raw title", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "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": { | |||
"label": "Series name", | |||
"type": "wiki-page-name", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "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": { | |||
"label": "Not using disambiguation", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "A parameter that is used when the series name has parenthesis which are part of the title, such as Randall and Hopkirk (Deceased)." | |||
}, | |||
"image": { | |||
"label": "Image", | |||
"type": "wiki-file-name", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "An image relevant to the episode." | |||
}, | |||
"image_size": { | |||
"label": "Image size", | |||
"type": "number", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "Image size in pixels. Should be 250 or less. If not specified, image defaults to frameless (220px). 'px' is not required." | |||
}, | |||
"image_upright": { | |||
"label": "Image upright", | |||
"type": "number", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"default": "1", | |||
"description": "" | |||
}, | |||
"image_alt": { | |||
"label": "Image alt", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "Alt text for image per WP:MOSALT.", | |||
"aliases": [ | |||
"alt" | |||
] | |||
}, | |||
"caption": { | |||
"label": "Image caption", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "A caption explaining the image." | |||
}, | |||
"season": { | |||
"label": "Season number", | |||
"type": "number", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The number of the season this episode is part of. Use either \"season\" or \"series_no\", but not both." | |||
}, | |||
"series_no": { | |||
"label": "Series number", | |||
"type": "number", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "Typically, \"Series\" is used for television series produced within the United Kingdom while \"Season\" is used for American television series." | |||
}, | |||
"episode": { | |||
"label": "Episode number", | |||
"type": "number", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The number of the episode within the season." | |||
}, | |||
"director": { | |||
"label": "Director", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The director(s) of this episode. Separate multiple people using bulleted lists (<code>*</code>). In addition, link each director to their appropriate article if possible." | |||
}, | |||
"writer": { | |||
"label": "Writer", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The writer(s) of this episode. Separate multiple people using bulleted lists (<code>*</code>). In addition, link each writer to their appropriate article if possible." | |||
}, | |||
"story": { | |||
"label": "Story writer", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The writer(s) of the episode's story. Separate multiple people using bulleted lists (<code>*</code>). Use this field instead of the normal writer field if television episodes divide writing credits between teleplay and story writers." | |||
}, | |||
"teleplay": { | |||
"label": "Teleplay writer", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The writer(s) of the episode's teleplay. Separate multiple people using bulleted lists (<code>*</code>). Use this field instead of the normal writer field if television episodes divide writing credits between teleplay and story writers." | |||
}, | |||
"based_on": { | |||
"label": "Based on", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The original work the episode is based on. Use {{Tl|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'' (2014 TV series) 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": { | |||
"label": "Narrator", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The narrator(s) of this episode. Separate multiple people using bulleted lists (<code>*</code>). In addition, link each narrator to their appropriate article if possible." | |||
}, | |||
"presenter": { | |||
"label": "Presenter", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "Person who fronts (hosts) the episode. Separate multiple people using bulleted lists (<code>*</code>)." | |||
}, | |||
"producer": { | |||
"label": "Producer", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The producer(s) of this episode. As television episodes typically have several credited producers, not all of whom had a direct role in the production of the episode, it is advisable to just include the show runner(s). Separate multiple people using bulleted lists (<code>*</code>). In addition, link each producer to their appropriate article if possible." | |||
}, | |||
"music": { | |||
"label": "Music", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The music of this episode. Use {{Tl|Work by author}} to add the title of the song and the name(s) of the song performer. Separate multiple songs using bulleted lists (<code>*</code>). Television episodes often include numerous songs; only include the most notable (typically songs playing during key scenes)." | |||
}, | |||
"photographer": { | |||
"label": "Photographer", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The director(s) of photography of this episode. Separate multiple people using bulleted lists (<code>*</code>). In addition, link each director of photography to their appropriate article if possible." | |||
}, | |||
"editor": { | |||
"label": "Editor", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The editor(s) of this episode. Separate multiple people using bulleted lists (<code>*</code>). In addition, link each editor to their appropriate article if possible." | |||
}, | |||
"production": { | |||
"label": "Production code", | |||
"type": "number", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The production code or number of this episode. Separate multiple codes using bulleted lists (<code>*</code>)." | |||
}, | |||
"airdate": { | |||
"label": "Airdate", | |||
"type": "date", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The original airing date of the episode; use {{Start date}}. Separate multiple people dates bulleted lists (<code>*</code>)." | |||
}, | |||
"release_date": { | |||
"label": "Release date", | |||
"type": "date", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The original release date of the episode. This should be used for episodes released on streaming services such as Netflix; use {{Start date}}. Separate multiple dates using bulleted lists (<code>*</code>)." | |||
}, | |||
"length": { | |||
"label": "Episode length", | |||
"type": "number", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "The original length of the episode, including credits, in minutes. It should indicate run-time (without commercials), or with commercials.", | |||
"aliases": [ | |||
"runtime" | |||
] | |||
}, | |||
"guests_title": { | |||
"label": "Guest header text", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "Text for display in guests header (default = Guest appearance(s))." | |||
}, | |||
"guests": { | |||
"label": "Guest stars", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "Guest star(s) of this episode. Separate multiple people using bulleted lists (<code>*</code>). If using bullets, include the character the guest actor portray in the episode after their name in the infobox (using a single space, \"as\" and another single space: \"<actor> as <character>\"). Provide a link to the appropriate article if possible. Only guest actors in notable roles should be included in the list." | |||
}, | |||
"module": { | |||
"label": "Module", | |||
"type": "string", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "An optional parameter to add a nested infobox to." | |||
}, | |||
"prev": { | |||
"label": "Previous episode", | |||
"type": "wiki-page-name", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "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": { | |||
"label": "Raw previous episode", | |||
"type": "wiki-page-name", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "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": { | |||
"label": "Next episode", | |||
"type": "wiki-page-name", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "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": { | |||
"label": "Raw next episode", | |||
"type": "wiki-page-name", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "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": { | |||
"label": "Season article", | |||
"type": "wiki-page-name", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "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": { | |||
"label": "Episode list", | |||
"type": "wiki-page-name", | |||
"required": false, | |||
"suggested": false, | |||
"deprecated": false, | |||
"description": "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." | |||
} | |||
}, | |||
"format": "\n{{_\n| _______________= _\n}}\n", | |||
"paramOrder": [ | |||
"italic_title", | |||
"title", | |||
"rtitle", | |||
"series", | |||
"not_dab", | |||
"image", | |||
"image_size", | |||
"image_upright", | |||
"image_alt", | |||
"caption", | |||
"season", | |||
"series_no", | |||
"episode", | |||
"director", | |||
"writer", | |||
"story", | |||
"teleplay", | |||
"based_on", | |||
"narrator", | |||
"presenter", | |||
"producer", | |||
"music", | |||
"photographer", | |||
"editor", | |||
"production", | |||
"airdate", | |||
"release_date", | |||
"length", | |||
"guests_title", | |||
"guests", | |||
"module", | |||
"prev", | |||
"rprev", | |||
"next", | |||
"rnext", | |||
"season_article", | |||
"episode_list" | |||
] | |||
} | |||
</templatedata> | |||
{{Collapse bottom}} | |||
| | == Example == | ||
| | {{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 | |||
| airdate = {{Start date|1997|12|05}} | |||
| production = 604 | |||
| writer = [[James Yoshimura]] | |||
| director = [[Gary Fleder]] | |||
| photographer = [[Alex Zakrzewski]] | |||
| 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 | |||
| season_article = Homicide: Life on the Street (season 6) | |||
| episode_list = List of Homicide: Life on the Street episodes | |||
| prev = [[Saigon Rose]] | |||
| next = [[All Is Bright (Homicide: Life on the Street)|All Is Bright]] | |||
}} | |||
<syntaxhighlight lang="wikitext" style="overflow: auto;"> | |||
{{Infobox television episode | |||
| 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 | ||
| airdate = {{Start date|1997|12|05}} | |||
| | | production = 604 | ||
| | | writer = [[James Yoshimura]] | ||
| director = [[Gary Fleder]] | |||
| | | photographer = [[Alex Zakrzewski]] | ||
| 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 | ||
| season_article = Homicide: Life on the Street (season 6) | |||
| | | prev = [[Saigon Rose]] | ||
| | | next = [[All Is Bright (Homicide: Life on the Street)|All Is Bright]] | ||
}} | |||
| | </syntaxhighlight> | ||
{{clear}} | |||
| | |||
| | |||
</ | |||
== Microformat == | |||
{{UF-hcal}} | |||
| | == Tracking categories == | ||
| | <section begin=Tracking/> | ||
* {{Category link with count|Pages using infobox television episode with unknown parameters}} | |||
* {{Category link with count|Pages using infobox television episode with unlinked values}} | |||
* {{Category link with count|Pages using infobox television episode with incorrectly formatted values}} | |||
* {{Category link with count|Pages using infobox television episode with non-matching title}} | |||
* {{Category link with count|Pages using infobox television episode with nonstandard dates}} | |||
* {{Category link with count|Pages using infobox television episode with unnecessary title parameter}} | |||
* {{Category link with count|Pages using infobox television episode with unnecessary manual displaytitle}} | |||
* {{Category link with count|Pages using infobox television episode with image-related values without an image}} | |||
* {{Category link with count|Pages using infobox television with flag icon}} | |||
* {{Category link with count|Pages using infobox television episode with the based on parameter}} | |||
* {{Category link with count|Television episode articles with short description with no series name}} | |||
* {{Category link with count|Television episode articles with short description with no season number}} | |||
* {{Category link with count|Television episode articles with short description with no episode number}}<section end=Tracking/> | |||
== See also == | |||
{{Film- and television-related infobox templates}} | |||
{{ | |||
}} | |||
== Notes == | |||
{{Notelist}} | |||
<includeonly>{{Sandbox other|| | |||
<!-- Categories below this line, please; interwikis at Wikidata --> | |||
[[Category:Television episode infobox templates| ]] | |||
[[Category:Television infobox templates|Television episode]] | |||
[[Category:Infobox templates with module parameter|Television episode]] | |||
[[Category:Templates that add a tracking category]] | |||
}}</includeonly> | |||
Revision as of 16:15, 9 August 2023
This is a documentation subpage for Template:Infobox television episode. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 11,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.
Transclusion count updated automatically (see documentation). |
This infobox should italicize the article title automatically. If this is not required, add |italic_title=no to the list of parameters. If this is required but the title is not being italicized, try |italic_title=force . |
This template adds an automatically generated short description. |
This template uses Lua: |
null
Infobox television episode is used to create an infobox which summarizes the main information of a particular television episode or internet video.
Usage
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.
Lua error: expandTemplate: template "Single+space" does not exist. | |
---|---|
{{{series}}} episodes | |
[[File:{{{image}}}|frameless|alt={{{image_alt}}}|upright=1]] | |
Episode nos. | Season {{{season}}} Series {{{series no}}} Episodes {{{episode}}} |
Directed by | {{{director}}} |
Written by | {{{writer}}} |
Story by | {{{story}}} |
Teleplay by | {{{teleplay}}} |
Based on | {{{based_on}}} |
Narrated by | {{{narrator}}} |
Presented by | {{{presenter}}} |
Produced by | {{{producer}}} |
Featured music | {{{music}}} |
Cinematography by | {{{photographer}}} |
Editing by | {{{editor}}} |
Production code | {{{production}}} |
Original air date | {{{airdate}}} |
Running time | {{{length}}} |
Guest appearance | |
{{{guests}}} | |
<section begin=infobox />
{{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 =
| producer =
| music =
| photographer =
| editor =
| production =
| airdate = <!-- {{Start date|YYYY|MM|DD}} -->
| length =
| guests =
| prev =
| next =
| season_article =
| episode_list =
}}
<section end=infobox />
Maintenance
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
<section begin="Param-lead"/>Link people only if they have articles. 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.<section end="Param-lead"/>
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 upright=1 (which is 1 × 220px if the default thumbnail size has not been changed at Special:Preferences). For upright posters, a value of 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. |
director | The director(s) of this episode. Separate multiple people using bulleted lists (* ). In addition, link each director to their appropriate article if possible.
|
writer | The writer(s) of this episode. Separate multiple people using bulleted lists (* ). In addition, link each writer to their appropriate article if possible.
|
story | The writer(s) of the episode's story. Separate multiple people using bulleted lists (* ). 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. Separate multiple people using bulleted lists (* ). 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. Separate multiple people using bulleted lists (* ). In addition, link each narrator to their appropriate article if possible.
|
presenter | The person who fronts (hosts) the show. Separate multiple people using bulleted lists (* ).
|
producer | The producer(s) of this episode. As television episodes typically have several credited producers, not all of whom had a direct role in the production of the episode, it is advisable to just include the show runner(s). Separate multiple people using bulleted lists (* ). In addition, link each producer to their appropriate article if possible.
|
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. Separate multiple music using bulleted lists (* ). 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. Separate multiple people using bulleted lists (* ). In addition, link each director of photography to their appropriate article if possible.
|
editor | The editor(s) of this episode. Separate multiple people using bulleted lists (* ). In addition, link each editor to their appropriate article if possible.
|
production | The production code or number of this episode. Separate multiple codes using bulleted lists (* ).
|
airdate | The original airing date of the episode; use {{Start date}}. Separate multiple dates using bulleted lists (* ).
|
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}}. Separate multiple dates using bulleted lists (* ).
|
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. Separate multiple people using bulleted lists (* ). If using bullets, include the name of the character the guest actor portrays using a single space, "as", and another single space: "<actor> as <character>". Link to the appropriate character article, if one exists.
|
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. |
Controlling line-breaking in embedded bulletless lists
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.
{{#section:Template:Infobox Australian place/doc|image_upright}}
TemplateData
TemplateData documentation used by VisualEditor and other tools
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
See the monthly parameter usage report for this template.
TemplateData for Infobox television episode Infobox used on articles about television episodes or internet videos.
|
Example
"Subway" | |
---|---|
Homicide: Life on the Street episodes | |
Episode nos. | Season 6 Episodes 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
| 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
| airdate = {{Start date|1997|12|05}}
| production = 604
| writer = [[James Yoshimura]]
| director = [[Gary Fleder]]
| photographer = [[Alex Zakrzewski]]
| 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
| season_article = Homicide: Life on the Street (season 6)
| prev = [[Saigon Rose]]
| next = [[All Is Bright (Homicide: Life on the Street)|All Is Bright]]
}}
Microformat
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
<section begin=Tracking/>
- Category:Pages using infobox television episode with unknown parameters (1)
- Category:Pages using infobox television episode with unlinked values (0)
- Category:Pages using infobox television episode with incorrectly formatted values (1)
- Category:Pages using infobox television episode with non-matching title (0)
- Category:Pages using infobox television episode with nonstandard dates (1)
- Category:Pages using infobox television episode with unnecessary title parameter (0)
- Category:Pages using infobox television episode with unnecessary manual displaytitle (0)
- Category:Pages using infobox television episode with image-related values without an image (0)
- Category:Pages using infobox television with flag icon (0)
- Category:Pages using infobox television episode with the based on parameter (1)
- Category:Television episode articles with short description with no series name (0)
- Category:Television episode articles with short description with no season number (0)
- Category:Television episode articles with short description with no episode number (0)<section end=Tracking/>
See also
Notes
- ↑ The following fields use the plainlist class:
|director=
,|writer=
,|story=
,|teleplay=
,|narrator=
,|presenter=
,|producer=
,|music=
,|photographer=
,|editor=
,|production=
,|release_date=
, and|airdate=
.