Difference between revisions of "Template:Aired episodes/doc"
blackwiki>Vanisaac m (→TemplateData: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other) |
blackwiki>Alex 21 (+) |
||
| Line 6: | Line 6: | ||
===Syntax=== | ===Syntax=== | ||
| − | : <code><nowiki>{{Aired episodes|YEAR|MONTH|DAY|num=NUMBER|showpage=SERIES PARENT ARTICLE|title=SERIES NAME|finished=SEASON|airing=SEASON|uk=TEXT}}</nowiki></code> | + | : <code><nowiki>{{Aired episodes|YEAR|MONTH|DAY|num=NUMBER|showpage=SERIES PARENT ARTICLE|title=SERIES NAME|finished=SEASON|airing=SEASON|uk=TEXT|YEAR|MONTH|DAY}}</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 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. | ||
| Line 31: | Line 31: | ||
: <code><nowiki>{{Aired episodes|num=50|title=Generic Series|finished=all|seasons=4}}</nowiki></code> | : <code><nowiki>{{Aired episodes|num=50|title=Generic Series|finished=all|seasons=4}}</nowiki></code> | ||
: {{Aired episodes|num=50|title=Generic Series|finished=all|seasons=4}} | : {{Aired episodes|num=50|title=Generic Series|finished=all|seasons=4}} | ||
| + | ; Concluded series with dates | ||
| + | : <code><nowiki>{{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4}}</nowiki></code> | ||
| + | : {{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4}} | ||
| + | : <code><nowiki>{{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4|uk=y}}</nowiki></code> | ||
| + | : {{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4|uk=y}} | ||
; Released | ; Released | ||
: <code><nowiki>{{Aired episodes|2016|1|1|num=50|title=Generic Series|released=y}}</nowiki></code> | : <code><nowiki>{{Aired episodes|2016|1|1|num=50|title=Generic Series|released=y}}</nowiki></code> | ||
| Line 51: | Line 56: | ||
! Status | ! Status | ||
|- | |- | ||
| − | ! | + | ! Date (most recent or premiere) |
| − | | | + | | 1–3 |
| − | | The year of the series' most recently aired episode.<br />''Format:'' YYYY | + | | The year (1), month (2) and day (3) of the series' most recently aired episode or premiere date.<br />''Format:'' YYYY/MM/DD |
| Number | | Number | ||
| − | | Optional/Required<br /> | + | | Optional/Required<br />Required for airing series (ignored when date set), Optional when "finished" equals "all" (inclusion will list date as a premiere date) |
|- | |- | ||
| − | ! | + | ! Date (finale) |
| − | | | + | | 4–6 |
| − | | The month of the series' | + | | The year (4), month (5) and day (6) of the series' finale date.<br />''Format:'' YYYY/MM/DD |
| Number | | Number | ||
| − | | Optional/Required<br /> | + | | Optional/Required<br />Not required for airing series, Optional when "finished" equals "all" but required if 1–3 parameters are set (inclusion will list date as a finale date) |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
! Number | ! Number | ||
Revision as of 10:52, 3 May 2020
| 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. |
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|airing=SEASON|uk=TEXT|YEAR|MONTH|DAY}}
- 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.
- Airing season
{{Aired episodes|2016|1|1|num=50|title=Generic Series|airing=4}}- Lua error: expandTemplate: template "Ordinal to word" does not exist.
- 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.
- Concluded series with dates
{{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4}}- Lua error: expandTemplate: template "Number to word" does not exist.
{{Aired episodes|2014|12|31|2016|1|1|num=50|title=Generic Series|finished=all|seasons=4|uk=y}}- 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 | |
|---|---|---|---|---|
| Date (most recent or premiere) | 1–3 | The year (1), month (2) and day (3) of the series' most recently aired episode or premiere date. Format: YYYY/MM/DD |
Number | Optional/Required Required for airing series (ignored when date set), Optional when "finished" equals "all" (inclusion will list date as a premiere date) |
| Date (finale) | 4–6 | The year (4), month (5) and day (6) of the series' finale date. Format: YYYY/MM/DD |
Number | Optional/Required Not required for airing series, Optional when "finished" equals "all" but required if 1–3 parameters are set (inclusion will list date as a finale date) |
| 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 | Optional/Required |
| Date | date | The date when entered manually; the first three numbered parameters will be ignored when this is used. Format: June 23, 2018 |
String | Optional |
| 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 |
| Airing | airing | Whether the season in question is currently airing. Format: 5 |
Number | 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 |
TemplateData
TemplateData for Aired episodes
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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Year | 1 | The year of the series' most recently aired episode. | Number | optional |
| Month | 2 | The month of the series' most recently aired episode. | Number | optional |
| Day | 3 | The day of the series' most recently aired episode. | Number | optional |
| Number | num | The number of episodes that the have aired up until the most recent, as a number, string or transclusion. | Number | optional |
| Date | date | The date when entered manually; the first three numbered parameters will be ignored when this is used. | Line | optional |
| Show's parent article | showpage | The unlinked parent article of the series, for usage with {{Template parameter value}} instead of using |num=. | Page | optional |
| Series | title | The un-italicized title of the series. | Line | required |
| Released | released | Whether the season in question has been released online, rather than aired.
| Line | 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. | Line | optional |
| Seasons | seasons | The number of seasons that a concluded series aired over. Converted to word for less than 10 seasons. | Number | optional |
| UK Format | uk | Whether the series in question follows the British format of titling and dating.
| Line | optional |
| Specials | specials | How many specials have been aired throughout the series. | Number | optional |