View source for Template:W/doc

<noinclude>{{doc subpage}}[[Category:Template documentation]]</noinclude>
== Documentation ==

This template provides a convenient way of linking to or citing an article (or any other page) at Wikipedia.

It exists mainly to:
# save a little typing in the simplest cases (compare: {{code|<nowiki>[[wikipedia:Norway|Norway]]</nowiki>}} vs. {{tc|w|Norway}});
# make it easier to find pages on which such links are used, via the "[[Special:WhatLinksHere/Template:W|WhatLinksHere]]" feature (as there is no way to find interwiki links with a search);
# provide a distinct way of indicating that such links leave the wiki (by default, [[mw:Help:Links#Interwiki links|interwiki links]] are not styled like [//mediawiki.org/wiki/Help:Links#External_links external links]); and
# provide a quick way to cite Wikipedia as a reference.

The template does not complain about missing input; instead it uses the name of the page calling the template as the link target if no Wikipedia article title is specified (as seen above — note that the name of this template page is "W").

The name of the template is, of course, based on the word "{{tt|<u>W</u>ikipedia}}".

{{high-usage-template warning}}

=== Usage ===

Common forms (other combinations are possible):

* {{tc-var|w|Article Title}}
* {{tc-var|w|Article Title|linked text}}
* <code><nowiki>{{w</nowiki>|<var>Article Title</var>|<var>linked text</var>|accessed=<var>access date</var>}}</code>
* <code><nowiki>{{w</nowiki>|lang=<var>code</var>|<var>Article Title</var>}}</code>
* <code><nowiki>{{w</nowiki>|lang=<var>code</var>|<var>Article Title</var>|site=<var>site name if not Wikipedia</var>}}</code>
* <code><nowiki>{{w</nowiki>|<var>Article Title</var>|encl=<var>char</var>}}</code>
* <code><nowiki>{{w</nowiki>|<var>Article Title</var>|open=<var>char</var>|close=<var>char</var>}}</code>

Note that "Article Title" here refers to the title of an article at Wikipedia, not the title of the wiki article in which the template call is used. And {{tpvv|char}} stands for "character", although these parameter values do not actually need to be single characters (but they usually are).

When used with the {{tp|accessed}} parameter, the template acts more like a citation template, as seen in the examples below.

There is no significance to the {{tp|lang}} parameter appearing before the Wikipedia article title (the first unnamed parameter) in the third and fourth forms above, except that this mirrors the way interwiki links are formed (e.g., {{tc|1=w|2=lang=no|3=Norske Talenter}} is equivalent to {{wl|wikipedia:no:Norske Talenter|Norske Talenter}}). Note that the value specified for the {{tp|lang}} parameter ''must not end with a colon'', because the colon is already provided by the template itself. This value must be the subdomain of the non-English Wikipedia you want to link to — i.e., the part of the URL before {{code|.wikipedia.org}} (see examples below).

The {{tp|encl}} [referring to "enclosure" or "enclosing character(s)"] and {{tp|open}}/{{tp|close}} parameters can be used for quotation marks and the like, so these things will appear before the little "leaving the wiki" indicator but outside of the link itself (see examples below). Any combination of these three parameters can be used together (for example, you could use {{tp|encl}} and {{tp|close}} without {{tp|open}}, if that's necessary for some reason).

==== All parameters ====

* <code><nowiki>{{w|lang=|||site=|encl=|open=|close=|pre=|post=|accessed=}}</nowiki></code>

The two positional parameters between {{tp|lang}} and {{tp|site}} are for the Wikipedia article title and (if different) the text to be linked.

=== Examples ===

* <code><nowiki>{{w|Willie Nelson}}</nowiki></code> ⇒ {{w|Willie Nelson}}
* <code><nowiki>{{w|Gloomy Sunday|encl="}}</nowiki></code> ⇒ {{w|Gloomy Sunday|encl="}}
* <code><nowiki>{{w|Gloomy Sunday|encl="|accessed=2020-10-23}}</nowiki></code> ⇒ {{w|Gloomy Sunday|encl="|accessed=2020-10-23}}
* <code><nowiki>{{w|Norway's Got Talent|encl=''}}</nowiki></code> ⇒ {{w|Norway's Got Talent|open=''|close=''}}<!-- avoid runaway syntax highlighting in editor -->
* <code><nowiki>{{w|lang=no|Norske Talenter|open=«|close=»}}</nowiki></code> ⇒ {{w|lang=no|Norske Talenter|open=«|close=»}}
* <code><nowiki>{{w|lang=no|Norske Talenter|encl="|open=«|close=»|pre=¿|post=?}}</nowiki></code> ⇒ {{w|lang=no|Norske Talenter|encl="|open=«|close=»|pre=¿|post=?}}
* <code><nowiki>{{w|All of Me (John Legend song)|All of Me|encl="}}</nowiki></code> ⇒ {{w|All of Me (John Legend song)|All of Me|encl="}}
* <code><nowiki>{{w|wikt:acronym|acronym|site=Wiktionary}}</nowiki></code> ⇒ {{w|wikt:acronym|acronym|site=Wiktionary}}

The fifth example is there just for "completeness", to show the order of the {{tp|encl}}, {{tp|open}}/{{tp|close}}, and  {{tp|pre}}/{{tp|post}} parameters, when used together.

The last example shows how Wikipedia's interwiki linking feature can be taken advantage of to link to other sites. In this case, the same thing could be accomplished more "cleanly" using {{tl|iw}}:

* <code><nowiki>{{iw|wikt|acronym|site=Wiktionary}}</nowiki></code> ⇒ {{iw|wikt|acronym|site=Wiktionary}}

==== Using quotation marks directly ====

Trying to use quotation marks in or around the template call (without using the {{tp|encl}} parameter) doesn't really work too well:

* <code><nowiki>"{{w|Gloomy Sunday}}"</nowiki></code> ⇒ "{{w|Gloomy Sunday}}"
* <code><nowiki>{{w|"Gloomy Sunday"}}</nowiki></code> ⇒ {{w|"Gloomy Sunday"}}
* <code><nowiki>{{w|Gloomy Sunday|"Gloomy Sunday"}}</nowiki></code> ⇒ {{w|Gloomy Sunday|"Gloomy Sunday"}}
* <code><nowiki>"[//en.wikipedia.org/wiki/Gloomy_Sunday Gloomy Sunday]"</nowiki></code> ⇒ "[//en.wikipedia.org/wiki/Gloomy_Sunday Gloomy Sunday]"
* <code><nowiki>[//en.wikipedia.org/wiki/Gloomy_Sunday "Gloomy Sunday"]</nowiki></code> ⇒ [//en.wikipedia.org/wiki/Gloomy_Sunday "Gloomy Sunday"]

These last two examples use external links, just for comparison.

The link in the second example is broken at Wikipedia (the relevant article there does not have quotation marks). The first and fourth just look weird. The third and fifth look and work fine, but are tedious to implement (and a bit error-prone).

=== See also ===

{{List of iw-based templates|nobold=<noinclude>y</noinclude>}}

<includeonly>
[[Category:Templates]]
[[Category:Templates for interwiki linking]]
[[Category:Templates that can be called with or without input]]
</includeonly>