Template:IMDb name/doc: Difference between revisions

Latest revision as of 04:34, 3 September 2020

This is a documentation subpage for Template:IMDb name.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 154,000 pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:EditAtWikidata

This template is used to generate an external link to a web page for a person in the Internet Movie Database. It is intended for use in the external links section of an article.

For a work (film/movie, TV or Web program/series, video game, etc.), use {{IMDb title}}.

For a specific TV episode or Web series episode, use {{IMDb episode}}.

For an episode list, use {{IMDb episodes}}.

For a company, use {{IMDb company}}.

For an event, use {{IMDb event}}.

Usage

If the subject of the Wikipedia article is the same as the IMDb page, only ID number is required. The template then uses the Wikipedia article name as the anchor text.

{{IMDb name | ID }}
{{IMDb name | id= ID }}

To have the link text be other than the article name, use second parameter. This is necessary when adding an IMDb link to an article about somebody or something other than the linked person (for example, if you include the IMDb link for Bette Davis in the Joan Crawford article, you must specify Bette Davis's name as the text for the link).

{{IMDb name | ID | NAME }}
{{IMDb name | id= ID | name= NAME }}

The parameter |section= can be set to award (alternatively awards) or bio (alternatively biography) to link to the awards or biography section for that person.

{{IMDb name | ID | NAME | section= SECTION }}
{{IMDb name | id= ID | name= NAME | section= SECTION }}

The ID number may be omitted if the article's Wikidata item includes property (P345).

{{IMDb name}}
{{IMDb name | name= NAME }}
{{IMDb name | name= NAME | section= SECTION }}

Instructions and examples

Go to IMDb.com and search for the person you want (say, Marlon Brando; you'll reach https://www.imdb.com/find?q=Marlon+Brando&s=all). This can also be done on the Wikipedia page by previewing {{IMDb name}} and clicking that link ( https://www.imdb.com/find?q=Marlon+Brando&s=nm ).
Click on the correct name in the list (for the actor Marlon Brando, this will bring up the page https://www.imdb.com/name/nm0000008/)
Copy only the 7- or 8-digit number (here, "0000008"), omitting the "nm" but keep all the leading zeros.
Replace "ID" in the template code with the number
1. For the first option above, you'll then have
  * {{IMDb name | 0000008 }} resulting in:
  - IMDb name/doc at IMDb
  Note that the link text is the same as the name of the Wikipedia page the template is used on; outside the page "Marlon Brando", use the second option:
2. Replace "ID" with the number and "Name" with "Marlon Brando"
  * {{IMDb name | 0000008 | Marlon Brando }} results in:
  - Marlon Brando at IMDb
3. The parameter |section= can be set to award (alternatively awards) or bio (alternatively biography) to link to the awards or biography section for that person.
  * {{IMDb name | 0000008 | Marlon Brando | section= awards }} gives:
  - Awards for Marlon Brando at IMDb
  * {{IMDb name | 0000008 | Marlon Brando | section= bio }} gives:
  - Biography for Marlon Brando at IMDb

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for IMDb name

This template is used to generate an external link to a web page for a person in the Internet Movie Database.

Template parameters
Parameter		Description	Type	Status
ID	`id` `1`	The IMDb ID for the target page. This parameter is optional if Wikidata property P345 contains an ID starting with nm, but required if not. Default Wikidata property P345 or IMDb search URL	Number	optional
Name	`name` `2`	Name to be displayed as link text. Defaults to the Wikipedia article name, without any disambiguation such as (actor). Default {{PAGENAMEBASE}}	String	optional
Section	`section`	IMDb article section. Set to "award" or "awards" to link to the awards section. Set to "bio" or "biography" to link to the biography section.	String	optional

@@ Line 1: / Line 1: @@
-{{documentation subpage}}
+{{Documentation subpage}}
-<!--
+{{High-use}}
-    PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE
+<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
-    YOU CAN EDIT THE TEMPLATE DOCUMENTATION BELOW THIS COMMENT
+{{Uses Wikidata|P345}}
--->
+{{Lua|Module:EditAtWikidata}}
-This is a template to generate links to [[Internet Movie Database]], '''used exclusively for ''PEOPLE'''''.
-:To link a movie, use {{tl|imdb title}} instead.
+This template is used to generate an external link to a web page for a person in the [[IMDb|Internet Movie Database]]. It is intended for use in the [[Wikipedia:External links|external links]] section of an article.
-:To link a tv episode, use {{tl|imdb episode}} instead.
-:To link a company, use {{tl|imdb company}} instead.
-:To link a character, use {{tl|imdb character}} instead.
-=== Options ===
+: ''For a work (film/movie, TV or Web program/series, video game, etc.), use {{Tl|IMDb title}}.''
+: ''For a specific TV episode or Web series episode, use {{Tl|IMDb episode}}.''
+: ''For an episode list, use {{Tl|IMDb episodes}}.''
+: ''For a company, use {{Tl|IMDb company}}.''
+: ''For an event, use {{Tl|IMDb event}}.''
-The required parameter is just the ID number (for backward compatibility, the parameter can be named <code>id</code>) and the template then uses the article title as the [[anchor text]]:
+== Usage ==
-<pre>
+If the subject of the Wikipedia article is the same as the IMDb page, only ID number is required. The template then uses the Wikipedia article name as the [[anchor text]].
-* {{imdb name|ID}}
+* {{tlcw|{{BASEPAGENAME}} | <var>ID</var> }}
-</pre>
+* {{tlcw|{{BASEPAGENAME}} | id{{=}} <var>ID</var> }}
-To have the link text be other than the article name, use second parameter (for backward compatibility, it can be named <code>name</code>):
-<pre>
-* {{imdb name|ID|Name}}
-</pre>
-This can be used when the Wikipedia page name contains disambiguation brackets; for example at the page [[José Molina (writer)]] use <nowiki>{{</nowiki>imdb&nbsp;name|0596711|José Molina}} to have "{{imdb name|0596711| José Molina}}" rather than "{{imdb name|0596711| José Molina (writer)}}". This is also necessary should you need to add an IMDb link to an article about somebody or something other than the linked person (for example, if you include the IMDb link for [[Bette Davis]] in the [[Joan Crawford]] article, you must specify Bette Davis's name as the text for the link using this option).
+To have the link text be other than the article name, use second parameter. This is necessary when adding an IMDb link to an article about somebody or something other than the linked person (for example, if you include the IMDb link for [[Bette Davis]] in the [[Joan Crawford]] article, you must specify Bette Davis's name as the text for the link).
+* {{tlcw|{{BASEPAGENAME}} | <var>ID</var> | <var>NAME</var> }}
+* {{tlcw|{{BASEPAGENAME}} | id{{=}} <var>ID</var> | name{{=}} <var>NAME</var> }}
-Note that the options include the "<tt>*</tt>" for a bulleted list since this is most likely to be used in an "External links" section.
+The parameter {{Para|section}} can be set to <code>award</code> (alternatively <code>awards</code>) or <code>bio</code> (alternatively <code>biography</code>) to link to the awards or biography section for that person.
+* {{tlcw|{{BASEPAGENAME}} | <var>ID</var> | <var>NAME</var> | section{{=}} <var>SECTION</var> }}
+* {{tlcw|{{BASEPAGENAME}} | id{{=}} <var>ID</var> | name{{=}} <var>NAME</var> | section{{=}} <var>SECTION</var>}}
-== Detailed instructions ==
+The ID number may be omitted if the article's [[Wikidata]] item includes property {{Property|345}}.
+* {{tlcw|{{BASEPAGENAME}}}}
+* {{tlcw|{{BASEPAGENAME}} | name{{=}} <var>NAME</var> }}
+* {{tlcw|{{BASEPAGENAME}} | name{{=}} <var>NAME</var> | section{{=}} <var>SECTION</var>}}
-# Copy and paste one of the options above into the article
+== Instructions and examples ==
-# Go to http://www.imdb.com and search for the person you want (say, Helen Slayton-Hughes; you'll reach <code>http://www.imdb.com/find?s=all&q=Helen+Slayton-Hughes</code>)
+{{See also|Wikipedia:External links/Perennial websites#IMDb}}
-# Click on the correct Helen Slayton-Hughes in the list:
-## <code>[http://www.imdb.com/name/nm0805658/ Helen Slayton-Hughes](Actress, [http://www.imdb.com/title/tt0433383/ Good Night and Good Luck.] (2005))</code>
+# Go to [https://www.imdb.com/ IMDb.com] and search for the person you want (say, Marlon Brando; you'll reach <code>https://www.imdb.com/find?q=Marlon+Brando&s=all</code>). This can also be done on the Wikipedia page by previewing <code><nowiki>{{IMDb name}}</nowiki></code> and clicking that link ( https://www.imdb.com/find?q=Marlon+Brando&s=nm ).
-# You then reach the page with [[URL]] looking like <tt>http://www.imdb.com/name/nm0805658/</tt> (or other 7-digit number)
+# Click on the correct name in the list (for the actor [[Marlon Brando]], this will bring up the page <code>https://www.imdb.com/name/nm0000008/</code>)
-# Copy '''only''' that number (here, "<code>0805658</code>"), omitting the "<code>nm</code>" but keep all the leading zeros (though IMDB currently seems to be able to add them as needed)
+# Copy {{em|only}} the 7- or 8-digit number (here, "<code>0000008</code>"), omitting the "<code>nm</code>" but keep all the leading zeros.
-# Replace "<tt>ID</tt>" in the template code with the number
+# Replace "<code>ID</code>" in the template code with the number
 ## For the first option above, you'll then have
-##: <tt><nowiki>* {{imdb name|0805658}}</nowiki></tt> resulting in:
+##: <code><nowiki>* {{IMDb name | 0000008 }}</nowiki></code> resulting in:
-##* {{imdb name|0805658}}
+##:* {{IMDb name | 0000008 }}
-##: Note that the link text is the same as the title of the page the template is used on; outside the page "Helen Slayton-Hughes", use the second option:
+##: Note that the link text is the same as the name of the Wikipedia page the template is used on; outside the page "Marlon Brando", use the second option:
-## Replace "<tt>ID</tt>" with the number ''and'' "<tt>Name</tt>" with "<tt>Helen Slayton-Hughes</tt>"
+## Replace "<code>ID</code>" with the number ''and'' "<code>Name</code>" with "<code>Marlon Brando</code>"
-##: <tt><nowiki>* {{imdb name|0805658|Helen Slayton-Hughes}}</nowiki></tt> results in:
+##: <code><nowiki>* {{IMDb name | 0000008 | Marlon Brando }}</nowiki></code> results in:
-##:* {{imdb name|0805658|Helen Slayton-Hughes}}
+##:* {{IMDb name | 0000008 | Marlon Brando }}
+## The parameter {{Para|section}} can be set to <code>award</code> (alternatively <code>awards</code>) or <code>bio</code> (alternatively <code>biography</code>) to link to the awards or biography section for that person.
-If you still have any doubts or questions about the use of the template, you can ask at [[User talk:Kieff]] or [[User talk:Chidom]].
+##: <code><nowiki>* {{IMDb name | 0000008 | Marlon Brando | section= awards }}</nowiki></code> gives:
+##:* {{IMDb name | 0000008 | Marlon Brando | section= awards }}
-<includeonly>
+##: <code><nowiki>* {{IMDb name | 0000008 | Marlon Brando | section= bio }}</nowiki></code> gives:
+##:* {{IMDb name | 0000008 | Marlon Brando | section= bio }}
-<!-- PLEASE ADD CATEGORIES BELOW THIS LINE, THANKS. -->
+== TemplateData ==
+{{TemplateData header}}
+<templatedata>
+{
+	"description": "This template is used to generate an external link to a web page for a person in the Internet Movie Database.",
+	"params": {
+		"id": {
+			"label": "ID",
+			"aliases": [ "1" ],
+                        "description": "The IMDb ID for the target page. This parameter is optional if Wikidata property P345 contains an ID starting with nm, but required if not.",
+                        "type": "number",
+                        "required": false,
+                        "default": "Wikidata property P345 or IMDb search URL"
+		},
+		"name": {
+			"label": "Name",
+			"aliases": ["2"],
+                        "description": "Name to be displayed as link text. Defaults to the Wikipedia article name, without any disambiguation such as (actor).",
+                        "type": "string",
+                        "required": false,
+                        "default": "{{PAGENAMEBASE}}"
+		},
+		"section": {
+			"label": "Section",
+			"description": "IMDb article section. Set to \"award\" or \"awards\" to link to the awards section. Set to \"bio\" or \"biography\" to link to the biography section.",
+			"type": "string",
+			"required": false
+		}
+	}
+}
+</templatedata>
-[[Category:External link templates|Imdb name]]
+== Tracking categories ==
-[[Category:Television templates|Imdb name]]
+* {{clc|IMDb template with no id set}}
-[[Category:WikiProject Films templates|Imdb name]]
+* {{clc|IMDb template with invalid id set}}
-<!-- PLEASE ADD INTERWIKIS BELOW THIS LINE, THANKS. -->
+== See also ==
+* [[:Template:IMDb]], a list of related templates
+* [[Wikipedia:IMDb]]
-[[bg:Шаблон:Imdb name]]
+=== Similar person templates ===
-[[cs:Šablona:Imdb osoba]]
+* {{Tl|AllMovie name}}
-[[da:Skabelon:Imdb navn]]
+* {{Tl|TCMDb name}}
-[[de:Vorlage:IMDb Name]]
+* {{tl|BFI}}
-[[pt:Imdb nome]]
-[[es:Plantilla:Imdb nombre]]
-[[fi:Malline:IMDb-h]]
-[[fr:Modèle:Imdb name]]
-[[id:Templat:Imdb nama]]
-[[it:Template:Imdb nome]]
-[[mk:Шаблон:Imdb име]]
-[[ja:Template:Imdb name]]
-[[ka:თარგი:Imdb name]]
-[[hu:Sablon:Imdb név]]
-[[nl:Sjabloon:IMDb naam]]
-[[no:Mal:Imdb navn]]
-[[pl:Szablon:Imdb]]
-[[ru:Шаблон:Imdb name]]
-[[sl:Template:Imdb name]]
-[[sv:Mall:Imdb namn]]
-[[vi:Tiêu bản:Imdb name]]
-[[zh:Template:Imdb name]]
-</includeonly>
+<includeonly>{{Sandbox other||
+<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
+[[Category:Film external link templates]]
+[[Category:People and person external link templates]]
+[[Category:Television external link templates]]
+[[Category:Templates using data from Wikidata]]
+[[Category:Templates that add a tracking category]]
+[[Category:External link templates using Wikidata]]
+}}</includeonly>

Template:IMDb name/doc: Difference between revisions

Latest revision as of 04:34, 3 September 2020

Contents

Usage

Instructions and examples

TemplateData

Tracking categories

See also

Similar person templates

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

In other languages