Template:W/doc: Difference between revisions

Revision as of 07:15, 14 March 2014

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 is used to help create interwiki links, without displaying the prefix, and without the need for repetition if the link text is the same as target page name.

The default prefix is simply w: which creates a link to the English Wikipedia. However the language can be specified in the third parameter.

Usage

Template parameters

Parameter	Description	Default	Status
`1`	page name; also specific [sub]pages (e.g: user, category, talk, ...)	main page of the wiki	required
`2`	display text	parameter #1	optional
`3`	language code (ISO 639), or sisterproject prefix	en	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 is used to help create interwiki links, without displaying the prefix, and without the need for repetition if the link text is the same as target page name.

The default prefix is simply <tt>w:</tt> which creates a link to the English Wikipedia. However the language can be specified in the third parameter.

Template parameters
This template prefers inline formatting of parameters.
	Description	Type	Status
`1`	page name; also specific [sub]pages (e.g: user, category, talk, ...) Default main page of the wiki	Unknown	required
`2`	display text Default parameter #1	Unknown	optional
`3`	language code (ISO 639), or sisterproject prefix Default en	Unknown	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.

Examples

All parameter combinations

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

003 {{W|3=es}} → Wikipedia ^[1]
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

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

103 {{W|Page name||it}} → Page name
103 {{W|Page name||fr}} → Page name
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
123 {{W|Page name|Display name|hu}} → Display name

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

Complex page name examples

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

[1]

@@ Line 51: / Line 51: @@
 <nowiki>{{</nowiki>W|Page name||it}} → {{w|Page name||it}}<br>
-<nowiki>{{</nowiki>W|Page name||fr}} → {{w|Page name||fr}}
+<nowiki>{{</nowiki>W|Page name||fr}} → {{w|Page name||fr}}<br>
+<nowiki>{{W|{{FULLPAGENAME}}|3=pl}}</nowiki> → {{W|{{FULLPAGENAME}}||pl}}
 <nowiki>{{</nowiki>W|Page name|Display name}} → {{w|Page name|Display name}}

commons>Sarang