View source for Template:Episode list/doc

{{documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{intricate}}

This template creates a table row, for use in a list of episodes, primarily for television. The number, and use, of columns a table has, is defined by the beginning wikitext of that table ([[#Using the template|further explained below]]), and is not defined by this template. In order for this template to provide a table row for a given article, parameters must either be included, or excluded. An included parameter, although empty, will provide a cell for that field (and thus column), while excluding a parameter will not provide a cell for that field.

== Parameters ==
{| class="wikitable plainrowheaders" style="background-color: white;"
|+ ''Episode list'' parameters and basic guidelines
! scope="col" style="background-color: whitesmoke;" | Field name
! scope="col" style="background-color: whitesmoke;" | Type
! scope="col" style="background-color: whitesmoke;" | Description
! scope="col" style="background-color: whitesmoke;" | Recommended values
|-
| '''EpisodeNumber'''
| Optional, desirable
| A number representing the episode's order in the series. For example, the first episode would be <code>1</code> or <code>01</code>, and so on. When defined, the specified number also generates a link anchor, prefixed by "<code>ep</code>"; for example, "<code><nowiki>[[List of episodes#ep1]]</nowiki></code>" or "<code><nowiki>[[List of episodes#ep01]]</nowiki></code>". In creating the anchor, the text specified for the number is treated literally: to generate the most straight-forward versions of anchors as previously exemplified, specify only a number, omitting any use of formatting, including bold.
| rowspan="2" | number
|-
| '''EpisodeNumber2'''
| Optional
| A second episode number column. Useful for when a series aired in a different order, or only included certain episodes, etc. When used with multi-season series, this field is typically used to represent the episode's order in the season.
|-
| '''Title'''
| Required
| The title of the episode. The title will appear in "quotes" when rendered, so it is not necessary to place them in quotes beforehand. Only link to an episode article if it has already been created.
| wikitext, may include links to valid articles.
|-
| '''RTitle'''
| Optional
| Unformatted parameter that can be used to add a reference after "<code>Title</code>", or can be used as a "'''raw''' title" to replace "<code>Title</code>" completely. Future episodes should include a reference in this field.
| wikitext, references, etc
|-
| '''AltTitle'''
| Optional
| An alternative title, such as the title of a foreign show's episode in its native language, or a title that was originally changed. It will be listed below '''Title''' and be presented in "quotes".
| wikitext, may include links to valid articles.
|-
| '''RAltTitle'''
| Optional
| Unformatted parameter that can be used to add a reference after "<code>AltTitle</code>", or can be used as a "'''raw''' title" to replace "<code>AltTitle</code>" completely.
| wikitext, references, etc
|-
| '''Aux1'''
| Optional
| General purpose parameter. The meaning is specified by the column header.
| rowspan="5" | wikitext, may include links
|-
| '''DirectedBy'''
| Optional
| Name of the episode's director
|-
| '''WrittenBy'''
| Optional
| Primary writer(s) of the episode
|-
| '''Aux2'''
| Optional
| General purpose parameter. The meaning is specified by the column header.
|-
| '''Aux3'''
| Optional
| General purpose parameter. The meaning is specified by the column header.
|-
| '''OriginalAirDate'''
| Optional
| This is the date the episode first aired on TV, or is scheduled to air.
| date, formatted using {{tl|start date}}.
|-
| '''AltDate'''
| Optional
| The next notable air date, such as the first air date of an anime in English.
| date. Do not use {{tl|start date}} if <code>OriginalAirDate</code> is present.<ref group="N">{{tl|Start date}} emits metadata as part of the parent template's hCalendar microformat. It is only needed once per episode, and may be harmful if used twice or more.</ref>
|-
| '''ProdCode'''
| Optional
| The production code in the series. When defined, this parameter also creates a link anchor, prefixed by "<code>pc</code>"; for example, "<code><nowiki>[[List of episodes#pc01]]</nowiki></code>".
| plain text
|-
| '''Viewers'''
| Optional, desirable
| Number of viewers who watched the episode. Should include a reference. The inclusion of viewer figures is supported and provides encyclopaedic content beyond what might normally be found in a TV guide. It is therefore desirable to include referenced ratings information in an episode list.
| Number, followed by a reference.
|-
| '''Aux4'''
| Optional
| Optional parameter. The meaning is specified by the table header.
| rowspan="2" | wikitext, may include links
|-
| '''{{visible anchor|ShortSummary}}'''
| Optional
| A short 100–300 word summary of the episode. Make summaries specific to that episode (as in, a description that would normally not be confused with another episode). Leaving this parameter empty will result in the summary row not appearing for this episode.
|-
| '''LineColor'''
| Optional
| Colors the separator line between episode entries. If not defined the color defaults to "<code>#CCCCFF</code>". Use of "<code>#</code>", or anything but a valid hex code will result in an invalid syntax.
| rowspan="2" | Hex code, not preceded by "<code>#</code>". e.g. enter "<code>00ff00</code>" instead of "<code>#00ff00</code>"
|-
| '''TopColor'''
| Optional
| Colors the main row of information (that is, not the <code>ShortSummary</code> row). If not defined, it defaults to the wikitable standard background shading of "<code>#F9F9F9</code>", except when <code>ShortSummary</code> is used, and then it defaults to "<code>#f2f2f2</code>". The excessive use of the parameter is discouraged by Wikipedia's guideline on styles and markup options.
|-
| '''RowColor'''
| Optional
| This parameter is a "switch" that must only be defined when the <code>EpisodeNumber=</code> entry is not a regular number (eg. "12–13" for two episodes described in one table entry). When transcluding the table from a season article into a main episode list article, irregular <code>EpisodeNumber=</code> entries break up the striping effect the template introduces. If the first episode number is even, define <code>RowColor=</code> as <code>On</code>. If the first episode number is odd, define <code>RowColor=</code> as <code>Off</code>. All further uses of [[Template:Episode list]] in the table must also have the <code>RowColor=</code> parameters defined to alternate between <code>Off</code> and <code>On</code> to avoid further breakages in the striping.
| "<code>On</code>", "<code>on</code>", "<code>Yes</code>", "<code>yes</code>", "<code>Y</code>", or "<code>y</code>";<br />"<code>Off</code>", "<code>off</code>", "<code>No</code>", "<code>no</code>", "<code>N</code>", "<code>n</code>"
|}

This is where information from the template is placed when rendered (''<code>{{{LineColor}}}</code>, <code>{{{TopColor}}}</code>, and <code>{{{RowColor}}}</code> are not shown, since there's no text to display''):
{| class="wikitable plainrowheaders" style="width: 100%; margin: auto; background: #FFFFFF; font-size:0.8em;"
|-
<tr class="vevent" style="text-align: center; background:#F2F2F2">
<th scope="row" style="text-align: center; background:#F2F2F2"><nowiki>{{{EpisodeNumber}}}</nowiki></th>
<td><nowiki>{{{EpisodeNumber2}}}</nowiki></td>
<td class="summary" style="text-align: left;">{{nowrap|"<nowiki>{{{Title}}}</nowiki>"<nowiki>{{{RTitle}}}</nowiki>}} <br />{{nowrap|"<nowiki>{{{AltTitle}}}</nowiki>"<nowiki>{{{RAltTitle}}}</nowiki>}}</td>
<td><nowiki>{{{Aux1}}}</nowiki></td>
<td><nowiki>{{{DirectedBy}}}</nowiki></td>
<td><nowiki>{{{WrittenBy}}}</nowiki></td>
<td><nowiki>{{{Aux2}}}</nowiki></td>
<td><nowiki>{{{Aux3}}}</nowiki></td>
<td><nowiki>{{{OriginalAirDate}}}</nowiki></td>
<td><nowiki>{{{AltDate}}}</nowiki></td>
<td><nowiki>{{{ProdCode}}}</nowiki></td>
<td><nowiki>{{{Viewers}}}</nowiki></td>
<td><nowiki>{{{Aux4}}}</nowiki></td></tr>
<tr><td class="description" style="border-bottom:3px solid #CCCCFF" colspan="13">
<nowiki>{{{ShortSummary}}}</nowiki>&nbsp;</td></tr>
|}

== Tips ==
It may be helpful to include a hidden message that will appear when someone edits the article. Placed above the table headers and under the article section, such as:

<pre>==Episodes==
<nowiki><!-- For help with this template see http://en.wikipedia.org/wiki/Template:Episode_list --></nowiki>
&lt;onlyinclude>
{| class="wikitable plainrowheaders"
</pre>

This message won't be visible when normally viewing the article. A message such as this notes where one can get help for the template.

== Microformat ==
{{UF-hcal-multi}}
For shows where each episode is from a different, single, specific place (for example, [[Time Team]], one of the ''Aux'' fields can contain the [[Geographic coordinate system|coordinates]], applied using {{tl|coord}}.

== Episode list templates ==
* [[Wikipedia:WikiProject Television/Episode lists]]
* [[Template:Episode list]]
* [[Template:Japanese episode list]]

== Subpages ==
{{Special:PrefixIndex/Template:Episode list}}

"Hacks" of this template, also known as "forks", are discouraged. Any discussion regarding forks should occur on this template's, not the fork's or article's, talk page.

== See also ==
* {{tl|Infobox television}}
* {{tl|Infobox television season}}
* {{tl|Infobox television episode}}
* [[Wikipedia:WikiProject Television#More television templates]]

== Notes ==
{{Reflist|group="N"}}

<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Television episode infobox templates|{{PAGENAME}}]]
[[Category:WikiProject Television templates|{{PAGENAME}}]]

<!-- ADD INTERWIKIS BELOW THIS LINE -->
</includeonly>