Template:W/doc: Difference between revisions

Latest revision as of 20:12, 11 August 2026

Note: This template is used on a great lot of pages. In order not to put too much load on the servers, edits should be kept to a bare minimum. Please discuss proposed changes on the talk page first.

Editing a template causes all pages that use the template to be re-rendered. If the template is used often, this can put a lot of load on the servers since it fills up the job queue.
Keep in mind that templates that are used on file description pages also show up on other wikis.

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:W.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

This template is used to help create interwiki links without displaying the prefix, and without the need for repetition if the same page name is to display; understroke characters in the page name are replaced by space characters.

The default template name is simply W which creates a link to the English Wikipedia.

However any language code (>400 templates) instead of en can be specified in the third parameter.

It is also possible to categorize using the (first or second) parameter.

Usage

Interwiki prefixes:

Wikipedia: wikipedia; wp; w
Wiktionary: wiktionary; wikt
Wikiquote: wikiquote; wq; q
Wikisource: wikisource; ws; s
Wikibooks: wikibooks; wb; b
Wikiversity: wikiversity; wv; v
Wikispecies: wikispecies; species; wsp
Wikinews: wikinews; wn; n
Wikivoyage: wikivoyage; voy
Wikidata: wikidata; wd; d
Wikimedia Commons: commons; c
Wikifunctions: wikifunctions; func; f
Meta-Wiki: meta; m; metawiki; metawikimedia; metawikipedia
Wikimedia Incubator: incubator; inc
Wikimedia Outreach: outreach; outreachwiki
Wikimedia Foundation: foundation; wmf; wikimedia
MediaWiki.org: mediawikiwiki; mw; mediawiki
Wikitech: wikitech; labsconsole
Wikimedia Strategy: strategy
Wikimedia Quality: quality
SUL util: sulutil
Stewards' noticeboard / spcom: spcom
Toolforge: toolforge; toollabs
Phabricator: phabricator; phab; bugzilla; mediazilla
Wikimania: wikimania; wmania; wm
Wikimania 2012: wikimania2012; wm2012
Wikimania 2013: wikimania2013; wm2013

Template parameters

Parameter	Description		Default	Status
`1`	Page Name	Also specific [sub]pages or name spaces as user, category, talk ...	main page of the wiki	suggested
`2`	Display Text		`{{{1}}}`	optional
`3`	Interwiki Prefix	language code (ISO 639-1), and/or sisterproject prefix	`en`	optional
`4`	category request	+ or c: categorizes using parameter 1 ("+" or "c" can also be specified with parm 2 or 3) C: categorizes using parameter 2 (only when it exists; "C" can also be specified with parm 3); c and C enables modification of the parameter	empty	optional
`link`	link option	can change the intended usage of the template to create a link: `link=no`, `link=n`, `link=-` or just `link=`: returns parameter 2 or 1 as plain text instead of the link may be useful when the thought page does not (yet) exist `link=none`: no transclusion - does nothing (but categorization is possible) any other value: is displayed as-it-is; may be a link ({{...}}, [[...]]) or not.	empty	optional

Template data

Parameter text is empty

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Wikipedia's help about TemplateData • Commons-specific information

