Template:Magic word

{{magic word}}

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Magic word/doc.

Warning:

Do not edit. This page is maintained by an automated tool. All edits should be done at mediawiki.org. (translate this warning)

Creates a formatted link to the documentation of a magic word.

Usage

{{Magic word}}

Template parameters

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

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

Creates a formatted link to the documentation of a magic word.

Template parameters

Parameter		Description	Type	Status
Magic Word	1	The name of the magic word or parser function.	String	required
Parameter 0	2	The parameter passed immediately after the colon.	Content	optional
Extension	ext	The name of the extension that adds the parser function (without the “Extension:” namespace prefix)	String	optional
Code?	code	Whether to use <code> styling. Default 0 Auto value 1	Boolean	optional
Monospaced?	mono	Whether to use `style="font-family:monospace"`. Default 0 Auto value 1	Boolean	optional
Nowrap?	nowrap	Whether to use `style="white-space:nowrap"`. Default 0 Auto value 1	Boolean	optional

Edit parameter translations

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

Examples

{{Magic word|nowrap=1|ext=Translate|#translation}}

renders as:

{{#translation:}}

---

{{Magic word|mono=1|nowrap=1|ext=Scribunto|#invoke|Example}}

renders as:

{{#invoke:Example}}

---

{{Magic word|code=1|#language|{{Magic word|PAGELANGUAGE}}}}

renders as:

{{#language:{{PAGELANGUAGE}}}}

See also

Template links

List of templates using {{T/main}}

Code	Result	Notes	lock
{{T|example}}	{{Example}}	makes brackets part of the link
{{T0|example}}	Example	just link, without the brackets
{{T1|example}}	{{Example}}	inner brackets are part of the link
{{T2|example}}	{{Example}}	brackets are not a part of the link
{{Tl|example}}	{{Example}}	makes brackets around the link
{{Tlr|User:Example}}	{{User:Example}}	like {{tl}} but for any namespace
{{Tls|example}}	{{subst:example}}	no parameters, adds "subst:"
Templates showing parameters 0 Meta template {{Tle}} is easiest to parametrize.
{{Tle|T=F|p1=1|v1|p2=2|v2|p3=3|v3}}	{{ F | 1 = v1 | 2 = v2 | 3 = v3 }}	describes template parameters by names and values
{{Tlx|example|1|2|3|4|5||7|8|9}}	{{example|1|2|3|4|5|7|8|...}}	up to 8 parameters
{{Tlf|example|1|2|3|...up to 8}}	{{example|1|2|3|...up to 8}}	up to 8 parameters, no link
{{Tlc|example|1|2|3|4|||7|up to 8|9 is ignored.}}	{{example|1|2|3|4|||7|up to 8}}	up to 8 parameters, no link, <code> style
{{Tld|example|1|2||3||}}	{{example|1||2|3||}}	up to 8 parameters, <code> style[clarification needed]
{{Tlsu|User:Example}}	{{subst:User:Example}}	like {{Tls}}, but supporting parameters
Alternative forms 0 These ignore empty parameters.
{{Tlp|example|1|2|3|4|5||7|8|9 is ignored.}}	{{example|1|2|3|4|5|7|8}}	up to 8 parameters; ignores empty parms
{{Tl2|example|p1|p2}}	{{example|p1|p2}}	up to 2 parameters, <code> style
{{Tlsp|example|1|2|3|4|5|6|7|8|9}}	{{subst:example|1|2|3|4|5|6|7|8|...}}	up to 8 parameters, adds linked "subst:"
{{Tlsx|example|1|2|3|4|5|6 and above are ignored.|7}}	{{subst:example|1|2|3|4|5|...}}	up to 5 parameters, adds linked "subst:", <code> style

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced

Text style ↓	{{tlg}} options to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces
{{tlg}} options to achieve link style	N/A	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes
normal	DEFAULT	{{tlg}} {{T2}} {{tlx}} {{tlp|1|2|...}} {{Template:tlr}} {{Template:tlu}}	{{tlf}} <template link>	{{subst:tls}} {{subst:tlsp}} {{subst:Template:tlsu}}	N/A	{{T}}
code	code=yes	{{tl2}}	{{tlc}} <template link>	{{subst:tlsx}}	{{subst:tlsc}} <template link>	N/A
monospace	mono=yes	{{tld}}	N/A	{{subst:tltts}}	N/A	{{Tl}}
plaincode	plaincode=yes
kbd[clarification needed]	kbd=yes

Localization

This template is not intended to be localized.