Template:Magic word/doc
File:Farm-Fresh css add.svg | This template uses TemplateStyles: |
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Magic word/doc
<templatedata>{"paramOrder":["1","2","ext","code","mono","nowrap"],"description":"Creates a formatted link to the documentation of a magic word.","params":{"ext":{"description":"The name of the extension that adds the parser function (without the “Extension:” namespace prefix)","type":"string","required":false,"label":"Extension"},"mono":{"type":"boolean","default":"0","label":"Monospaced?","description":"Whether to use `style=\"font-family:monospace\"`.","autovalue":"1","required":false},"nowrap":{"type":"boolean","default":"0","label":"Nowrap?","description":"Whether to use `style=\"white-space:nowrap\"`.","autovalue":"1","required":false},"code":{"type":"boolean","default":"0","label":"Code?","description":"Whether to use styling.","autovalue":"1","required":false},"1":{"description":"The name of the magic word or parser function.","type":"string","required":true,"label":"Magic Word"},"2":{"description":"The parameter passed immediately after the colon.","type":"content","required":false,"label":"Parameter 0"}}}</templatedata>Edit parameter translations
Examples
- {{Magic word|nowrap=1|ext=Translate|#translation}} →
{{#translation:}}
- {{Magic word|mono=1|nowrap=1|ext=Scribunto|#invoke|Example}} →
{{#invoke:Example}}
- {{Magic word|code=1|#language|{{Magic word|PAGELANGUAGE}}}} →
{{#language:{{PAGELANGUAGE}}}}
See also
Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓
{{tlg}} options[note 1]
to achieve text style
Link style
Linked
Unlinked
Linked with subst
{{tlg}} options[note 1]
to achieve link style
N/A
DEFAULT
nolink=1
subst=1
normal
DEFAULT
- {{tlf}}
[note 2]
<template link>
- {{subst :tls}}
- {{subst :Template:tlsu}}
[note 3]
code
code=1
{{tl2}}
{{tlc}}
[note 2]
<template link>{{tnull}}
<template link>
monospace
mono=1
[note 4]
N/A
plaincode
plaincode=1
[note 5]
kbd
kbd=1
[note 6]
- ↑ 1.0 1.1 1.2
{{tlg}}
is the most general template, allowing any combination of text style and/or link style options.
- ↑ 2.0 2.1 2.2 Prevents wrapping of text by placing it inside
<span style="white-space:nowrap">...</span>
tags.
- ↑ Allows links to templates in any namespace.
- ↑ 4.0 4.1 4.2 Displays monospaced font using
<span style="font-family:monospace">...</span>
.
- ↑
{{Template:Magic word/doc}}
uses <code style="background:transparent;border:none">...</code>
.
- ↑
{{Template:Magic word/doc}}
uses <kbd>
tags.