On November 27th, 2022, the 8,000th article was added to the SuccuWiki!
Template:Episode list/doc: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{documentation subpage}} <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> {{intricate}} This template creates a table row, for use in a list of episodes, primarily for t...") |
mNo edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{documentation subpage}} | {{documentation subpage}} | ||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | ||
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. | 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. | ||
| Line 127: | Line 126: | ||
<nowiki>{{{ShortSummary}}}</nowiki> </td></tr> | <nowiki>{{{ShortSummary}}}</nowiki> </td></tr> | ||
|} | |} | ||
== Tips == | == Tips == | ||
| Line 533: | Line 140: | ||
== Microformat == | == Microformat == | ||
{{UF-hcal-multi}} | {{UF-hcal-multi}} | ||
For shows where each episode is from a different, single, specific place | For shows where each episode is from a different, single, specific place. | ||
== Episode list templates == | == Episode list templates == | ||
* [[Wikipedia:WikiProject Television/Episode lists]] | * [[Wikipedia:WikiProject Television/Episode lists]] | ||
* [[Template:Episode list]] | * [[Template:Episode list]] | ||
* [[Template:Japanese episode list]] | * [[Template:Japanese episode list]] | ||
== See also == | == See also == | ||
Latest revision as of 13:59, 13 October 2012
 |
This is a documentation subpage for Template:Episode list. It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
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 (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
| Field name | Type | Description | Recommended values |
|---|---|---|---|
| EpisodeNumber | Optional, desirable | A number representing the episode's order in the series. For example, the first episode would be 1 or 01, and so on. When defined, the specified number also generates a link anchor, prefixed by "ep"; for example, "[[List of episodes#ep1]]" or "[[List of episodes#ep01]]". 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.
|
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 "Title", or can be used as a "raw title" to replace "Title" 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 "AltTitle", or can be used as a "raw title" to replace "AltTitle" completely.
|
wikitext, references, etc |
| Aux1 | Optional | General purpose parameter. The meaning is specified by the column header. | 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 {{start date}}. |
| AltDate | Optional | The next notable air date, such as the first air date of an anime in English. | date. Do not use {{start date}} if OriginalAirDate is present.[N 1]
|
| ProdCode | Optional | The production code in the series. When defined, this parameter also creates a link anchor, prefixed by "pc"; for example, "[[List of episodes#pc01]]".
|
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. | wikitext, may include links |
| 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 "#CCCCFF". Use of "#", or anything but a valid hex code will result in an invalid syntax.
|
Hex code, not preceded by "#". e.g. enter "00ff00" instead of "#00ff00"
|
| TopColor | Optional | Colors the main row of information (that is, not the ShortSummary row). If not defined, it defaults to the wikitable standard background shading of "#F9F9F9", except when ShortSummary is used, and then it defaults to "#f2f2f2". 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 EpisodeNumber= 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 EpisodeNumber= entries break up the striping effect the template introduces. If the first episode number is even, define RowColor= as On. If the first episode number is odd, define RowColor= as Off. All further uses of Template:Episode list in the table must also have the RowColor= parameters defined to alternate between Off and On to avoid further breakages in the striping.
|
"On", "on", "Yes", "yes", "Y", or "y";" Off", "off", "No", "no", "N", "n"
|
This is where information from the template is placed when rendered ({{{LineColor}}}, {{{TopColor}}}, and {{{RowColor}}} are not shown, since there's no text to display):
| {{{EpisodeNumber}}} | {{{EpisodeNumber2}}} | "{{{Title}}}"{{{RTitle}}} "{{{AltTitle}}}"{{{RAltTitle}}} |
{{{Aux1}}} | {{{DirectedBy}}} | {{{WrittenBy}}} | {{{Aux2}}} | {{{Aux3}}} | {{{OriginalAirDate}}} | {{{AltDate}}} | {{{ProdCode}}} | {{{Viewers}}} | {{{Aux4}}} |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| {{{ShortSummary}}} | ||||||||||||
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:
==Episodes==
<!-- For help with this template see http://en.wikipedia.org/wiki/Template:Episode_list -->
<onlyinclude>
{| class="wikitable plainrowheaders"
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
The HTML mark up produced by this template includes an hCalendar microformat, which makes the event details parsable by computers, either acting automatically to catalogue article across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to a calendar or diary application. For more information about the use of microformats on Wikipedia, please see the microformat project.
Dates will only be included if you use {{Start date}} or {{End date}} (use the former for single dates).
hCalendar uses HTML classes including:
- attendee
- contact
- description
- dtend
- dtstart
- location
- organiser
- summary
- vevent
Please do not rename or remove these classes; nor collapse nested elements which use them.
For shows where each episode is from a different, single, specific place.
Episode list templates
See also
- {{Infobox television}}
- {{Infobox television season}}
- {{Infobox television episode}}
- Wikipedia:WikiProject Television#More television templates
Notes
- ↑ {{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.