साँचा:Episode list/doc
साँचा:documentation subpage साँचा:intricate
For lists that include only titles, air dates, etc, with no summary, remove |ShortSummary=, which removes cell and line separator colouring.
Parameters
| Episode list parameters (and basic guidelines) | |||
|---|---|---|---|
| EpisodeNumber (optional) |
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. | ||
| EpisodeNumber2 (optional) |
A second episode number column. Useful for when a series aired in a different order, or only included certain episodes, etc. | ||
| Title | The title of the episode. The title will appear bold and 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. | ||
| 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. | ||
| 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". | ||
| Aux1 (optional) |
Optional parameter. The meaning is specified by the table header. | ||
| DirectedBy (optional) |
Who directed the episode. | ||
| WrittenBy (optional) |
Primary writer(s) of the episode. | ||
| Aux2 & Aux3 (optional) |
Optional parameters. The meaning is specified by the table header. | ||
| OriginalAirDate (optional) |
This is the date the episode first aired on TV, or is scheduled to air. Use साँचा:tl. | ||
| AltDate (optional) |
The next notable air date, such as the first air date of an anime in English. Do not use साँचा:tl, unless OriginalAirDate is not present. | ||
| 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]]". | ||
| Aux4 (optional) |
Optional parameter. The meaning is specified by the table header. | ||
| 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). Episode summaries must not be copied from other sources, as this violates WP:COPYRIGHT. | ||
| LineColor (optional) |
Hex codes for the separator line between episode entries. Use code without the #, #00ff00 would be entered as 00ff00, using a #, or anything but a valid hex code will result in an invalid syntax. When none is defined the color defaults to "#CCCCFF". | ||
| TopColor (optional) |
Colors the main row of information (that is, not the ShortSummary row). When not defined, if ShortSummary is defined, this defaults to #F2F2F2; otherwise, it defaults to the table default. | ||
This is where information from the template is placed when rendered ({{{LineColor}}} not shown, since there's no text to display, just a color):
| EpisodeNumber | {{{EpisodeNumber2}}} | "{{{Title}}}"{{{RTitle}}} "{{{AltTitle}}}" | {{{Aux1}}} | {{{DirectedBy}}} | {{{WrittenBy}}} | {{{Aux2}}} | {{{Aux3}}} | {{{OriginalAirDate}}} | {{{AltDate}}} | ProdCode | {{{Aux4}}} |
|---|
Using the template
When using optional parameters (such as Aux1, AltDate, etc) only list the parameters that are being used, and adjust the table headers accordingly. This will help avoid confusion when one entry has a parameter filled out and another does not. A table cell will be open for a listed parameter, whether it is filled out or not.
To apply an entry to an episode listing add the following where the episode would go in the List of episodes.
{{Episode list
| EpisodeNumber=
| EpisodeNumber2=
| Title=
| RTitle=
| AltTitle=
| Aux1=
| DirectedBy=
| WrittenBy=
| Aux2=
| Aux3=
| OriginalAirDate=
| AltDate=
| ProdCode=
| Aux4=
| ShortSummary=
| LineColor=
}}
|
Because this is only part of a WikiTable, you first need to open the WikiTable. You need to edit this example according to the optional parameters that you want to show in your table. For example to create a list with only EpisodeNumber, Title, OriginalAirDate, ProdCode, and ShortSummary parameters:
{|class="wikitable" style="width:100%; margin:auto; background:#FFF; table-layout:fixed;"
|-
! style="width:3em;" | No.
! Title
! style="width:12em;" | Original air date
! style="width:12em;" | Production code
|-
The Television episode template(s) would the follow here
{{Episode list
| EpisodeNumber=01
| Title=Cartman Gets Probed
| OriginalAirDate={{start date|1997|08|13}}
| ProdCode=101
| ShortSummary=Space aliens implant a transmitter in [[Eric Cartman|Cartman]] and abduct [[Kyle Broflovski|Kyle]]'s brother.
| LineColor=333333
}}
After the final episode entry/template you will need to close the WikiTable with:
|}
Example
This entry:
{{Episode list
| EpisodeNumber=01
| Title=Cartman Gets Probed
| OriginalAirDate={{start date|1997|08|13}}
| ProdCode=101
| ShortSummary=Space aliens implant a transmitter in [[Eric Cartman|Cartman]] and abduct [[Kyle Broflovski|Kyle]]'s brother.
| LineColor=333333
}}
Would appear as follows (shown without table headers):
| # | Title | Original airdate | Production code |
|---|---|---|---|
| 01 | "Cartman Gets Probed" | साँचा:start date | 101 |
| Space aliens implant a transmitter in Cartman and abduct Kyle's brother. | |||
Sublists
Occasionally, when dealing with a very long series, you may wish to break the list up into separate sublists. When doing so, the list should be broken at season breaks, or otherwise years.
Sublists should be named as "List of X episodes (season y)", and transcluded onto the main list to prevent ending up with two lists of duplicate information. For sublist pages, you should use साँचा:tl2 for each episode, where "List of X episodes" is the name of the main episode list. So, for instance, if you're working on List of Lassie episodes, you would split it into List of Lassie episodes (season 1) and List of Lassie episodes (season 2), and each episode on the sublist would use साँचा:tld. When transcluded onto the main list, this template strips out any summaries and alternates the background row color between light and dark gray, depending on the value of {{{EpisodeNumber}}}, but any custom {{{LineColor}}} coloring is left intact.
For the purpose of transclusion, each sublist should make use of <onlyinclude/> tags, with the opening tag just after the "Episode list" or "List of episodes" header, and the closing tag at the very end of the episode list. This prevents the lead, external links, references, templates, categories, interwiki links, and all other unnecessary information from being transcluded onto the main list.
When transcluding onto the main list, you should make use of साँचा:tl. For example, referring to Lassie again, the main list would have the following code under the "Episode list" header:
===Season 1===
{{main|List of Lassie episodes (season 1)}}
{{:List of Lassie episodes (season 1)}}
===Season 2===
{{main|List of Lassie episodes (season 2)}}
{{:List of Lassie episodes (season 2)}}
Note the colon (:) at the beginning of the transclusions (for example, {{:List of ...); this is necessary when transcluding non-templates to prevent a redlink from appearing. If you tried to transclude List of Lassie episodes (season 1) without using the colon, you would get साँचा:List of Lassie episodes (season 1): a redlink to a nonexistent template.
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_talk:Episode_list
-->
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.
Episode list templates
- Wikipedia:WikiProject Television/Episode lists
- Template:Episode list
- Template:Japanese episode list
- Template:Television needs episode list
Show-specific hacks and other sub-pages
Microformat
The HTML markup 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 साँचा:tl or साँचा:tl (use the former for single dates). As an alternative, you may use साँचा:tl and साँचा:tl.
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.
Pages which use multiple instances of this template can also use साँचा:tl, in their external links section, to generate a SIMILE timeline. It renders as:
For shows where each episode is from a different, single, specific place (for example, Time Team, one of the Aux fields can contain the coordinates, applied using साँचा:tl.
See also