قالب:Ml

{{}}

Template documentation

This documentation is transcluded from قالب:Ml/doc. (edit | history)

Template:Ml (edit | talk | history | links | watch | logs) is used to display a module name as a link surrounded by braces with the {{#invoke}} parser function, thus showing the module name as code rather than actually invoking it. Its primary use is in instruction and documentation where it is used to refer to a module by name without invoking it. It is also supports the definition of a function and parameters.

Examples

Code	Result	Notes
{{ml|Example}}	{{}}	Usage without function name. This does not produce a usable invocation.
{{ml|Example|hello}}	{{}}	Usage with a function name.
{{ml|Example|count_fruit|4=bananas=10|5=kiwis=5}}	{{}}	Usage with a function name and parameters.
{{ml|Example|count_fruit|Fred|bananas{{=}}10|apples{{=}}5}}	{{}}	Usage with a function name and parameters, using {{=}}.
{{ml|Example|}}	{{}}	Omits the function name

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Ml

This template displays a module name as a link surrounded by braces with the {{#invoke}} parser function, thus showing how the module name would be used in code. Its primary use is in instruction and documentation.

وسائط القالب

وسيط		وصف	نوع	حالة
module name	1	the module name without the namespace prefix “Module:”, which is added automatically	نص	مطلوب
function name	2	the function name within the module to call	نص	مطلوب
parameter 1	3	the name (and value) of the first parameter, use {{=}} to add an equal sign	نص	اختياري
parameter 2	4	the name (and value) of the second parameter, use {{=}} to add an equal sign	نص	اختياري
parameter 3	5	the name (and value) of the third parameter, use {{=}} to add an equal sign	نص	اختياري

See also

• {{mlx}} - Similar function but surrounded in <code>...</code> tags.
• {{tl}} - A version of this template for templates instead of modules.

General-purpose formatting

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

Text style ↓	options to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
options to achieve link style	N/A	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tl}} {{Template:tlu}}	<template link>	{{subst:Template:tlsu}}	<template link>
code	code=yes	{{tl2}} {{Template:tlxu}}	<template link> <template link>		{{subst:tlsc}} <template link>	N/A
monospace	plaincode=yes	N/A		{{subst:tltss}}	N/A
kbd	kbd=yes
bold	bold=yes		N/A
bold+code	bold=yes|code=yes
italic+code	italic=yes|code=yes

Other formatting templates

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

Code example	Effect	Notes
{{tl2|Hatnote|lang=fr}}	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}}	{{User:Ahunt/SSHFS}}	Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}		Shows code and example
{{xpd|Hatnote|Some hatnote text}}	"{{hatnote|Some hatnote text}}" gives "" [١]	Shows code, example and a link to expand the template code
{{tln|Hatnote}}	Template:Hatnote	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	[[Template:Hatnote]] [[Template:Hatnote|Hatnote]]	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	{{}}	Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}}	{{}}	Counterpart to {{tlx}} for linking to Lua modules
{{para|title|<var>book title</var>}}	|title=book title	Formats template parameters for display, with or without values
{{sclx|LASTING}}	[[[[LASTING]]]]	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}}	{{d:Ping project}}	Wikidata counterpart to {{tl}}
{{pf|if}} {{pf|if|{{{1}}}|true...}}	{{#if}} {{#if:{{{1}}}|true|false}}	Parser function equivalent to {{tl}}
{{magic word|uc:}}	{{[[MW:Help:Magic words#|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}}	Template:Hatnote (edit | talk | history | links | watch | logs)
{{lts|Hatnote}}	Template:Hatnote(edit talk links history)
{{t links|Hatnote}}	([[:Template:/sandbox|/sbox]] [{{fullurl:Template:/sandbox|action=edit}} edit] diff [[Template:/testcases|/test]] | [[:Template:|Source]] [{{fullurl:Template:|action=edit}} e] [[Template talk:|Talk]] [{{fullurl:Template:|action=history}} hist] [{{fullurl:Special:Whatlinkshere/Template:|limit=999}} links] # [{{fullurl:Special:PrefixIndex/Template:/}} /subpages] [[Template:/doc|/doc]])
{{tfd links|Hatnote}}
{{tetl|Hatnote}}	{{Hatnote}} links talk edit
{{tsetl|Hatnote}}	{{subst:Hatnote}}  links talk edit
{{ti|Hatnote}}	Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit)
{{tic|Hatnote}}	Template:Hatnote (talk links edit)
{{tim|Hatnote}}	m:Template:Hatnote (backlinks edit)
{{tiw|Hatnote}}	Template:Hatnote (backlinks edit)
{{tlt|Hatnote}}	{{Hatnote}} (talk)
{{ttl|Hatnote}}	{{Hatnote}} (t/l)
{{twlh|Hatnote}}	Template:Hatnote (links, talk)