Difference between revisions of "Module:Television episode disambiguation description/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Gonnym
(adding what template this module implements)
m (33 revisions imported)
 
(5 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
<!-- 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]]) -->
 +
{{Lua|Module:Arguments|Module:Extract short description}}
  
 
'''Module:Television episode disambiguation''' creates an entry in a [[disambiguation page]] by converting a plain text episode article name into a correctly formatted link and its [[WP:Short description|short description]]. The style of the links follows the guidelines at [[WP:NCTV]], [[MOS:DABENTRY]], [[MOS:ITALICTITLE]] and [[MOS:QUOTETITLE]].
 
'''Module:Television episode disambiguation''' creates an entry in a [[disambiguation page]] by converting a plain text episode article name into a correctly formatted link and its [[WP:Short description|short description]]. The style of the links follows the guidelines at [[WP:NCTV]], [[MOS:DABENTRY]], [[MOS:ITALICTITLE]] and [[MOS:QUOTETITLE]].
  
 
This module implements the {{tl|Television episode disambiguation description}} template.
 
This module implements the {{tl|Television episode disambiguation description}} template.
 +
 +
== Usage ==
 +
* {{Mlx|{{BASEPAGENAME}}|main}}
  
 
== Parameter list ==
 
== Parameter list ==
* <code>name</code> — required; The episode's full article name.
+
{| class="wikitable"
* <code>not_disambiguated</code> — optional; Set if the parentheses is part of the episode name.
+
|-
* <code>link_only</code> — optional; Set if you are only interested in getting a formatted article link.
+
! scope="col" | Parameter
 
+
! scope="col" | Explanation
== Usage ==
+
! scope="col" | Status
* <code><nowiki>{{#invoke:Television episode disambiguation description|main|name= }}</nowiki></code>
+
|-
* <code><nowiki>{{#invoke:Television episode disambiguation description|main|name= |not_disambiguated= }}</nowiki></code>
+
! scope="row" | <code>name</code>
* <code><nowiki>{{#invoke:Television episode disambiguation description|main|name= |link_only= }}</nowiki></code>
+
| The episode's full article name
* <code><nowiki>{{#invoke:Television episode disambiguation description|main|name= |not_disambiguated= |link_only= }}</nowiki></code>
+
| '''required'''
 +
|-
 +
! scope="row" | <code>not_disambiguated</code>
 +
| Set if the parentheses is part of the episode name
 +
| optional
 +
|-
 +
! scope="row" | <code>link_only</code>
 +
| Set if you are only interested in getting a formatted article link
 +
| optional
 +
|}
  
 
== Examples ==
 
== Examples ==
 
+
{{Further|Template:Television episode disambiguation description#Examples}}
=== An entry for an episode title that isn't disambiguated ===
 
* Code: <code><nowiki>{{#invoke:Television episode disambiguation description|main|name=Pickle Rick}}</nowiki></code>
 
* Produces: {{code|{{#invoke:Television episode disambiguation description|main|name=Pickle Rick}}}}
 
 
 
=== An entry for an episode title that is disambiguated with TV series name ===
 
* Code: <code><nowiki>{{#invoke:Television episode disambiguation description|main|name=The End (Lost)}}</nowiki></code>
 
* Produces: {{code|{{#invoke:Television episode disambiguation description|main|name=The End (Lost)}}}}
 
 
 
=== An entry for an episode title that is disambiguated with TV series name and "episode" ===
 
* Code: <code><nowiki>{{#invoke:Television episode disambiguation description|main|name=Serenity (Firefly episode)}}</nowiki></code>
 
* Produces: {{code|{{#invoke:Television episode disambiguation description|main|name=Serenity (Firefly episode)}}}}
 
 
 
=== An entry using the "not_disambiguated" parameter ===
 
* Code: <code><nowiki>{{#invoke:Television episode disambiguation description|main|name=World Wharf II: The Wharfening (or How Bob Saves/Destroys the Town – Part II)|not_disambiguated=yes}}</nowiki></code>
 
* Produces: {{code|{{#invoke:Television episode disambiguation description|main|name=World Wharf II: The Wharfening (or How Bob Saves/Destroys the Town – Part II)|not_disambiguated=yes}}}}
 
 
 
=== An entry using the "link_only" parameter ===
 
* Code: <code><nowiki>{{#invoke:Television episode disambiguation description|main|name=Hush (Buffy the Vampire Slayer)|link_only=yes}}</nowiki></code>
 
* Produces: {{code|{{#invoke:Television episode disambiguation description|main|name=Hush (Buffy the Vampire Slayer)|link_only=yes}}}}
 
  
 
== See also ==
 
== See also ==
Line 42: Line 36:
 
* [[Module:Television episode short description]]
 
* [[Module:Television episode short description]]
 
* [[Template:Television episode short description]]
 
* [[Template:Television episode short description]]
 +
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<!-- Categories below this line, please; interwikis at Wikidata -->
 
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia modules]]
+
[[Category:Television-related modules]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 17:17, 29 September 2020

Module:Television episode disambiguation creates an entry in a disambiguation page by converting a plain text episode article name into a correctly formatted link and its short description. The style of the links follows the guidelines at WP:NCTV, MOS:DABENTRY, MOS:ITALICTITLE and MOS:QUOTETITLE.

This module implements the {{Television episode disambiguation description}} template.

Usage

Parameter list

Parameter Explanation Status
name The episode's full article name required
not_disambiguated Set if the parentheses is part of the episode name optional
link_only Set if you are only interested in getting a formatted article link optional

Examples

See also