Template:Mlx/doc

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

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.

· <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>

General-purpose formatting

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

Text style ↓	{{Template:Mlx/doc}} options to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
{{Template:Mlx/doc}} options to achieve link style	—	DEFAULT	nolink= <strong class="error">Error: The retired template [[Template:Mlx/doc|&#123;&#123;Template:Mlx/doc&#125;&#125;]] has been transcluded; see [[mw:Help:Magic words#Other]] for details. To fix this, use only the code {{[[MW:Help:Magic words&#35;=|=]]}} to generate the &#61; character.</strong> [[Category:Pages which use a template in place of a magic word|T]]yes	subst= <strong class="error">Error: The retired template [[Template:Mlx/doc|&#123;&#123;Template:Mlx/doc&#125;&#125;]] has been transcluded; see [[mw:Help:Magic words#Other]] for details. To fix this, use only the code {{[[MW:Help:Magic words&#35;=|=]]}} to generate the &#61; character.</strong> [[Category:Pages which use a template in place of a magic word|T]]yes	nolink=yes|subst=yes	braceinside= <strong class="error">Error: The retired template [[Template:Mlx/doc|&#123;&#123;Template:Mlx/doc&#125;&#125;]] has been transcluded; see [[mw:Help:Magic words#Other]] for details. To fix this, use only the code {{[[MW:Help:Magic words&#35;=|=]]}} to generate the &#61; character.</strong> [[Category:Pages which use a template in place of a magic word|T]]yes	alttext= <strong class="error">Error: The retired template [[Template:Mlx/doc|&#123;&#123;Template:Mlx/doc&#125;&#125;]] has been transcluded; see [[mw:Help:Magic words#Other]] for details. To fix this, use only the code {{[[MW:Help:Magic words&#35;=|=]]}} to generate the &#61; character.</strong> [[Category:Pages which use a template in place of a magic word|T]]Foo 2= <strong class="error">Error: The retired template [[Template:Mlx/doc|&#123;&#123;Template:Mlx/doc&#125;&#125;]] has been transcluded; see [[mw:Help:Magic words#Other]] for details. To fix this, use only the code {{[[MW:Help:Magic words&#35;=|=]]}} to generate the &#61; character.</strong> [[Category:Pages which use a template in place of a magic word|T]]Foo
normal	DEFAULT	{{tlg}} {{tl}} {{tlp|1|2|...}} {{Template:tlu}}	{{tlf}} <template link>	{{subst :tls}} {{subst :Template:tlsu}}	{{tlsf}} <template link>	{{Template:Mlx/doc}}	{{tla}}
code	code= <strong class="error">Error: The retired template [[Template:Mlx/doc|&#123;&#123;Template:Mlx/doc&#125;&#125;]] has been transcluded; see [[mw:Help:Magic words#Other]] for details. To fix this, use only the code {{[[MW:Help:Magic words&#35;=|=]]}} to generate the &#61; character.</strong> [[Category:Pages which use a template in place of a magic word|T]]yes	{{tl2}} {{Template:Mlx/doc}} {{Template:tlxu}}	{{tlc}} <template link> {{tnull}}<template link>	{{subst :tlxs}}	{{subst:tlsc}} <template link>	—
monospace	plaincode= <strong class="error">Error: The retired template [[Template:Mlx/doc|&#123;&#123;Template:Mlx/doc&#125;&#125;]] has been transcluded; see [[mw:Help:Magic words#Other]] for details. To fix this, use only the code {{[[MW:Help:Magic words&#35;=|=]]}} to generate the &#61; character.</strong> [[Category:Pages which use a template in place of a magic word|T]]yes	—		{{subst:tltss}}	—
kbd	kbd= <strong class="error">Error: The retired template [[Template:Mlx/doc|&#123;&#123;Template:Mlx/doc&#125;&#125;]] has been transcluded; see [[mw:Help:Magic words#Other]] for details. To fix this, use only the code {{[[MW:Help:Magic words&#35;=|=]]}} to generate the &#61; character.</strong> [[Category:Pages which use a template in place of a magic word|T]]yes
bold	bold= <strong class="error">Error: The retired template [[Template:Mlx/doc|&#123;&#123;Template:Mlx/doc&#125;&#125;]] has been transcluded; see [[mw:Help:Magic words#Other]] for details. To fix this, use only the code {{[[MW:Help:Magic words&#35;=|=]]}} to generate the &#61; character.</strong> [[Category:Pages which use a template in place of a magic word|T]]yes	{{Template:Mlx/doc}}	—
bold+code	bold=yes|code=yes	{{Template:Mlx/doc}}
italic+code	italic=yes|code=yes	{{Template:Mlx/doc}}

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)
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}	{{hatnote|lang=fr|Some text}} Some text	Shows code and example
{{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}}	{{#invoke:Example|hello}}	Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}}	{{#invoke:Example|hello}}	Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|Module:Example|hello}}	require('Module:Example')	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}}	[[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}}
{{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}}	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 (talk · history · transclusions · logs · subpages · delete)
{{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)