View source for Template:W/doc

{{Documentation subpage}}
{{possible-risk}}
{{w nav}}
This template generates a '''conditional link''' &mdash; either to a local target if it exists, or to (ordinarily) Wikipedia if the local target does not exist.

: <code>{{tlx|w|''target''}}</code>
: <code>{{tlx|w|''target''|''label''}}</code>
: <code>{{tlx|w|2=''target''|3=anchor=''section''{{!}}''label''}}</code>

Optional named parameter <code>anchor</code> links to a specific section of a Wikipedia page, and does not attempt to autodetect a local target.  It should be rarely used; eliminating template calls that use it requires idiosyncratic remedies.

=== Examples ===
{| class="wikitable"
|-
! Code
! Result
! Note
|-
|<code>{{tlx|w|Australia}}</code>
|{{W|Australia}}
|links to the local category ([[:Category:Australia]]), because it does exist.
|-
|<code>{{tlx|w|Australia|Australians}}</code>
|{{W|Australia|Australians}}
|links to the local category ([[:Category:Australia]]), because it does exist.
|-
|<code>{{tlx|w|Department of Immigration and Border Protection}}</code>
|{{W|Department of Immigration and Border Protection}}
|links to the Wikipedia article, because a local category ([[:Category:Department of Immigration and Border Protection]]) does ''not'' exist (as of this writing, anyway; if it gets created someday, we'll need a different example here).
|}

=== Removing ===

Exercise '''care when removing''' calls to this template from a page: it is used, in part, to keep track of page categorization.
* If the local target doesn't exist, you probably shouldn't be removing the template call.
* If the local target does exist, '''consider''' whether the calling page should belong to some category associated with the local target, and if it should belong but doesn't, '''add it''' to that category.  Then eliminate the locally linking template call by changing <code>{{tlx|w|...}}</code> to <code><nowiki>[[...]]</nowiki></code>.

This template populates three hidden categories:  when linking to Wikipedia (without an anchor), it adds the calling page to [[:Category:Pages with defaulting non-local links]]; when linking to the local target, it adds the calling page to [[:Category:Pages with categorizable local links]]; when linking to Wikipedia with an anchor, it adds the calling page to [[:Category:Pages with forced foreign links]].

A '''gadget''' is provided to complement this template, "Underline in green categorizable {{tl|w}} links".  The gadget also puts a dashed underline on forced foreign {{tl|w}} links.

=== Other parameters ===

Optional parameter <code>nocat</code> can be set to any non-blank value to suppress categorization of the calling page based on this template call.

Optional parameter <code>foreign</code> can be set to either of two values to cause specialized effects.  This optional parameter is ignored if <code>anchor</code> is used.
* <code><nowiki>foreign=force</nowiki></code>&nbsp; links to Wikipedia, without checking for a local target.  Categorizes to [[:Category:Pages with forced foreign links]].
* <code><nowiki>foreign=suppress</nowiki></code>&nbsp; behaves as usual for local links, but if the link would be to Wikipedia, the label is unlinked.  Does not affect categorization, which is still to [[:Category:Pages with defaulting non-local links]].

Optional parameter <code>sister</code> can be set to the wikilink prefix of a sister other than Wikipedia, to override Wikipedia as the choice of non-local target when wikilinking non-locally.  It has no effect on ''whether'' a non-local wikilink is provided, only on the target when used.  Omit the trailing ":" from the prefix.  For example, <code><nowiki>{{w|Somalia|sister=wikt|foreign=force}}</nowiki></code> would link to {{w|Somalia|sister=wikt|foreign=force|wikt:Somalia}}.  There's a table of the prefixes for various sisters [[Meta:Help:Interwiki linking#Project titles and shortcuts|at meta]].  For non-English languages, use the sister prefix, a colon, and the language code; for example, <code><nowiki>{{w|sister=w:fr|Souhail Alouini}}</nowiki></code> would link to {{w|sister=w:fr|Souhail Alouini}} (as of this writing, Souhail Alouini has no local target and no en.wp target).

=== See also ===
* {{tl|wikt}}
=== TemplateData ===
<templatedata>
{
	"params": {
		"1": {
			"label": "target",
			"description": "Page to link to",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "label",
			"description": "Text to display instead of the target link",
			"type": "string"
		},
		"anchor": {
			"label": "anchor",
			"description": "Link to a specific section of a Wikipedia page",
			"type": "string"
		}
	},
	"description": "A template to generate a conditional link - link to a local target if it exists, else link to Wikipedia."
}
</templatedata>
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Navigational templates]]
[[Category:Interwiki templates]]

[[es:Plantilla:W]]
[[fa:الگو:و]]
[[ru:Шаблон:W]]
</includeonly>