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

From blackwiki
Jump to navigation Jump to search
imported>Fabartus
(Doc time, timecaption, quote and quotation parameters.)
imported>Brian Olsen
(Reverting last changes, as they don't seem to be working.)
Line 12: Line 12:
 
|- width="50%" valign="top" style="vertical-align:top;"
 
|- width="50%" valign="top" style="vertical-align:top;"
 
| colspan="3" |  
 
| colspan="3" |  
:<span style="font-family:Courier; "><nowiki>{{cite episode |title= |episodelink= |url= |series= |serieslink= |credits= |network= |station= |city= |airdate= |began= |ended= |season= |number= |minutes= |transcript= |transcripturl= |time= |timecaption= |quote= |quotation=
+
:<span style="font-family:Courier; "><nowiki>{{cite episode |title= |episodelink= |url= |series= |serieslink= |credits= |network= |station= |city= |airdate= |began= |ended= |season= |number= |minutes= |transcript= |transcripturl=}}</nowiki></span>
}}</nowiki></span>
 
 
|- width="50%" valign="top" style="vertical-align:top;"
 
|- width="50%" valign="top" style="vertical-align:top;"
 
| colspan="3" |  
 
| colspan="3" |  
:<span style="font-family:Courier; "><nowiki>{{cite episode |title= |episodelink= |series= |serieslink= |credits= |network= |station= |airdate= |season= |number= |minutes= |time= |timecaption= |quote= |quotation= }}</nowiki></span>
+
:<span style="font-family:Courier; "><nowiki>{{cite episode |title= |episodelink= |series= |serieslink= |credits= |network= |station= |airdate= |season= |number= |minutes= }}</nowiki></span>
 
|}
 
|}
  
Line 39: Line 38:
 
| transcript  =   
 
| transcript  =   
 
| transcripturl=  
 
| transcripturl=  
|time= (inside program or some easy to recognize/describe 'event time benchmark' description within program)
 
:|timecaption= for alternative lead in phrase to "Event occured at " 
 
|quote= |quotation= (Same results, use only one parameter; contents will be enclosed in quotations in cite.)
 
 
}}
 
}}
 
</nowiki></pre>
 
</nowiki></pre>
Line 52: Line 48:
  
 
====Description====
 
====Description====
{{dablink|(parameters which automatically create wikilinks (by enclosing the parameter named in square brackets) are <u>underlined</u>.)}}
 
 
 
*'''title''': The title of the program or episode being cited.
 
*'''title''': The title of the program or episode being cited.
**<u>'''episodelink'''</u>: 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.
+
**'''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.
 
**'''url''': May be used to provide an external link if no article exists in Wikipedia.
 
*'''series''': The name of the series the episode belongs to.
 
*'''series''': The name of the series the episode belongs to.
**<u>'''serieslink'''</u>: The title of a Wikipedia article about the series. As with episodelink, do not link this yourself.
+
**'''serieslink''': The title of a Wikipedia article about the series. As with episodelink, do not link this yourself.
 
*'''credits''': Writers, directors, performers, producers, etc.
 
*'''credits''': Writers, directors, performers, producers, etc.
 
*'''writers''': ''Deprecated, do not use''. The scriptwriter(s), appends after ''credits''.
 
*'''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)
 
*'''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), or cable, if applicable.
+
**'''station''': Call letters of the local station (if any).
**'''city''': City of the local station (if any) or network, or location of a sporting event.
+
**'''city''': City of the local station (if any) or network.
 
*'''airdate''': Full date the program or episode aired, in [[ISO 8601]] YYYY-MM-DD format, eg. ''2004-06-27''. Must not be wikilinked.
 
*'''airdate''': Full date the program or episode aired, in [[ISO 8601]] YYYY-MM-DD format, eg. ''2004-06-27''. Must not be wikilinked.
 
**OR '''began''': Full date the first part of the program or episode aired, in [[ISO 8601]] YYYY-MM-DD format, eg. ''2004-06-27''. Must not be wikilinked.
 
**OR '''began''': Full date the first part of the program or episode aired, in [[ISO 8601]] YYYY-MM-DD format, eg. ''2004-06-27''. Must not be wikilinked.
 
**AND '''ended''': Full date the last part of the program or episode aired, in [[ISO 8601]] YYYY-MM-DD format, eg. ''2004-06-27''. Must not be wikilinked.
 
**AND '''ended''': Full date the last part of the program or episode aired, in [[ISO 8601]] YYYY-MM-DD format, eg. ''2004-06-27''. Must not be wikilinked.
 
*'''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.
 
