Template:Goon Show episode short description/doc: Difference between revisions

From The Goon Show Depository
m (1 revision imported)
 
(4 intermediate revisions by 2 users not shown)
Line 2: Line 2:
{{auto short description}}
{{auto short description}}
<!-- 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]]) -->
{{High-use}}
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}}
{{Lua|Module:Television episode short description}}
{{Lua|Module:Goon Show episode short description}}


'''Template:Television episode short description''' is used to create a short description by either automatically extracting data from a television episode article's [[Template:Infobox television episode]] or by manually receiving the needed values. It then creates a relevant [[WP:Short description|short description]] based on the data available.
'''Template:Goon Show episode short description''' is used to create a short description by either automatically extracting data from a television episode article's [[Template:Infobox television episode]] or by manually receiving the needed values. It then creates a relevant [[GSD:Short description|short description]] based on the data available.


== Usage ==
== Usage ==
Line 14: Line 14:


== Parameter list ==
== Parameter list ==
{{Transcluded section|source=Module:Television episode short description/doc}}
{{Transcluded section|source=Module:Goon Show episode short description/doc}}
{{Trim|{{#section:Module:Television episode short description/doc|Parameters}}}}
{{Trim|{{#section:Module:Goon Show episode short description/doc|Parameters}}}}


=== TemplateData ===
=== TemplateData ===
{{Collapse top|title=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{Collapse top|title=[[GSD:TemplateData|TemplateData]] documentation used by [[GSD:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
{{TemplateData header|noheader=1}}
<templatedata>
<templatedata>
Line 89: Line 89:
=== No parameters ===
=== No parameters ===
* Code: {{Tlx|{{BASEPAGENAME}}}}
* Code: {{Tlx|{{BASEPAGENAME}}}}
* Produces: <code>{{Television episode short description|doc=yes}}</code>
* Produces: <code>{{Goon Show episode short description|doc=yes}}</code>


=== Usage with only the TV series name ===
=== Usage with only the Goon Show series name ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost}}
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost}}</code>
* Produces: <code>{{Goon Show episode short description|doc=yes|series_name=Lost}}</code>


=== Usage with the TV series name and season number ===
=== Usage with the Goon Show series name and season number ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}1}}
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}1}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|season_num=1}}</code>
* Produces: <code>{{Goon Show episode short description|doc=yes|series_name=Lost|season_num=1}}</code>


=== Usage with the TV series name, episode and season number ===
=== Usage with the Goon Show series name, episode and season number ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}5|episode_num{{=}}4}}
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}5|episode_num{{=}}4}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|season_num=5|episode_num=4}}</code>
* Produces: <code>{{Goon Show episode short description|doc=yes|series_name=Lost|season_num=5|episode_num=4}}</code>


=== Usage with the TV series name with disambiguation, episode and season number ===
=== Usage with the Goon Show series name with disambiguation, episode and season number ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}[[Firefly (TV series)|Firefly]]|season_num{{=}}1|episode_num{{=}}1}}
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}[[Firefly (Goon Show series)|Firefly]]|season_num{{=}}1|episode_num{{=}}1}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=[[Firefly (TV series)|Firefly]]|season_num=1|episode_num=1}}</code>
* Produces: <code>{{Goon Show episode short description|doc=yes|series_name=[[Firefly (Goon Show series)|Firefly]]|season_num=1|episode_num=1}}</code>


=== Usage with a multi-part episode - two episodes  ===
=== Usage with a multi-part episode - two episodes  ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}3|episode_num{{=}}22 and 23}}
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}3|episode_num{{=}}22 and 23}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|season_num=3|episode_num=22 and 23}}</code>
* Produces: <code>{{Goon Show episode short description|doc=yes|series_name=Lost|season_num=3|episode_num=22 and 23}}</code>


=== Usage with a multi-part episode - three episodes ===
=== Usage with a multi-part episode - three episodes ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}3|episode_num{{=}}22, 23, 34}}
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|season_num{{=}}3|episode_num{{=}}22, 23, 34}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|season_num=3|episode_num=22, 23, 24}}</code>
* Produces: <code>{{Goon Show episode short description|doc=yes|series_name=Lost|season_num=3|episode_num=22, 23, 24}}</code>


=== Usage with a TV series name that has parentheses as part of its name ===
=== Usage with a Goon Show series name that has parentheses as part of its name ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Randall and Hopkirk (Deceased)|season_num{{=}}1|episode_num{{=}}1|not_dab{{=}}yes}}
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Randall and Hopkirk (Deceased)|season_num{{=}}1|episode_num{{=}}1|not_dab{{=}}yes}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Randall and Hopkirk (Deceased)|season_num=1|episode_num=1|not_dab=yes}}</code>
* Produces: <code>{{Goon Show episode short description|doc=yes|series_name=Randall and Hopkirk (Deceased)|season_num=1|episode_num=1|not_dab=yes}}</code>


=== Usage with a TV series name, and special episode - using "yes" ===
=== Usage with a Goon Show series name, and special episode - using "yes" ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|special{{=}}1}}
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|special{{=}}1}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|special=yes}}</code>
* Produces: <code>{{Goon Show episode short description|doc=yes|series_name=Lost|special=yes}}</code>


=== Usage with a TV series name, and special episode - using text value ===
=== Usage with a Goon Show series name, and special episode - using text value ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|special{{=}}Recap}}
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost|special{{=}}Recap}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost|special=Recap}}</code>
* Produces: <code>{{Goon Show episode short description|doc=yes|series_name=Lost|special=Recap}}</code>


