Template:Specify: Difference between revisions

Want an adless experience? Log in or Create an account.

Template:Specify (view source)

Revision as of 20:29, October 30, 2012

998 bytes added , October 30, 2012

→‎Usage: hopefully clarified the usage.

Locke

Bureaucrats, Interface administrators, Administrators

17,230

edits

@@ Line 5: / Line 5: @@
 ==Usage==
-{{Usage|this{{=}}|other{{=}}|link{{=}}}}
+{{Usage|this{{=}}}}
-{{Usage/Param|this|A very brief description of the article on which this template is placed.|optional}}
+{{Usage/Param|this|A very brief description of this article.}}
-{{Usage/Param|other|A very brief description of the article to which this template links.|optional|"other uses"}}
-{{Usage/Param|link|A link to the contrasted article.|optional|disambiguation page}}
+The parameter "this" should always be used in order to distinguish the article on which this template is placed from other articles with similar titles. In addition, this template uses two different sets of parameters for linking to similar pages, depending on whether there is a disambiguation page associated with the title in question.
+===Disambiguation Page===
+Using {{Usage|this{{=}}}} by itself produces a link to a disambiguation page:
+<code><nowiki>{{Specify|this=the "Specify" template documentation}}</nowiki></code> → {{Specify|this=the "Specify" template documentation}}
-If there are several related titles, but one stands out as a secondary article, use ''second'' and ''secondlink'' instead of ''other'' and ''link''.
+If there is a '''second'''ary article, you can provide a link to that article in addition to the disambiguation page using the parameters "second" and "secondlink".
 {{Usage|this{{=}}|second{{=}}|secondlink{{=}}}}
-{{Usage/Param|second|A very brief description of the secondary article.}}
+{{Usage/Param|second|A brief description of the secondary article.}}
 {{Usage/Param|secondlink|A link to the secondary article.}}
+<code><nowiki>{{Specify|this=the "Specify" template documentation|second=a command to be more specific|secondlink=(link to that page)}}</nowiki></code> →
+{{Specify|this=the "Specify" template documentation|second=a command to be more specific|secondlink=(link to that page)}}
 For the rare case of having both secondary and tertiary articles as well as others, "third" and "thirdlink" are also available. These should be used sparingly and should generally not be used if the hatnote extends too far over one line.
-Examples:
+===No Disambiguation Page===
-*<code><nowiki>{{Specify}}</nowiki></code> → {{Specify}}
+If there is no disambiguation page, override the disambiguation link by defining "other" and "link".
-*<code><nowiki>{{Specify|this=the Specify template}}</nowiki></code> → {{Specify|this=the Specify template}}
-*<code><nowiki>{{Specify|other=disambiguation guidelines|link=[[Help:Disambiguation]]}}</nowiki></code> → {{Specify|other=disambiguation guidelines|link=[[Help:Disambiguation]]}}
+To specify '''this''' article from an'''other''' article and provide a '''link''' to the other article:
-*<code><nowiki>{{Specify|this=the character|second=the first game in the series|secondlink=''[[The Legend of Zelda]]''}}</nowiki></code> → {{Specify|this=the character|second=the first game in the series|secondlink=''[[The Legend of Zelda]]''}}
+{{Usage|this{{=}}|other{{=}}|link{{=}}}}
+{{Usage/Param|other|A very brief description of the article to which this template links.|optional|"other uses"}}
+{{Usage/Param|link|A link to the contrasted article.|optional|disambiguation page}}
+<code><nowiki>{{Specify|this=the "Specify" template documentation|other=a command to be more specific|link=(link to that page)}}</nowiki></code> →
+{{Specify|this=the "Specify" template documentation|other=a command to be more specific|link=(link to that page)}}
+If there is no disambiguation page but there are two or three other articles with similar titles, "second" and "secondlink" can serve to add extra links, as well as "third" and "thirdlink" as needed. Note that "other" and "link" will appear last.
 For specific guidelines on when and how to use this template, see [[Help:Disambiguation]].