ଛାଞ୍ଚ:Mlx

{{[[Module:{{{1}}}|#invoke:{{{1}}}]]|function}}

Template documentation[view] [edit] [history] [purge]

Template:Mlx (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
{{mlx|Example}}	{{#invoke:Example|function}}	Usage without function name. This does not produce a usable invocation.
{{mlx|Example|hello}}	{{#invoke:Example|hello}}	Usage with a function name.
{{mlx|Example|count_fruits|4=bananas=5|5=apples=10}}	{{#invoke:Example|count_fruits|bananas=5|apples=10}}	Usage with a function name and parameters.
{{mlx|Example|count_fruits|bananas{{=}}5|apples{{=}}10}}	{{#invoke:Example|count_fruits|bananas=5|apples=10}}	Usage with a function name and parameters, using {{=}}.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Mlx in articles based on its TemplateData.

TemplateData for Mlx

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.

Template parameters[Edit template data]

Parameter		Description	Type	Status
module name	1	the module name without the namespace prefix “Module:”, which is added automatically	String	required
function name	2	the function name within the module to call	String	required
parameter 1	3	the name (and value) of the first parameter, use {{=}} to add an equal sign	String	optional
parameter 2	4	the name (and value) of the second parameter, use {{=}} to add an equal sign	String	optional
parameter 3	5	the name (and value) of the third parameter, use {{=}} to add an equal sign	String	optional

See also

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

General-purpose formatting

Comparison of template-linking templates according to their style

	Link style →	Linked	Unlinked	Linked with subst	Linked including braces	Linked with alternative text
Text style ↓	↓ {{tlg}} options1 →	DEFAULT	nolink=yes	subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tlg}}1 {{tl}} {{tlp}}2 {{tlu}}3	{{tlf}}2	{{tls}} {{tlsp}} {{tlsu}}3	{{tn}}	{{tla}}
code	code=yes	{{tl2}} {{tlx}} {{tlxu}}3	{{tlc}}2 {{tld}}2 {{tnull}}	{{tlxs}}	N/A
monospace kbd	plaincode=yes4 kbd=yes5	{{tltt}}5 {{tltt2}}5	N/A	{{tltss}}6
bold	bold=yes	{{tlb}}	N/A
bold+code	bold=yes|code=yes	{{tlxb}}
italic+code	italic=yes|code=yes	{{tlxi}}
1  {{tlg}} is the most general, allowing any combination of text style and/or link style options. 2  Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags. 3  Allows links to templates in any namespace. 4  {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>. 5  Displays monospaced font using <kbd>...</kbd> tags (changed from <tt>...</tt> for HTML 5 compliance). 6  Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

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>}}	{{hatnote|lang=fr|Some text}} Some text || Shows code and example
{{xpd|Hatnote|Some hatnote text}}	"{{hatnote|Some hatnote text}}" gives " Some hatnote text " [୧] || 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}}	Module:Example (talk ·  · hist · links · doc · subpages · tests (results))	Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}}	{{#invoke: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}}	[[WP: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|false}}	{{#if}} {{#if:{{{1}}}|true|false}}	Parser function equivalent to {{tl}}

With utility links

Code example	Effect
{{lt|Hatnote}}	Template:Hatnote (edit|talk|history|links|watch|logs)
{{lts|Hatnote}}	Template:Hatnote(edit talk links history)
{{t links|Hatnote}}	Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{tfd links|Hatnote}}	Template:Hatnote (edit · talk · history · links · transclusions · logs · subpages · delete)
{{tltt|Hatnote}}	{{Hatnote}}
{{tetl|Hatnote}}	{{Hatnote}} links talk edit
{{tsetl|Hatnote}}	{{subst:Hatnote}}  links talk edit
{{ti|Hatnote}}	Template:Hatnote (talk, links, 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)

The above documentation is transcluded from ଛାଞ୍ଚ:Mlx/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.