Difference between revisions of "Template:Aired episodes/doc"
blackwiki>Alex 21 |
m (38 revisions imported) |
||
| (12 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| + | {{Lua|Module:Aired episodes}} | ||
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | ||
| − | == Usage == | + | ==Usage== |
The purpose of the '''{{tl|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. | The purpose of the '''{{tl|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=== | ===Syntax=== | ||
| − | + | : <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 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. | |
| − | |||
| − | |||
| − | * | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == Parameters== | + | ====Examples==== |
| + | ; General | ||
| + | : <code><nowiki>{{Aired episodes|2016|1|1|num=50|title=Generic Series}}</nowiki></code> | ||
| + | : {{Aired episodes|2016|1|1|num=50|title=Generic Series}} | ||
| + | ; Airing season | ||
| + | : <code><nowiki>{{Aired episodes|2016|1|1|num=50|title=Generic Series|airing=4}}</nowiki></code> | ||
| + | : {{Aired episodes|2016|1|1|num=50|title=Generic Series|airing=4}} | ||
| + | ; Concluded season | ||
| + | : <code><nowiki>{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4}}</nowiki></code> | ||
| + | : {{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4}} | ||
| + | ; Partial season | ||
| + | : <code><nowiki>{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4.5}}</nowiki></code> | ||
| + | : {{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4.5}} | ||
| + | ; British English | ||
| + | : <code><nowiki>{{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|uk=y}}</nowiki></code> | ||
| + | : {{Aired episodes|2016|1|1|num=50|title=Generic Series|finished=4|uk=y}} | ||
| + | ; Concluded series | ||
| + | : <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}} | ||
| + | ; 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 | ||
| + | : <code><nowiki>{{Aired episodes|2016|1|1|num=50|title=Generic Series|released=y}}</nowiki></code> | ||
| + | : {{Aired episodes|2016|1|1|num=50|title=Generic Series|released=y}} | ||
| + | ; Specials | ||
| + | : <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}} | ||
| + | ; Show page | ||
| + | : <code><nowiki>{{Aired episodes|2016|1|1|showpage=Lucifer (TV series)}}</nowiki></code> | ||
| + | : {{Aired episodes|2016|1|1|showpage=Lucifer (TV series)}} | ||
| + | ; 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== | ||
{| class="wikitable" | {| class="wikitable" | ||
! colspan="2" | Parameter | ! colspan="2" | Parameter | ||
| Line 31: | Line 57: | ||
! 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 | ||
| − | | 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 day of the series' | + | | The year (4), month (5) and day (6) of the series' finale date.<br />''Format:'' YYYY/MM/DD |
| Number | | Number | ||
| − | | 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 | ||
| 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 | + | | Optional/Required |
| + | |- | ||
| + | ! Date | ||
| + | | date | ||
| + | | The date when entered manually; the first three numbered parameters will be ignored when this is used.<br />''Format:'' June 23, 2018 | ||
| + | | String | ||
| + | | Optional | ||
| + | |- | ||
| + | ! 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). {{para|title}} does not need to be used when {{para|showpage}} is used, as the template will automatically derive the series name from this parameter using {{tl|PAGEBASENAME}}.<br />''Format:'' Lucifer (TV series) | ||
| + | | String | ||
| + | | Optional | ||
|- | |- | ||
! Series | ! Series | ||
| title | | title | ||
| − | | The un-italicized title of the series.<br />''Format:'' Game of Thrones | + | | The un-italicized title of the series. {{para|title}} does not need to be used when {{para|showpage}} is used, as the template will automatically derive the series name from this parameter using {{tl|PAGEBASENAME}}. Using {{para|title}} without {{para|showpage}} will set {{para|showpage}} (i.e. the show's parent article) to the value of {{para|title}}.<br />''Format:'' Game of Thrones |
| String | | String | ||
| Required | | Required | ||
| Line 65: | Line 97: | ||
| Whether the season in question has been released online, rather than aired.<br />''Format:'' y | | Whether the season in question has been released online, rather than aired.<br />''Format:'' y | ||
| String | | String | ||
| + | | Optional | ||
| + | |- | ||
| + | ! Airing | ||
| + | | airing | ||
| + | | Whether the season in question is currently airing.<br />''Format:'' 5 | ||
| + | | Number | ||
| Optional | | Optional | ||
|- | |- | ||
| Line 91: | Line 129: | ||
| Optional | | Optional | ||
|} | |} | ||
| − | < | + | |
| + | ==TemplateData== | ||
| + | {{TemplateData header}} | ||
| + | <templatedata> | ||
| + | { | ||
| + | "params": { | ||
| + | "1": { | ||
| + | "label": "Year", | ||
| + | "description": "The year of the series' most recently aired episode.", | ||
| + | "type": "number" | ||
| + | }, | ||
| + | "2": { | ||
| + | "label": "Month", | ||
| + | "description": "The month of the series' most recently aired episode.", | ||
| + | "type": "number" | ||
| + | }, | ||
| + | "3": { | ||
| + | "label": "Day", | ||
| + | "description": "The day of the series' most recently aired episode.", | ||
| + | "type": "number" | ||
| + | }, | ||
| + | "finished": { | ||
| + | "label": "Finished", | ||
| + | "description": "Whether the season in question has been concluded. Add \".5\" for conclusions of split seasons. Use \"all\" for the conclusion of the series.", | ||
| + | "type": "line" | ||
| + | }, | ||
| + | "uk": { | ||
| + | "label": "UK Format", | ||
| + | "description": "Whether the series in question follows the British format of titling and dating.", | ||
| + | "example": "y", | ||
| + | "type": "line" | ||
| + | }, | ||
| + | "date": { | ||
| + | "label": "Date", | ||
| + | "description": "The date when entered manually; the first three numbered parameters will be ignored when this is used.", | ||
| + | "type": "line" | ||
| + | }, | ||
| + | "num": { | ||
| + | "label": "Number", | ||
| + | "description": "The number of episodes that the have aired up until the most recent, as a number, string or transclusion.", | ||
| + | "type": "number" | ||
| + | }, | ||
| + | "showpage": { | ||
| + | "label": "Show's parent article", | ||
| + | "description": "The unlinked parent article of the series, for usage with {{Template parameter value}} instead of using |num=.", | ||
| + | "type": "wiki-page-name" | ||
| + | }, | ||
| + | "title": { | ||
| + | "label": "Series", | ||
| + | "description": "The un-italicized title of the series.", | ||
| + | "type": "line", | ||
| + | "required": true | ||
| + | }, | ||
| + | "released": { | ||
| + | "label": "Released", | ||
| + | "description": "Whether the season in question has been released online, rather than aired.", | ||
| + | "example": "y", | ||
| + | "type": "line" | ||
| + | }, | ||
| + | "specials": { | ||
| + | "label": "Specials", | ||
| + | "description": "How many specials have been aired throughout the series.", | ||
| + | "type": "number" | ||
| + | }, | ||
| + | "seasons": { | ||
| + | "label": "Seasons", | ||
| + | "description": "The number of seasons that a concluded series aired over. Converted to word for less than 10 seasons.", | ||
| + | "type": "number" | ||
| + | } | ||
| + | }, | ||
| + | "description": "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.", | ||
| + | "paramOrder": [ | ||
| + | "1", | ||
| + | "2", | ||
| + | "3", | ||
| + | "num", | ||
| + | "date", | ||
| + | "showpage", | ||
| + | "title", | ||
| + | "released", | ||
| + | "finished", | ||
| + | "seasons", | ||
| + | "uk", | ||
| + | "specials" | ||
| + | ] | ||
| + | } | ||
| + | </templatedata> | ||
| + | |||
| + | <includeonly>{{Sandbox other|| | ||
<!-- Categories below this line, please; interwikis at Wikidata --> | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
[[Category:Television templates]] | [[Category:Television templates]] | ||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 13:55, 18 October 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. |
| This template uses Lua: |
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)}}- 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). |title= does not need to be used when |showpage= is used, as the template will automatically derive the series name from this parameter using {{PAGEBASENAME}}.Format: Lucifer (TV series) |
String | Optional |
| Series | title | The un-italicized title of the series. |title= does not need to be used when |showpage= is used, as the template will automatically derive the series name from this parameter using {{PAGEBASENAME}}. Using |title= without |showpage= will set |showpage= (i.e. the show's parent article) to the value of |title=.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 |