View source for Template:Television episode disambiguation description/doc

{{Documentation subpage}}
{{Lua|Module:Television episode disambiguation description}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

'''Template:Television episode disambiguation description''' 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]].

== Usage ==
* {{Tlx|{{BASEPAGENAME}}|name{{=}}}}
* {{Tlx|{{BASEPAGENAME}}|name{{=}}|not_disambiguated{{=}}}}
* {{Tlx|{{BASEPAGENAME}}|name{{=}}|link_only{{=}}}}
* {{Tlx|{{BASEPAGENAME}}|name{{=}}|not_disambiguated{{=}}|link_only{{=}}}}

== Parameter list ==
{| class="wikitable"
|-
! scope="col" | Parameter
! scope="col" | Explanation
! scope="col" | Status
|-
! scope="row" | <code>name</code>
| The episode's full article name
| '''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
|}

=== TemplateData ===
{{TemplateData header}}
<templatedata>
{
	"description": "This template creates an entry in a disambiguation page by converting a plain text episode article name into a correctly formatted link and its short description.",
	"params": {
		"name": {
			"label": "Name",
			"type": "string",
			"required": true,
			"suggested": false,
			"deprecated": false,
			"description": "The episode's full article name."
		},
		"not_disambiguated": {
			"label": "Not disambiguated",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Set if the parentheses is part of the episode name."
		},
		"link_only": {
			"label": "Link only",
			"type": "string",
			"required": false,
			"suggested": false,
			"deprecated": false,
			"description": "Set if you are only interested in getting a formatted article link."
		}
	},
	"format": "inline"
}
</templatedata>

== Examples ==

=== An entry for an episode title that isn't disambiguated ===
* Code: {{Tlx|{{BASEPAGENAME}}|name{{=}}Pickle Rick}}
* Produces: {{code|{{Television episode disambiguation description|name=Pickle Rick}}}}

=== An entry for an episode title that is disambiguated with TV series name ===
* Code: {{Tlx|{{BASEPAGENAME}}|name{{=}}The End (Lost)}}
* Produces: {{code|{{Television episode disambiguation description|name=The End (Lost)}}}}

=== An entry for an episode title that is disambiguated with TV series name and "episode" ===
* Code: {{Tlx|{{BASEPAGENAME}}|name{{=}}Serenity (Firefly episode)}}
* Produces: {{code|{{Television episode disambiguation description|name=Serenity (Firefly episode)}}}}

=== An entry using the "not_disambiguated" parameter ===
* Code: {{Tlx|{{BASEPAGENAME}}|name{{=}}World Wharf II: The Wharfening (or How Bob Saves/Destroys the Town – Part II)|not_disambiguated{{=}}yes}}
* Produces: {{code|{{Television episode disambiguation description|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: {{Tlx|{{BASEPAGENAME}}|name{{=}}Hush (Buffy the Vampire Slayer)|link_only{{=}}yes}}
* Produces: {{code|{{Television episode disambiguation description|name=Hush (Buffy the Vampire Slayer)|link_only=yes}}}}

== See also ==
* [[Module:Television episode disambiguation description]]
* [[Module:Television episode short description]]
* [[Template:Television episode short description]]

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Television templates]]
}}</includeonly>