Difference between revisions of "Template:Aired episodes/doc"
Jump to navigation
Jump to search
blackwiki>Alex 21 |
blackwiki>Alex 21 |
||
| Line 6: | Line 6: | ||
===Syntax=== | ===Syntax=== | ||
| − | : <code><nowiki>{{Aired episodes|YEAR|MONTH|DAY|num=NUMBER|title=SERIES NAME|finished=SEASON|uk=TEXT}}</nowiki></code> | + | : <code><nowiki>{{Aired episodes|YEAR|MONTH|DAY|num=NUMBER|showpage=SERIES PARENT ARTICLE|title=SERIES NAME|finished=SEASON|uk=TEXT}}</nowiki></code> |
| + | |||
| + | * If {{para|num}} is set, then it can either be set using a number, or transcluding the {{para|num_episodes}} parameter from {{tl|Infobox television}} in the series' parent article using <<nowiki />onlyinclude><<nowiki />/onlyinclude>. Setting {{para|num}} takes precedence. | ||
| + | * If {{para|num}} is not included, then {{para|showpage}} is set to the series' parent article, and the template gains the value of the {{para|num_episodes}} parameter from {{tl|Infobox television}} in the series' parent article ''without'' the need for <<nowiki />onlyinclude><<nowiki />/onlyinclude>. | ||
| + | * If neither {{para|num}} or {{para|showpage}} are set, then the template assumes {{para|showpage}} is set with the value of {{para|title}}; this can be used for where the series' title and series' parent article title are the same. | ||
====Examples==== | ====Examples==== | ||
| Line 30: | Line 34: | ||
: <code><nowiki>{{Aired episodes|2016|1|1|num=50|title=Generic Series|specials=2}}</nowiki></code> | : <code><nowiki>{{Aired episodes|2016|1|1|num=50|title=Generic Series|specials=2}}</nowiki></code> | ||
: {{Aired episodes|2016|1|1|num=50|title=Generic Series|specials=2}} | : {{Aired episodes|2016|1|1|num=50|title=Generic Series|specials=2}} | ||
| + | ; Show page | ||
| + | : <code><nowiki>{{Aired episodes|2016|1|1|showpage=Lucifer (TV series)|title=Lucifer}}</nowiki></code> | ||
| + | : {{Aired episodes|2016|1|1|showpage=Lucifer (TV series)|title=Lucifer}} | ||
| + | ; Show page (showpage = title) | ||
| + | : <code><nowiki>{{Aired episodes|2016|1|1|title=Game of Thrones}}</nowiki></code> | ||
| + | : {{Aired episodes|2016|1|1|title=Game of Thrones}} | ||
==Parameters== | ==Parameters== | ||
| Line 58: | Line 68: | ||
! Number | ! Number | ||
| num | | num | ||
| − | | The number of episodes that the have aired up until the most recent.<br />''Format:'' 9 / nine | + | | The number of episodes that the have aired up until the most recent, as a number, string or transclusion.<br />''Format:'' 9 / nine |
| Number/String | | Number/String | ||
| Required | | Required | ||
| + | |- | ||
| + | ! Show's parent article | ||
| + | | showpage | ||
| + | | The unlinked parent article of the series, for usage with {{tl|Template parameter value}} instead of using {{para|num}} (see explanation in syntax).<br />''Format:'' Lucifer (TV series) | ||
| + | | String | ||
| + | | Optional | ||
|- | |- | ||
! Series | ! Series | ||
| Line 96: | Line 112: | ||
| How many specials have been aired throughout the series.<br />''Format:'' 1 or one | | How many specials have been aired throughout the series.<br />''Format:'' 1 or one | ||
| Number / String | | Number / String | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| Optional | | Optional | ||
|} | |} | ||
Revision as of 01:39, 23 June 2018
| 40px | This is a documentation subpage for Template:Aired episodes. It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
The purpose of the {{Aired episodes}} template is to add a formatted string to List of ... episodes pages for television series, displaying the date of the last episode, the number of episodes that have aired in the series, and whether a season has recently finished.
Syntax
{{Aired episodes|YEAR|MONTH|DAY|num=NUMBER|showpage=SERIES PARENT ARTICLE|title=SERIES NAME|finished=SEASON|uk=TEXT}}
- If
|num=is set, then it can either be set using a number, or transcluding the|num_episodes=parameter from {{Infobox television}} in the series' parent article using <onlyinclude></onlyinclude>. Setting|num=takes precedence. - If
|num=is not included, then|showpage=is set to the series' parent article, and the template gains the value of the|num_episodes=parameter from {{Infobox television}} in the series' parent article without the need for <onlyinclude></onlyinclude>. - If neither
|num=or|showpage=are set, then the template assumes|showpage=is set with the value of|title=; this can be used for where the series' title and series' parent article title are the same.
Examples
- General
{{Aired episodes|2016|1|1|num=50|title=Generic Series}}- As of January 1, 2016,[update] 50 episodes of Generic Series have aired.
- Concluded season
{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4}}- Lua error: expandTemplate: template "Ordinal to word" does not exist.
- Partial season
{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4.5}}- Lua error: expandTemplate: template "Ordinal to word" does not exist.
- British English
{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|uk=y}}- Lua error: expandTemplate: template "Ordinal to word" does not exist.
- Concluded series
{{Aired episodes|num=50|title=Generic Series|finished=all|seasons=4}}- Lua error: expandTemplate: template "Number to word" does not exist.
- Released
{{Aired episodes|2016|1|1|num=50|title=Generic Series|released=y}}- As of January 1, 2016,[update] 50 episodes of Generic Series have been released.
- Specials
{{Aired episodes|2016|1|1|num=50|title=Generic Series|specials=2}}- Lua error: expandTemplate: template "Number to word" does not exist.
- Show page
{{Aired episodes|2016|1|1|showpage=Lucifer (TV series)|title=Lucifer}}- Lua error: expandTemplate: template "Template parameter value" does not exist.
- Show page (showpage = title)
{{Aired episodes|2016|1|1|title=Game of Thrones}}- Lua error: expandTemplate: template "Template parameter value" does not exist.
Parameters
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Year | 1 | The year of the series' most recently aired episode. Format: YYYY |
Number | Required Unrequired when "finished" equals "all" |
| Month | 2 | The month of the series' most recently aired episode. Format: M / MM |
Number | Required Unrequired when "finished" equals "all" |
| Day | 3 | The day of the series' most recently aired episode. Format: D / DD |
Number | Required Unrequired when "finished" equals "all" |
| Number | num | The number of episodes that the have aired up until the most recent, as a number, string or transclusion. Format: 9 / nine |
Number/String | Required |
| Show's parent article | showpage | The unlinked parent article of the series, for usage with {{Template parameter value}} instead of using |num= (see explanation in syntax).Format: Lucifer (TV series) |
String | Optional |
| Series | title | The un-italicized title of the series. Format: Game of Thrones |
String | Required |
| Released | released | Whether the season in question has been released online, rather than aired. Format: y |
String | Optional |
| Finished | finished | Whether the season in question has been concluded. Add ".5" for conclusions of split seasons. Use "all" for the conclusion of the series. Format: 5 or 5.5 or all |
Number / String | Optional |
| Seasons | seasons | The number of seasons that a concluded series aired over. Converted to word for less than 10 seasons. Format: 3 |
Number | Optional |
| UK Format | uk | Whether the series in question follows the British format of titling and dating. Format: Text / <blank> |
String | Optional |
| Specials | specials | How many specials have been aired throughout the series. Format: 1 or one |
Number / String | Optional |