This template is used to help create interwiki links without displaying the prefix, and without the need for [[User talk:Perhelion/simpleSVGcheck.js#Link templates|repetition]] if the same page name is to display; understroke characters in the page name are ''replaced'' by space characters.

The default template name is simply <code>[[:Template:W|W]]</code> which creates a link to the [[:w:|English Wikipedia]].

However any [[:w:List of ISO 639-1 codes|language code]] (>400 [[:Category:Language templates|templates]]) instead of <code>en</code> can be specified in the third parameter.

It is also possible to categorize using the (first or second) parameter.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Page Name	`1`	Also specific [sub]pages or ''name spaces'' as user, category, talk ... Default main page of the wiki	Page name	suggested
Display Text	`2`	Default {{{1}}}	Line	optional
Interwiki Prefix	`3`	language code (ISO 639), and/or sisterproject prefix Default <code>en</code>	String	optional
category request	`4`	+ or c: categorizes using parameter 1 ("+" or "c" can also be specified with parm 2 or 3)<br>C: categorizes using parameter 2 (only when it exists; "C" can also be specified with parm 3); c and C enables [[#Mod\|modification]] of the parameter	Unknown	optional
link option	`link`	can change the intended usage of the template to create a link: <code>link=no</code>, <code>link=n</code>, <code>link=-</code> or just <code>link=</code>: returns parameter 2 or 1 as plain text instead of the link may be useful when the thought page does not (yet) exist <code>link=none</code>: no transclusion - does nothing (but categorization is possible) any other value: is displayed as-it-is; may be a link ({{...}}, [[...]]) or not. Auto value `no`	String	optional

Additional information

The template is intended to be used in the following namespaces: all namespaces

The template is intended to be used by the following user groups: all users

Localization

This template is not intended to be localized.

Recommendation

For linking to a sister project, an internal link such as {{W||en.wikipedia}}) is preferred over an external one as e.g. [http://en.wikipedia.org en.wikipedia].

Category option

Very often one (or more) of the names linked with a W-template are also used for categorizing. As a simplification, the W-template can care for both: the page name or the display text of the Template:W can be also used for this categorizing, by just adding the parameter "+", "c" or "C".

Modification of the "cat" parameter:

When it is not the correct category name, it can be modified:

with "+=" a number of characters can be specified to strip on the left of the parameter,

with "-=" to strip from the end of the parameter.

To perform the "+" and/or "-" stripping a module is invoked. When no (+/-)-stripping is needed, use '+' instead of 'c' for less effort.

With "h=" or "t=" text can be specified to prefix and/or trail the parameter.

Example: {{W|Toronto|+}} categorizes to Toronto;
{{W|Toronto|+|t=_in_art}} categorizes to Toronto in art

Examples

All parameter combinations

Numbers at line beginning indicate parameter use (0=parameter without value)

000 {{W}} → Wikipedia ^[1]

003 {{W|3=es}} → Wikipedia ^[1]

{{We}}: {{ We }} → es:Wp

003 {{W|3=pt}} → Wikipedia ^[1]

020 {{W||Main Page}} → Main Page

020 {{W||en:Main Page}} → en:Main Page

023 {{W||Ĉefpaĝo|eo}} → Ĉefpaĝo

023 {{W||pt:Wikipedia|pt}} → pt:Wikipedia

{{Wp}}: {{ Wp }} → pt:Wp

023 {{W||pt:Wp|pt}} → pt:Wp (preferred style of a link to a national mainpage)

023 {{W||de:Wp|de}} → de:Wp

{{Wd}}: {{ Wd }} → de:Wp

100 {{W|Page name}} → Page name

100 {{Wf|Paris|c}} → Paris + [[Category:Paris]]

103 {{W|Page name||it}} → Page name

{{Wi}}: {{ Wi }} → it:Wp

103 {{W|Page name||fr}} → Page name

{{Wf}}: {{ Wf }} → fr:Wp

103 {{W|{{FULLPAGENAME}}|3=pl}} → Template:W/doc

120 {{W|Page name|Display name}} → Display name

123 {{W|Page name|Display name|nl}} → Display name

{{Wn}}: {{ Wn }} → nl:Wp

123 {{W|Page name|Display name|hu}} → Display name

{{Wh}}: {{ Wh }} → hu:Wp

↑ ^1.0 ^1.1 ^1.2 It is recommended to use parameter #2 giving an explaining text, as shown in the “023” Main Page examples.

Complex page name examples

3=de	de:Wikipedia	Benutzer Diskussion:Andreas_06/Spielwiese/Stadien_der_Fußball-Bundesliga
3=fr	fr:Wikipédia	Discussion aide:Catégorie/Archive3#Appels à volontaires pour Aide à la conception de l'arborescence
3=yi	yi:Wikipedia	ענדערן הילף:אינהאלט
3=pt	pt:Wikipedia	Categoria:Cidades fantasmas da Califórnia • Predefinição Discussão:!Info pessoal
3=	en:Wikipedia	Template talk:Welcome/fr#Pas assez informatif

3=nl:b	nl:Wikibooks	Scalable Vector Graphics/Stijl
3=en:d	en:Wikidata	Project chat
3=en:n	en:Wikinews	Egyptian MP calls for web porn ban
3=fi:q	fi:Wikiquote	Elizabeth II
3=es:s	es:Wikisource	Archivo:Las Maravillas Del Cielo pg 7.jpg
3=sv:v	sv:Wikiversity	Surdegsbakning för hemmabagaren
3=pl:voy	pl:Wikivoyage	San Francisco
3=lt:wikt	lt:Wiktionary	Sąrašas:Kinų hieroglifų raktai

3=d	00 Wikidata	Property:P4896
3=m	00 Metawiki	VisualEditor/Newsletter/2014/November/ka
3=m:de	ide:Metawiki	Sulzbach an der Murr
3=mw	00 Mediawiki	Extension:ParserFunctions/it
3=species	0Wikispecies	Verrucaria halizoa
3=en:commons	en:Commons	Template:W

[r-1] 1.0 ^1.1 ^1.2 It is recommended to use parameter #2 giving an explaining text, as shown in the “023” Main Page examples.

[1]