*'''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.
*'''minutes''': Used only when there is a need for citing a specific event that happens at a particular time within the episode. Roughly analogous to page number, the word "minutes" is added after the contents of this parameter when specified.
+
*'''minutes''': Used only when there is a need for citing a specific event that happens at a particular time within the episode. Roughly analogous to page number.
 
*'''transcript''': Specifies that the source was a transcript, rather than its original airing
 
*'''transcript''': Specifies that the source was a transcript, rather than its original airing
**OR <u>'''transcripturl'''</u>: Identifies the URL of a transcript for the source.
+
**OR '''transcripturl''': Identifies the URL of a transcript for the source.
*'''time''': This is a generic text parameter, not necessarily a number. Normally prefixed by "Event occured at ", which can be rephrased by setting:
 
**'''timecaption''': from "Event occured at " to a different lead in such as "At the end the commercials between the third and fourth quarters ..."
 
*'''quote or quotation''': Both terms given to give compatibility with other citation templates. Use only one. Parameter when defined is enclosed in quotes per standard cites practices.
 
 
 
  
 
====<small>Syntax (for the technical-minded)</small>====
 
====<small>Syntax (for the technical-minded)</small>====
Line 84: Line 74:
 
</div>
 
</div>
  
==Examples of use for non-episodic broadcasts==
+
==Example of use for non-episodic broadcasts==
===Made up example===
 
 
A made-up example, with comments in italics annotating the adaptation:
 
A made-up example, with comments in italics annotating the adaptation:
  
Line 99: Line 88:
 
:: | 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 '''in that format''' (of the cited segment, if multi-day)''
 
:: | airdate      = 2008-04-27 ''air date '''in that format''' (of the cited segment, if multi-day)''
:: | minutes      = 2:34 ''if you can cite a better-than-approximate time into the program'' ('minutes' will be added at end)
+
:: | 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''
:: | time= Normally (default 'timecaption') preceded by <code> "Event occurs at "</code> when and if given. Specify
 
:::| timecaption= alternative phrase to "Event occurs at " (This only active, if and when '''time''' parameter is defined.)
 
:: | quote (or |quotation= [use only one]) Probably the data/event you need to cite in the first place.
 
 
:<nowiki>}}</ref></nowiki></code>
 
:<nowiki>}}</ref></nowiki></code>
  
===Real example citing 'event' announced by media ===
 
:'''Use documenting history (record) announced in sports coverage:'''
 
On Monday Night Football, October 1st, 2007 [[Tom Brady]] set the NFL record for the highest completion percentage (79%) for a quarterbacks first 100 passes to start a season.<ref name="ESPNMNF record">{{cite episode
 
| title        = ESPN Monday Night Football October 1st, 2007
 
| episodelink  =
 
| url          =
 
| series      = ESPN Monday Night Football
 
| serieslink  = Monday Night Football
 
| credits      = Presenters: [[Mike Tirico]], [[Tony Kornheiser]], [[Ron Jaworski]], and etc.
 
| network      = ESPN Network
 
| station      = cable
 
| city        = Cincinati, OH
 
| airdate      = 2007-10-01
 
| began        =
 
| ended        =
 
| season      =
 
| number      =
 
| minutes      =
 
| time= third/fourth quarter commercial break by Mike Tirico.
 
| timecaption = Announced just after
 
| quote= "Tom Brady, six incompletions [of 24 to that point], 150 yards [passing], a couple of touchdowns. Earlier tonight setting the single season [NFL] passing record for the highest completion percentage in his [for a quarterbacks'] first 100 passes to start a season at seventy-nine percent (79%)."
 
| transcripturl=
 
}}</ref>
 
<pre>
 
Above example coded:
 
<ref name="ESPNMNF record">{{cite episode
 
| title        = ESPN Monday Night Football October 1st, 2007
 
| episodelink  =
 
| url          =
 
| series      = ESPN Monday Night Football
 
| serieslink  = Monday Night Football
 
| credits      = Presenters: [[Mike Tirico]], [[Tony Kornheiser]], [[Ron Jaworski]], and etc.
 
| network      = ESPN Network
 
| station      = cable
 
| city        = Cincinati, OH
 
| airdate      = 2007-10-01
 
| began        =
 
| ended        =
 
| season      =
 
| number      =
 
| minutes      =
 
| time= third/fourth quarter commercial break by Mike Tirico.
 
| timecaption=Announced just after
 
| quote= "Tom Brady, six incompletions [of 24 to that point], 150 yards [passing], a couple of touchdowns. Earlier tonight setting the single season [NFL] passing record for the highest completion percentage in his [for a quarterbacks'] first 100 passes to start a season at seventy-nine percent (79%)."
 
| transcripturl=
 
}}</ref>
 
</pre>
 
 
<includeonly>
 
<includeonly>
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->

Revision as of 00:21, 4 October 2007

Template:Template doc page viewed directly

{{Cite episode}} is for citing television or radio programs and episodes. The only required field is title. While it is pricipally 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

Full version (copy and paste text below and delete parameters you don't need)
{{cite episode |title= |episodelink= |url= |series= |serieslink= |credits= |network= |station= |city= |airdate= |began= |ended= |season= |number= |minutes= |transcript= |transcripturl=}}
{{cite episode |title= |episodelink= |series= |serieslink= |credits= |network= |station= |airdate= |season= |number= |minutes= }}

Vertical format

{{cite episode
| title        = 
| episodelink  = 
| url          = 
| series       = 
| serieslink   = 
| credits      = 
| network      = 
| station      = 
| city         = 
| airdate      = 
| began        = 
| ended        = 
| season       = 
| number       = 
| minutes      = 
| transcript   =  
| transcripturl= 
}}

Fields

Wikilinks

Most fields can be wikilinked (ie. network = [[network article|network name]]), but should generally only be linked to an existing Wikipedia article. Any wikilinked field must not contain any brackets apart from normal round brackets () — don't use <>[]{}.

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.
  • 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.
  • 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, in ISO 8601 YYYY-MM-DD format, eg. 2004-06-27. Must not be wikilinked.
    • OR began: Full date the first part of the program or episode aired, in ISO 8601 YYYY-MM-DD format, eg. 2004-06-27. Must not be wikilinked.
    • AND ended: Full date the last part of the program or episode aired, in ISO 8601 YYYY-MM-DD format, eg. 2004-06-27. Must not be wikilinked.
  • 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.
  • minutes: Used only when there is a need for citing a specific event that happens at a particular time within the episode. Roughly analogous to page number.
  • transcript: Specifies that the source was a transcript, rather than its original airing
    • OR transcripturl: Identifies the URL of a transcript for the source.

Syntax (for the technical-minded)

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)

Example of use for non-episodic broadcasts

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 = [[British Broadcasting Corporation|BBC]]
| station = [[BBC Two]]
| city = [[Sheffield]], [[England]] in a live broadcast case like this, the locale is important
| airdate = 2008-04-27 air date in that format (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>