සැකිල්ල:Magic word/උපදෙස්

No description yet available.

Usage

{{Magic word}}

Template parameters

<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.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

---

Wikipedia's help about TemplateData • Commons-specific information

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

Template parameters[Edit template data]

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}}}}

⧼Seealso⧽

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	Linked with alternative text
{{tlg}} options to achieve link style	N/A	DEFAULT	XML Example nolink=yes	XML Example subst=yes	nolink=yes|subst=yes	XML Example braceinside=yes	XML Example alttext=Foo XML Example 2=Foo
normal	DEFAULT	{{tlg}} {{tl}} {{tlp|1|2|...}} {{Template:tlu}}	{{tlf}} <template link>	{{subst:tls}} සැකිල්ල:Tlsu	{{subst:tlsf}} <template link>	{{tn}}	{{tla}}
code	XML Example code=yes	{{tl2}} {{tlx}} {{Template:tlxu}}	{{tlc}} <template link> {{tnull}}<template link>	{{subst:tlxs}}	{{subst:tlsc}} <template link>	N/A
monospace	XML Example plaincode=yes	N/A		{{subst:tltss}}	N/A
kbd	XML Example kbd=yes
bold	XML Example bold=yes	සැකිල්ල:Tlb	N/A
bold+code	bold=yes|code=yes	සැකිල්ල:Tlxb
italic+code	italic=yes|code=yes	සැකිල්ල:Tlxi

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters

Code example	Effect	Notes
{{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}}	{{Hatnote | Some text | selfref = yes | category = no | lang = fr }}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext"> {{Hatnote | Some text | selfref = yes | category = no | lang = fr }} </syntaxhighlight>	{{Hatnote | Some text | selfref = yes | category = no | lang = fr }}	Same as above
{{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}}	සැකිල්ල:Tji	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight>	{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}	Same as above
{{tl2|Hatnote|lang=fr}}	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	{{hatnote|lang=fr|Some text}} Some text	Shows code and example
{{tln|Hatnote}}	සැකිල්ල:Tln	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	සැකිල්ල:Elc සැකිල්ල:Elc	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	සැකිල්ල:Ml	Counterpart to {{tl}} for linking to Lua modules
{{mfl|Example|hello}}	සැකිල්ල:Mfl	Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
{{mlx|Example|hello}}	සැකිල්ල:Mlx	Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|Module:Example}}	සැකිල්ල:Ml-lua	Link to Lua modules and built-in libraries, showing Lua code.
{{para|title|<var>book title</var>}}	|title=book title	Formats template parameters for display, with or without values
{{sclx|LASTING}}	සැකිල්ල:Sclx	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
{{tag|ref}} {{xtag|templatedata}}	<ref>...</ref> <templatedata>	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	සැකිල්ල:Dtl	Wikidata counterpart to {{tl}}
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	සැකිල්ල:Pf සැකිල්ල:Pf	Parser function equivalent to {{tl}}
{{magic word|uc:}}	{{uc:}}	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	සැකිල්ල:Lt
{{lts|Hatnote}}	සැකිල්ල:Lts
{{t links|Hatnote}}	සැකිල්ල:T links
{{tfd links|Hatnote}}	සැකිල්ල:Tfd links
{{tetl|Hatnote}}	සැකිල්ල:Tetl
{{tsetl|Hatnote}}	සැකිල්ල:Tsetl
{{ti|Hatnote}}	සැකිල්ල:Ti
{{tic|Hatnote}}	සැකිල්ල:Tic
{{tim|Hatnote}}	සැකිල්ල:Tim
{{tiw|Hatnote}}	සැකිල්ල:Tiw
{{tlt|Hatnote}}	සැකිල්ල:Tlt
{{ttl|Hatnote}}	සැකිල්ල:Ttl
{{twlh|Hatnote}}	සැකිල්ල:Twlh

Localization

This template is not intended to be localized.