Difference between revisions of "Template:Cite episode/doc"

From blackwiki
Jump to navigation Jump to search
imported>Gadget850
imported>Gadget850
m (reorg and update)
Line 2: Line 2:
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
  
{{tl|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.
+
{{tl|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==
 
==Usage==
Line 10: Line 10:
  
 
<code><nowiki>{{Cite episode |title= |episodelink= |url= |accessdate= |series= |serieslink= |credits= |network= |station= |city= |airdate= |began= |ended= |season= |seriesno= |number= |minutes= |time= |transcript= |transcripturl= |quote= |language=}}</nowiki></code>
 
<code><nowiki>{{Cite episode |title= |episodelink= |url= |accessdate= |series= |serieslink= |credits= |network= |station= |city= |airdate= |began= |ended= |season= |seriesno= |number= |minutes= |time= |transcript= |transcripturl= |quote= |language=}}</nowiki></code>
 
  
 
<code><nowiki>{{Cite episode |title= |episodelink= |series= |serieslink= |credits= |network= |station= |airdate= |season= |seriesno= |number= |minutes= |quote= |language=}}</nowiki></code>
 
<code><nowiki>{{Cite episode |title= |episodelink= |series= |serieslink= |credits= |network= |station= |airdate= |season= |seriesno= |number= |minutes= |quote= |language=}}</nowiki></code>
Line 17: Line 16:
 
<pre><nowiki>
 
<pre><nowiki>
 
{{Cite episode
 
{{Cite episode
  | title =  
+
  | title =
  | episodelink =  
+
  | episodelink =
  | url =  
+
  | url =
  | accessdate =  
+
  | accessdate =
  | series =  
+
  | series =
  | serieslink =  
+
  | serieslink =
  | credits =  
+
  | credits =
  | network =  
+
  | network =
  | station =  
+
  | station =
  | city =  
+
  | city =
  | airdate =  
+
  | airdate =
  | began =  
+
  | began =
  | ended =  
+
  | ended =
  | season =  
+
  | season =
  | seriesno =  
+
  | seriesno =
  | number =  
+
  | number =
  | minutes =  
+
  | minutes =
  | time =  
+
  | time =
  | transcript =  
+
  | transcript =
  | transcripturl =  
+
  | transcripturl =
  | quote =  
+
  | quote =
  | language =  
+
  | language =
 
}}
 
}}
 
</nowiki></pre>
 
</nowiki></pre>
  
==Fields==
+
==Examples==
===Wikilinks===
 
Most fields can be wikilinked (i.e. ''network'' = <nowiki>[[network article|network name]]</nowiki>), but should generally only be linked to an existing Wikipedia article. Any wikilinked field '''must not''' contain any brackets apart from normal round brackets <code>()</code> — don't use <code><nowiki><>[]{}</nowiki></code>.
 
 
 
===Parameters===
 
====Description====
 
*'''title''': The title of the program or episode being cited.
 
**'''episodelink''': The title of a Wikipedia article about this episode. Do not link this yourself, it will be linked by the template. Remember that you can use section names here if the only relevant material in Wikipedia is a section of a larger article such as an episode list.
 
**'''url''': May be used to provide an external link if no article exists in Wikipedia.
 
**'''accessdate''': Full date when url was accessed. Should be used when '''url''' field is used. Should be in the same format as other dates in citations in the same article. Must not be wikilinked.
 
*'''series''': The name of the series the episode belongs to.
 
**'''serieslink''': The title of a Wikipedia article about the series. As with episodelink, do not link this yourself. If the citation is being used in the article about the series itself, this call is not necessary and will in fact create improper formatting.
 
*'''credits''': Writers, directors, performers, producers, etc.
 
*'''writers''': ''Deprecated, do not use''. The scriptwriter(s), appends after ''credits''.
 
*'''network''': The network the episode was aired on. (ex. ABC, NBC, CBS, Fox, Disney, USA Network)
 
**'''station''': Call letters of the local station (if any).
 
**'''city''': City of the local station (if any) or network.
 
*'''airdate''': Full date the program or episode aired.
 
**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.
 
*'''season''', '''number''': Many episodic shows are identified by separate season and episode numbers. Alternately, some shows prefer the format of a single episode number that includes the season within it; this format can be used by omitting the season field. Can only be used if the '''seriesno''' attribute is blank.
 
*'''seriesno''', '''number''': Alternative parameter for British shows where each year's run is typically referred to as a ''series'' and not a ''season''. Can only be used if the '''season''' attribute is blank.
 
*'''minutes''': Used when there is a need for citing a specific event that happens at a particular time within the episode. Roughly analogous to page number. Results in "<minutes> minutes in" being displayed in the citation. If both {{para|time}} and {{para|minutes}} are used, "<minutes> minutes in. Event occurs at <time>" will be displayed.
 
*'''time''': Used when there is a need for citing a specific event that happens at a particular time within the episode. Roughly analogous to page number. Results in "Event occurs at <time>" being displayed in the citation. If both {{para|time}} and {{para|minutes}} are used, "<minutes> minutes in. Event occurs at <time>" will be displayed.
 
*'''transcript''': Specifies that the source was a transcript, rather than its original airing
 
**OR '''transcripturl''': Identifies the URL of a transcript for the source.
 
*'''quote''': Used only when there is a need for citing a specific event that happens in particular sentence within the episode.
 
*'''language''': The language used primarily in the episode. Do not specify English.
 
 
 
====<small>Syntax (for the technical-minded)</small>====
 
<div style="font-size: 90%;">
 
Nested fields either rely on their parent fields, or replace them:
 
*''parent''
 
**''child'' — may be used '''with''' ''parent'' (and is ignored if ''parent'' is not used)
 
**OR:  ''child2'' — may be used '''instead''' of ''parent'' (and is ignored if ''parent'' is used)
 
</div>
 
 
 
==Example of use for non-episodic broadcasts==
 
 
A made-up example, with comments in italics annotating the adaptation:
 
A made-up example, with comments in italics annotating the adaptation:
  
 
:<code><nowiki><ref name="BBCPres2008">{{</nowiki>Cite episode
 
:<code><nowiki><ref name="BBCPres2008">{{</nowiki>Cite episode
:: | title       = BBC-TV Presents: The 2008 World Snooker Championship Live at The Crucible ''no wikilinking; see next field''
+
:: | 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 <nowiki>[[</nowiki>link<nowiki>]]</nowiki> it), '''or...'''''
+
:: | episodelink = BBC Snooker World Championship coverage (2008) ''Wikipedia article name (don't <nowiki>[[</nowiki>link<nowiki>]]</nowiki> it), '''or...'''''
:: | url         = <nowiki>http://www.bbc.co.uk/path/to/filename.html</nowiki> ''if no WP article; mutually exclusive with "episodelink"''
+
:: | url = <nowiki>http://www.bbc.co.uk/path/to/filename.html</nowiki> ''if no WP article; mutually exclusive with "episodelink"''
:: | series       = Wide World of Snooker ''if telecast '''is''' part of a regular series/show''
+
:: | 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''
+
:: | serieslink = Wide World of Snooker (tv show) ''Wikipedia article name, not external link''
:: | credits     = Presenters: <nowiki>[[</nowiki>Dennis Taylor<nowiki>]]</nowiki> and <nowiki>[[</nowiki>Clive Everton<nowiki>]]</nowiki>
+
:: | credits = Presenters: <nowiki>[[</nowiki>Dennis Taylor<nowiki>]]</nowiki> and <nowiki>[[</nowiki>Clive Everton<nowiki>]]</nowiki>
:: | network     = <nowiki>[[</nowiki>BBC<nowiki>]]</nowiki>
+
:: | network = <nowiki>[[</nowiki>BBC<nowiki>]]</nowiki>
:: | station     = <nowiki>[[</nowiki>BBC Two<nowiki>]]</nowiki>
+
:: | station = <nowiki>[[</nowiki>BBC Two<nowiki>]]</nowiki>
:: | city         = <nowiki>[[</nowiki>Sheffield<nowiki>]]</nowiki>, <nowiki>[[</nowiki>England<nowiki>]]</nowiki> ''in a live broadcast case like this, the locale is important''
+
:: | city = <nowiki>[[</nowiki>Sheffield<nowiki>]]</nowiki>, <nowiki>[[</nowiki>England<nowiki>]]</nowiki> ''in a live broadcast case like this, the locale is important''
:: | airdate     = 2008-04-27 ''air date (of the cited segment, if multi-day)''
+
:: | 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''
+
:: | 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''
 
:: | transcripturl= http://''URL to e-transcript or online video, if available''
 
:<nowiki>}}</ref></nowiki></code>
 
:<nowiki>}}</ref></nowiki></code>
  
 
{{cite episode
 
{{cite episode
| title       = BBC-TV Presents: The 2008 World Snooker Championship Live at The Crucible
+
| title = BBC-TV Presents: The 2008 World Snooker Championship Live at The Crucible
| episodelink = BBC Snooker World Championship coverage (2008)
+
| episodelink = BBC Snooker World Championship coverage (2008)
| url         = http://www.bbc.co.uk/path/to/filename.html
+
| url = http://www.bbc.co.uk/path/to/filename.html
| series       = Wide World of Snooker
+
| series = Wide World of Snooker
| serieslink   = Wide World of Snooker (tv show)
+
| serieslink = Wide World of Snooker (tv show)
| credits     = Presenters: [[Dennis Taylor]] and [[Clive Everton]]
+
| credits = Presenters: [[Dennis Taylor]] and [[Clive Everton]]
| network     = [[BBC]]
+
| network = [[BBC]]
| station     = [[BBC Two]]
+
| station = [[BBC Two]]
| city         = [[Sheffield]], [[England]]
+
| city = [[Sheffield]], [[England]]
| airdate     = 2008-04-27
+
| airdate = 2008-04-27
| minutes     = 2:34
+
| minutes = 2:34
 
}}
 
}}
  
 +
==Parameters==
 +
===Syntax===
 +
{{csdoc|syntax}}
 +
 +
{{csdoc|coins}}
 +
 +
{{csdoc|sep_period}}
 +
 +
===Description===
 +
* '''title''': The title of the program or episode being cited.
 +
** '''episodelink''': The title of a Wikipedia article about this episode. Do not link this yourself, it will be linked by the template. Remember that you can use section names here if the only relevant material in Wikipedia is a section of a larger article such as an episode list.
 +
** '''url''': May be used to provide an external link if no article exists in Wikipedia.
 +
** '''accessdate''': Full date when url was accessed. Should be used when '''url''' field is used. Should be in the same format as other dates in citations in the same article. Must not be wikilinked.
 +
* '''series''': The name of the series the episode belongs to.
 +
** '''serieslink''': The title of a Wikipedia article about the series. As with episodelink, do not link this yourself. If the citation is being used in the article about the series itself, this call is not necessary and will in fact create improper formatting.
 +
* '''credits''': Writers, directors, performers, producers, etc.
 +
* '''writers''': ''Deprecated, do not use''. The scriptwriter(s), appends after ''credits''.
 +
* '''network''': The network the episode was aired on. (ex. ABC, NBC, CBS, Fox, Disney, USA Network)
 +
** '''station''': Call letters of the local station (if any).
 +
** '''city''': City of the local station (if any) or network.
 +
* '''airdate''': Full date the program or episode aired.
 +
** 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.
 +
* '''season''', '''number''': Many episodic shows are identified by separate season and episode numbers. Alternately, some shows prefer the format of a single episode number that includes the season within it; this format can be used by omitting the season field. Can only be used if the '''seriesno''' attribute is blank.
 +
* '''seriesno''', '''number''': Alternative parameter for British shows where each year's run is typically referred to as a ''series'' and not a ''season''. Can only be used if the '''season''' attribute is blank.
 +
* '''minutes''': Used when there is a need for citing a specific event that happens at a particular time within the episode. Roughly analogous to page number. Results in "<minutes> minutes in" being displayed in the citation. If both {{para|time}} and {{para|minutes}} are used, "<minutes> minutes in. Event occurs at <time>" will be displayed.
 +
* '''time''': Used when there is a need for citing a specific event that happens at a particular time within the episode. Roughly analogous to page number. Results in "Event occurs at <time>" being displayed in the citation. If both {{para|time}} and {{para|minutes}} are used, "<minutes> minutes in. Event occurs at <time>" will be displayed.
 +
* '''transcript''': Specifies that the source was a transcript, rather than its original airing
 +
** OR '''transcripturl''': Identifies the URL of a transcript for the source.
 +
* '''quote''': Used only when there is a need for citing a specific event that happens in particular sentence within the episode.
 +
* '''language''': The language used primarily in the episode. Do not specify English.
 +
 +
{{Citation Style 1}}
 +
{{Wikipedia referencing}}
 +
{{UF-COinS}}
 
<includeonly>
 
<includeonly>
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->

Revision as of 16:35, 19 February 2012

{{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= |airdate= |began= |ended= |season= |seriesno= |number= |minutes= |time= |transcript= |transcripturl= |quote= |language=}}

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

Vertical format

{{Cite episode
 | title =
 | episodelink =
 | url =
 | accessdate =
 | series =
 | serieslink =
 | credits =
 | network =
 | station =
 | city =
 | airdate =
 | 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. BBC Snooker World Championship coverage (2008). 2:34 minutes in. BBC. BBC Two. Unknown parameter |city= ignored (help)

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 multiple aliased parameters are defined, then only one will show.

If non-hyphenated aliases of parameters with hyphens are defined, they exist only for legacy support (and are subject to become unsupported in the future); therefore, to streamline the appearance and improve consistency, select the hyphenated variant when adding parameters to a citation template and also consider switching already present non-hyphenated parameters to their hyphenated equivalents at the same time.

This template embeds COinS metadata in the HTML output, allowing reference management software to retrieve bibliographic metadata. See Wikipedia:COinS. As a general rule, only one data item per parameter. Do not include explanatory or alternate text:

  • use |date=27 September 2007 not |date=27 September 2007 (print version 25 September)

Use of templates within the citation template is discouraged because many of these templates will add extraneous HTML or CSS that will be included raw in the metadata. Also, HTML entities, for example &nbsp;, &ndash;, etc., should not be used in parameters that contribute to the metadata. Do not include Wiki markup '' (italic font) or ''' (bold font) because these markup characters will contaminate the metadata.

COinS metadata is created for these parameters

Note: This table of metadata is displayed for all Citation Style 1 templates. Not all of these parameters are supported by every CS1 template. Some of these parameters are mutually exclusive, some are aliases of another parameter, and some require other parameters to be present. Please refer to each template's documentation for a full list of supported parameters, their aliases, and their dependencies.

  • |periodical=, |journal=, |newspaper=, |magazine=, |work=, |website=, |encyclopedia=, |encyclopaedia=, |dictionary=
  • |chapter=, |script-chapter=, |contribution=, |script-contribution=, |entry=, |script-entry=, |article=, |script-article=, |section=, |script-section=
  • |title=, |script-title=, |book-title=, |booktitle=
  • |publication-place=, |place=, |location=, |publicationplace=
  • |date=, |year=, |publication-date=, |publicationdate=
  • |series=, |version=
  • |volume=, |issue=, |number=
  • |page=, |pages=, |at=
  • |edition=
  • |publisher=, |institution=
  • |url=, |chapter-url=, |contribution-url=, |section-url=, |chapterurl=, |contributionurl=, |sectionurl=
  • |author-last=, |author-last#=, |author#-last=, |author-surname=, |author-surname#=, |author#-surname=, |last=, |last#=, |surname=, |surname#=, |author=, |author#=, |subject=, |subject#=, |host=, |host#=
  • |author-first=, |author-first#=, |author#-first=, |author-given=, |author-given#=, |author#-given=, |first=, |first#=, |given=, |given#=
  • |degree=
  • |arxiv=, |bibcode=, |biorxiv=, |citeseerx=, |doi=, |eissn=, |eprint=, |hdl=, |isbn=, |issn=, |jfm=, |jstor=, |lccn=, |message-id=, |mr=, |oclc=, |osti=, |pmc=, |pmid=, |rfc=, |ssrn=, |s2cid=, |zbl=

By default, sets of fields are terminated with a period (.).

Description

  • title: The title of the program or episode being cited.
    • episodelink: The title of a Wikipedia article about this episode. Do not link this yourself, it will be linked by the template. Remember that you can use section names here if the only relevant material in Wikipedia is a section of a larger article such as an episode list.
    • url: May be used to provide an external link if no article exists in Wikipedia.
    • accessdate: Full date when url was accessed. Should be used when url field is used. Should be in the same format as other dates in citations in the same article. Must not be wikilinked.
  • series: The name of the series the episode belongs to.
    • serieslink: The title of a Wikipedia article about the series. As with episodelink, do not link this yourself. If the citation is being used in the article about the series itself, this call is not necessary and will in fact create improper formatting.
  • credits: Writers, directors, performers, producers, etc.
  • writers: Deprecated, do not use. The scriptwriter(s), appends after credits.
  • network: The network the episode was aired on. (ex. ABC, NBC, CBS, Fox, Disney, USA Network)
    • station: Call letters of the local station (if any).
    • city: City of the local station (if any) or network.
  • airdate: Full date the program or episode aired.
    • 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.
  • season, number: Many episodic shows are identified by separate season and episode numbers. Alternately, some shows prefer the format of a single episode number that includes the season within it; this format can be used by omitting the season field. Can only be used if the seriesno attribute is blank.
  • seriesno, number: Alternative parameter for British shows where each year's run is typically referred to as a series and not a season. Can only be used if the season attribute is blank.
  • minutes: Used when there is a need for citing a specific event that happens at a particular time within the episode. Roughly analogous to page number. Results in "<minutes> minutes in" being displayed in the citation. If both |time= and |minutes= are used, "<minutes> minutes in. Event occurs at
  • time: Used when there is a need for citing a specific event that happens at a particular time within the episode. Roughly analogous to page number. Results in "Event occurs at
  • transcript: Specifies that the source was a transcript, rather than its original airing
    • OR transcripturl: Identifies the URL of a transcript for the source.
  • quote: Used only when there is a need for citing a specific event that happens in particular sentence within the episode.
  • language: The language used primarily in the episode. Do not specify English.

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