Template:Cite episode/doc

  1. Templates generating COinS


{{Cite episode}} is for citing television or radio programs and episodes. The only required field is title. While it is principally designed and documented for serial, episodic broadcasts, an example is provided below of adaptation to a sporting event broadcast.

Usage

All fields must be in lowercase. The only required field is "title". Copy a blank version to use:

Horizontal format

{{Cite episode |title= |episodelink= |url= |accessdate= |series= |serieslink= |credits= |network= |station= |city= |date= |began= |ended= |season= |seriesno= |number= |minutes= |time= |transcript= |transcripturl= |quote= |language=}}

{{Cite episode |title= |episodelink= |series= |serieslink= |credits= |network= |station= |date= |season= |seriesno= |number= |minutes= |quote= |language=}}

Vertical format 

{{Cite episode
 | title =
 | episodelink =
 | url =
 | accessdate =
 | series =
 | serieslink =
 | credits =
 | network =
 | station =
 | city =
 | date =
 | began =
 | ended =
 | season =
 | seriesno =
 | number =
 | minutes =
 | time =
 | transcript =
 | transcripturl =
 | quote =
 | language =
}}

Examples

A made-up example, with comments in italics annotating the adaptation:

<ref name="BBCPres2008">{{Cite episode
|title=BBC-TV Presents: The 2008 World Snooker Championship Live at The Crucible no wikilinking; see next field
|episodelink=BBC Snooker World Championship coverage (2008) Wikipedia article name (don't [[link]] it), or...
|url=http://www.bbc.co.uk/path/to/filename.html if no WP article; mutually exclusive with "episodelink"
|series=Wide World of Snooker if telecast is part of a regular series/show
|serieslink=Wide World of Snooker (tv show) Wikipedia article name, not external link
|credits=Presenters: [[Dennis Taylor]] and [[Clive Everton]]
|network=[[BBC]]
|station=[[BBC Two]]
|city=[[Sheffield]], [[England]] in a live broadcast case like this, the locale is important
|airdate=2008-04-27 air date (of the cited segment, if multi-day)
|minutes=2:34 if you can cite a better-than-approximate time into the program
|transcripturl= http://URL to e-transcript or online video, if available
}}</ref>

Presenters: Dennis Taylor and Clive Everton (2008-04-27). "BBC-TV Presents: The 2008 World Snooker Championship Live at The Crucible". Wide World of Snooker. Sheffield, England. 2:34 minutes in. BBC. BBC Two. http://www.bbc.co.uk/path/to/filename.html.

Old format

{{cite episode |title=1968 |series=From the Earth to the Moon |credits=Ron Howard, Brian Grazer, Tom Hanks, and Michael Bostick – Producers |network=HBO |airdate=April 1998}}

  • Ron Howard, Brian Grazer, Tom Hanks, and Michael Bostick – Producers (April 1998). "1968". From the Earth to the Moon. HBO.

Updated format

{{cite episode |title=1968 |series=From the Earth to the Moon |first1=Ron |last1=Howard |first2=Brian |last2=Grazer |first3=Tom |last3=Hanks |first4=Michael |last4=Bostick |network=HBO |month=April |year=1998}}

  • Howard, Ron; Grazer, Brian; Hanks, Tom; Bostick, Michael (April 1998). "1968". From the Earth to the Moon. HBO.

Old format

{{cite episode |title=Billy Crystal, 2nd Visit |series=Inside the Actors Studio |airdate=October 8, 2007 |url=http://www.bravotv.com/Inside_the_Actors_Studio/guest/Billy_Crystal_-_2nd_Visit |network=Bravo |season=13 |number=1307 |credits=Lipton, James (host)}}

Current format

{{cite episode |title=Billy Crystal, 2nd Visit |series=Inside the Actors Studio |date=October 8, 2007 |url=http://www.bravotv.com/Inside_the_Actors_Studio/guest/Billy_Crystal_-_2nd_Visit |network=Bravo |season=13 |number=1307 |last=Lipton |first=James (host)}}

Old format

{{cite episode |title=André the Giant |series=Biography |network=[[A&E Network]] |airdate=January 13, 1999}}

  • "André the Giant". Biography. January 13, 1999. A&E Network.

Current format

{{cite episode |title=André the Giant |series=Biography |network=[[A&E Network]] |airdate=January 13, 1999}}

  • "André the Giant". Biography. January 13, 1999. A&E Network.

Parameters

Syntax

Nested parameters rely on their parent parameters:

  • parent
  • OR: parent2—may be used instead of parent
    • child—may be used with parent (and is ignored if parent is not used)
    • OR: child2—may be used instead of child (and is ignored if parent2 is not used)
Where aliases are listed, only one of the parameters may be defined; if aliased parameters are defined, then only one will show.

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata; see Wikipedia:COinS.

  • Be careful using templates within the citation template, as many will add a lot of extraneous HTML or CSS that will be rendered in the meta-data.
    • Known templates that should not be used: {{smallcaps}}.

By default, sets of fields are terminated with a period (.); this can be an issue when the last field in an abbreviation or initial with a period, as two periods then display. The only solution is to not include the last period in the value for the set of fields.

Description

Authors

  • last: Surname of author. Do not wikilink—use authorlink instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use last to include the same format as the source.
    • first: Given or first names of author, including title(s); for example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use authorlink instead.
    • OR: for multiple authors, use first1, last1 through first9, last9 for up to nine authors. By default, if nine authors are defined, then only eight will show and "et al." will show in place of the last author.
  • authorlink: Title of existing Wikipedia article about the author—not the author's website; do not wikilink.
  • OR: for multiple authors, use authorlink1 through authorlink9.
Aliases: last, last1, author, authors; last1, author1 through last9, author9.
When using Shortened footnotes or Parenthetical referencing styles with templates, do not use multiple names in one parameter else the anchor will not match the inline link.
Aliases: credits, author.

Title

  • title: Title of source. Can be wikilinked to an existing Wikipedia article or url may be used to add an external link, but not both. Displayed in quotes.
    • trans_title: English translation of the title if the source cited is in a foreign language. Displayed in square brackets after title; if url is defined, then trans_title is included in the link. Use of the language parameter is recommended.
Titles containing certain characters will display and link incorrectly unless those characters are encoded.
newline [ ] |
space &#91; &#93; &#124;
  • episodelink: (deprecated) Wikilink to an existing Wikipedia article.
  • series: The name of the series the episode belongs to; may be wikilinked.
  • serieslink: (deprecated) Wikilink to an existing Wikipedia article.
  • transcript: Transcript of the original source.
    • transcripturl: URL of the transcript.
  • language: The language the source is written in, if not English. Displays in parentheses with "in" before the language name. Use the full language name; do not use icons or templates.

Date

  • date: Full date of source being referenced; in same format as other dates in the article; do not wikilink. Displayed after the authors and enclosed in parentheses; if there is no author, then displayed after publisher. Aliases: airdate
  • OR: year: Year of source being referenced.
    • month: Name of the month of publication. If you also have the day, use date instead; do not wikilink.
    • origyear: Original publication year; displayed after the date or year. For clarity, please supply specifics; example: |origyear=First published 1859 or |origyear=Composed 1904.
  • OR: began: Full date the first part of the program or episode aired.
    • AND: ended: Full date the last part of the program or episode aired.

Publisher

  • publisher: Name of publisher; may be wikilinked if relevant. Not normally included for periodicals. Corporate designations such as "Ltd", "Inc" or "GmbH" are not usually included. Displays after title; if work is defined, then publisher and location are enclosed in parentheses.
  • location: Geographical place of publication; generally not wikilinked; omit when the name of the work includes the location (examples: The Boston Globe, The Times of India). Displays preceding publisher.
  • publication-date: Date of publication when different from the date the work was written. Displays only if year or date are defined and only if different, else publication-date is used and displayed as date. Use the same format as other dates in the article; do not wikilink. Follows publisher; if work is not defined, then publication-date is preceded by "published" and enclosed in parenthesis.
Aliases: city, location

Edition, volume

  • edition: When the publication has more than one edition; for example: "2nd", "Revised" etc. Displays " ed." after this field, so |edition=2nd produces "2nd ed." Does not display if a periodical field is defined.
  • volume: For one publication published in several volumes. Displayed in bold after the title and series fields; if bolding is not desired, then include the volume information in the title field.

In-source locations

  • minutes: Time the event occurs in the source; followed by "minutes in".
  • OR: time: Time the event occurs in the source; preceded by default text "Event occurs at time".
    • timecaption: Set the text before time.
  • page: Page in the source that supports the content. Displays preceded with <syntaxhighlight lang="text" enclose="none">​p.​</syntaxhighlight> unless |nopp=y.
  • OR: pages: Pages in the source that supports the content; separate page ranges with an en dash (–); separate non-sequential pages with a comma (,); do not use to indicate the total number of pages in the source. Displays preceded with <syntaxhighlight lang="text" enclose="none">​pp.​</syntaxhighlight> unless |nopp=y.
    • nopp: Set to y to suppress the <syntaxhighlight lang="text" enclose="none">​p.​</syntaxhighlight> or <syntaxhighlight lang="text" enclose="none">​pp.​</syntaxhighlight> notations where this is inappropriate; for example, where |page=Front cover.
  • OR: at: For sources where a page number is inappropriate or insufficient. Overridden by |page= or |pages=.
Examples: page (p.) or pages (pp.); section (sec.), column (col.), paragraph (para.); track; hours, minutes and seconds; act, scene, canto, book, part, folio, stanza, back cover, liner notes, indicia, colophon, dust jacket, verse.

URL

  • url: URL of an online location where the text of the publication can be found. Cannot be used if title is wikilinked. If applicable, the link may point to the specific page(s) referenced. Do not link to any commercial booksellers such as Amazon.com; see WP:PAGELINKS.
    • accessdate: Full date when URL was accessed; use the same format as other dates in the article; do not wikilink.
    • archiveurl: The URL of an archived copy of a web page, if or in case the url becomes unavailable. Typically used to refer to services like WebCite and the Internet Archive; requires archivedate.
      • archivedate: Date when the item was archived; use the same format as other dates in the article; do not wikilink.
      • deadurl: To change the order with the title retaining the original link and the archive linked at the end, set |deadurl=no.
    • template doc demo: The archive parameters have error checking to ensure that all the required parameters are included, else {{citation error}} is invoked. On errors, main, help and template pages are placed into Category:Articles with incorrect citation syntax. Set |template doc demo=true to disable categorization; mainly used for documentation where the error is demonstrated.
  • format: Format of the work referred to by url; examples: PDF, DOC, XLS; HTML is implied and should not be specified; displayed in parentheses after title.
URLs must begin with a supported URI scheme: http:// and https:// will be supported by all browsers; irc://, ircs://, ftp://, news:, mailto: and gopher:// will require a plugin or an external application and should normally be avoided. IPv6 host-names are currently not supported.
If URLs in citation template parameters contain certain characters they will display and link incorrectly. Those characters need to be percent-encoded. For example, a space must be replaced by %20. To encode the URL, replace these characters:
sp " ' < > [ ] | }
 %20  %22  %27  %3c  %3e  %5b  %5d  %7c  %7d
Single apostrophes do not need to be encoded; but unencoded multiples will be parsed as italic or bold markup. Single curly closing braces also do not need to be encoded; but an unencoded pair will be parsed as the double closing braces for the template transclusion.

Anchor

Identifiers

  • network: The network the episode was aired on. (e.g. ABC, NBC, CBS, Fox, Disney, USA Network, BBC)
    • station: Call letters of the local station (if any).

Quote

  • quote: Relevant text quoted from the source; enclosed in quotes. When supplied, the citation terminator (a period by default) is suppressed, so the quote needs to include terminating punctuation.

Editors

  • editor-last: Surname of editor. Do not wikilink—use editor-link instead. Where the surname is usually written first—as in Chinese—or for corporate authors, simply use editor-last to include the same format as the source.
    • editor-first: Given or first names of editor, including title(s); example: Firstname Middlename or Firstname M. or Dr. Firstname M., Sr. Do not wikilink—use editor-link instead.
    • OR: for multiple editors, use editor1-first, editor1-last through editor4-first, editor4-last for up to four editors.
  • editor-link: Title of existing Wikipedia article about the editor—not the editor's website; do not wikilink.
  • OR: for multiple editors, use editor1-link through editor4-link.
Display:
If authors: Authors are first, followed by the included work, then "In" and the editors, then the main work.
If no authors: Editors appear before the included work; a single editor is followed by "ed."; multiple editors are followed by "eds."; more than three editors will be followed by "et al., eds."

Laysummary

  • laysummary: URL link to a non-technical summary or review of the source; the URL title is set to "Lay summary".
    • laysource: Name of the source of the laysummary. Displays in italics and preceded by an endash.
    • laydate: Date of the summary. Displays in parentheses.

Display options

  • author-mask: Replaces the name of the first author with a strike-through dash (—) author-mask em in length. If |author-mask=1 then the dash will be one em in length and so on. Set author-mask to a text value to display a word instead:– for example, 'with'. You must still include the values for all authors for metadata purposes. Primarily intended for use in bibliographies for some styles where multiple works by a single author are listed. Do not use in a list generated by {{reflist}}, <references /> or similar as there is no control as to the order that references will display.
  • author-name-separator: Changes the separator between last and first names; defaults to a comma and space (, ); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.
  • author-separator: Changes the separator between authors; defaults to a semicolon and space (; ); if the parameter is present, but blank, no separator punctuation will be used; a space must be encoded as &#32; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.
  • display-authors: By default, the number of authors displayed is limited to 8; if 9 are provided, the ninth is displayed as "et al." This parameter allows display of fewer authors before the "et al."; example: |display-authors=2; if there are 8 or fewer authors, then "et al." may be suppressed by setting |display-authors=9.
  • lastauthoramp: When set to any value, changes the separator to use between the last two names in lists of authors to an ampersand (&); defaults to a semicolon and space (; ), else |author-separator= if set.
  • postscript: The closing punctuation for the citation; defaults to a period (.); if the parameter is present, but blank, no terminating punctuation will be used. Ignored if |quote= is specified.
  • separator: The punctuation used to separate lists of authors, editors, etc. Defaults to a period (.); if the parameter is present, but blank, no separator punctuation will be used; do not use an asterisk (*), colon (:) or hash (#) as they will be interpreted as wikimarkup.
General templates
Bot-filled templates
Categories
Documentation
Wikipedia referencing
General
Inline citations
Citations
Help for beginners
Help templates
Advanced help

This template produces COinS metadata; see COinS in Wikipedia for background information.

...