=== Usage with a TV series name, and limited_series ===
=== Usage with a Goon Show series name, and limited_series ===
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost: Missing Pieces|limited_series{{=}}yes|episode_num{{=}}1}}
* Code: {{Tlx|{{BASEPAGENAME}}|series_name{{=}}Lost: Missing Pieces|limited_series{{=}}yes|episode_num{{=}}1}}
* Produces: <code>{{Television episode short description|doc=yes|series_name=Lost: Missing Pieces|limited_series=yes|episode_num=1}}</code>
* Produces: <code>{{Goon Show episode short description|doc=yes|series_name=Lost: Missing Pieces|limited_series=yes|episode_num=1}}</code>


== Issues ==
== Issues ==
{{Transcluded section|source=Module:Television episode short description/doc}}
{{Transcluded section|source=Module:Goon Show episode short description/doc}}
{{Trim|{{#section:Module:Television episode short description/doc|Issues}}}}
{{Trim|{{#section:Module:Goon Show episode short description/doc|Issues}}}}


== Tracking categories ==
== Tracking categories ==
{{Transcluded section|source=Module:Television episode short description/doc}}
{{Transcluded section|source=Module:Goon Show episode short description/doc}}
{{Trim|{{#section:Module:Television episode short description/doc|Categories}}}}
{{Trim|{{#section:Module:Goon Show episode short description/doc|Categories}}}}


== See also ==
== See also ==
* [[Module:Television episode short description]]
* [[Module:Goon Show episode short description]]
* [[Module:Television episode disambiguation description]]
* [[Module:Goon Show episode disambiguation description]]
* [[Template:Television episode disambiguation description]]
* [[Template:Goon Show episode disambiguation description]]
 
<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Television templates]]
[[Category:Goon Show templates]]
 
}}</includeonly>
}}</includeonly>

Latest revision as of 18:37, 17 September 2022

Template:Goon Show episode short description is used to create a short description by either automatically extracting data from a television episode article's Template:Infobox television episode or by manually receiving the needed values. It then creates a relevant short description based on the data available.

Usage

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.|season_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.|series_name= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.}}

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.|season_num_uk= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.|series_name= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.}}

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.|season_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.|series_name|multi_episodes= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.}}

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.|season_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.|series_name|not_dab= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.}}

Parameter list

The parameter names use a corresponding parameter from Template:Infobox Goon Show episode to fill in the data. They are listed below.

Parameter Corresponding infobox parameter Description
series_name series The TV series name.
episode_num episode The episode's number.
season_num season The season's number.
season_num_uk series_no The season's number if using the British "series" term.
not_dab same name Set if the TV series name has parentheses as part of its name.
special same name Setting to "yes" will set the description as a "special episode". Any other value will replace the word "special" with the one entered. For example |special=recap will set the text to "recap episode".
limited same name Set if the series is a single season series, such as miniseries or limited series and does not need a season number as part of the description.

TemplateData

TemplateData documentation used by VisualEditor and other tools
See a monthly parameter usage report for Template:Goon Show episode short description in articles based on its TemplateData.

TemplateData for Goon Show episode short description

This template is used to create a short description by either automatically extracting data from a television episode article's Template:Infobox television episode or by manually receiving the needed values. It then creates a relevant short description based on the data available.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Episode numberepisode_num

The episode's number.

Stringsuggested
Season numberseason_num

The season's number.

Stringsuggested
Season number UKseason_num_uk

The season's number if using the British "series" term.

Stringoptional
Series nameseries_name

The TV series name.

Stringsuggested
Not dabnot_dab

Set if the TV series name has parentheses as part of its name.

Stringoptional
Specialspecial

Setting to "yes" will set the description as a "special episode". Any other value will replace the word "special" with the one entered. For example "recap" will set the text to "recap episode".

Stringoptional
Limited serieslimited_series

Set if the series is a single season series, such as miniseries or limited series and does not need a season number as part of the description.

Stringoptional

Examples

No parameters

Usage with only the Goon Show series name

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Lost}}

  • Produces: Episode of Lost

Usage with the Goon Show series name and season number

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Lost|season_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.1}}

  • Produces: Episode of the 1st season of Lost

Usage with the Goon Show series name, episode and season number

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Lost|season_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.5|episode_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.4}}

  • Produces: 4th episode of the 5th season of Lost

Usage with the Goon Show series name with disambiguation, episode and season number

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Firefly|season_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.1|episode_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.1}}

  • Produces: 1st episode of the 1st season of Firefly

Usage with a multi-part episode - two episodes

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Lost|season_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.3|episode_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.22 and 23}}

  • Produces: 22nd and 23rd episodes of the 3rd season of Lost

Usage with a multi-part episode - three episodes

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Lost|season_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.3|episode_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.22, 23, 34}}

  • Produces: 22nd, 23rd and 24th episodes of the 3rd season of Lost

Usage with a Goon Show series name that has parentheses as part of its name

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Randall and Hopkirk (Deceased)|season_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.1|episode_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.1|not_dab= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.yes}}

  • Produces: 1st episode of the 1st season of Randall and Hopkirk (Deceased)

Usage with a Goon Show series name, and special episode - using "yes"

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Lost|special= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.1}}

  • Produces: Special episode of Lost

Usage with a Goon Show series name, and special episode - using text value

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Lost|special= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Recap}}

  • Produces: Recap episode of Lost

Usage with a Goon Show series name, and limited_series

Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.Lost: Missing Pieces|limited_series= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.yes|episode_num= Error: The retired template {{Template:Goon Show episode short description/doc}} has been transcluded; see mw:Help:Magic words#Other for details. To fix this, use only the code {{=}} to generate the = character.1}}

  • Produces: Episode of Lost: Missing Pieces

Issues

  1. If an article does not show the short description with the data from the infobox, make sure you entered the parameter names correctly in the infobox.

Tracking categories

See also