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

From blackwiki
Jump to navigation Jump to search
blackwiki>Gonnym
(→‎An entry using all three parameters: changed header and example)
blackwiki>Gonnym
(→‎Examples: simplified headers)
Line 16: Line 16:
 
== Examples ==
 
== Examples ==
  
=== An entry using the "name" parameter for an episode title that isn't disambiguated ===
+
=== An entry for an episode title that isn't disambiguated ===
 
* Code: <code><nowiki>{{#invoke:Television episode disambiguation description|main|name=Pickle Rick}}</nowiki></code>
 
* 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}}</code>
 
* Produces: <code>{{#invoke:Television episode disambiguation description|main|name=Pickle Rick}}</code>
 
* Article name formatted as: <code><nowiki>[[Pickle Rick|"Pickle Rick"]]</nowiki></code>
 
* Article name formatted as: <code><nowiki>[[Pickle Rick|"Pickle Rick"]]</nowiki></code>
  
=== An entry using the "name" parameter for an episode title that is disambiguated with TV series name ===
+
=== 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>
 
* 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)}}</code>
 
* Produces: <code>{{#invoke:Television episode disambiguation description|main|name=The End (Lost)}}</code>
 
* Article name formatted as: <code><nowiki>[[The End (Lost)|"The End" (''Lost'')]]</nowiki></code>
 
* Article name formatted as: <code><nowiki>[[The End (Lost)|"The End" (''Lost'')]]</nowiki></code>
  
=== An entry using the "name" parameter for an episode title that is disambiguated with TV series name and "episode" ===
+
=== 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>
 
* 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)}}</code>
 
* Produces: <code>{{#invoke:Television episode disambiguation description|main|name=Serenity (Firefly episode)}}</code>
 
* Article name formatted as: <code><nowiki>[[Serenity (Firefly episode)|"Serenity" (''Firefly'' episode)]]</nowiki></code>
 
* Article name formatted as: <code><nowiki>[[Serenity (Firefly episode)|"Serenity" (''Firefly'' episode)]]</nowiki></code>
  
=== An entry using the "name" and "not_disambiguated" parameters ===
+
=== 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>
 
* 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}}</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}}</code>

Revision as of 07:02, 5 October 2018


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.

Parameter list

  • name — required; The episode's full article name.
  • not_disambiguated — optional; Set if the parentheses is part of the episode name.
  • link_only — optional; Set if you are only interested in getting a formatted article link.

Usage

  • {{#invoke:Television episode disambiguation description|main|name= }}
  • {{#invoke:Television episode disambiguation description|main|name= |not_disambiguated= }}
  • {{#invoke:Television episode disambiguation description|main|name= |link_only= }}
  • {{#invoke:Television episode disambiguation description|main|name= |not_disambiguated= |link_only= }}

Examples

An entry for an episode title that isn't disambiguated

  • Code: {{#invoke:Television episode disambiguation description|main|name=Pickle Rick}}
  • Produces: "Pickle Rick", error: no article: Pickle Rick
  • Article name formatted as: [[Pickle Rick|"Pickle Rick"]]

An entry for an episode title that is disambiguated with TV series name

  • Code: {{#invoke:Television episode disambiguation description|main|name=The End (Lost)}}
  • Produces: "The End" (Lost), error: no article: The End (Lost)
  • Article name formatted as: [[The End (Lost)|"The End" (''Lost'')]]

An entry for an episode title that is disambiguated with TV series name and "episode"

  • Code: {{#invoke:Television episode disambiguation description|main|name=Serenity (Firefly episode)}}
  • Produces: "Serenity" (Firefly episode), error: no article: Serenity (Firefly episode)
  • Article name formatted as: [[Serenity (Firefly episode)|"Serenity" (''Firefly'' episode)]]

An entry using the "not_disambiguated" parameter

  • 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}}
  • Produces: "World Wharf II: The Wharfening (or How Bob Saves/Destroys the Town – Part II)", error: no article: World Wharf II: The Wharfening (or How Bob Saves/Destroys the Town – Part II)
  • Article name formatted as: "[[World Wharf II: The Wharfening (or How Bob Saves/Destroys the Town – Part II)]]"

An entry using the "link_only" parameter

See also