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

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

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.

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	Linked including braces	Linked with alternative text
options to achieve link style	N/A	DEFAULT	nolink=yes	subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tl}} {{Template:tlu}}	<template link>	{{subst:Template:tlsu}}
code	code=yes	{{tl2}} {{Template:tlxu}}3	<template link> <template link>		N/A
monospace	plaincode=yes	N/A		{{subst:tltss}}
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
	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
	{{User:Ahunt/SSHFS}}	Supports linking to any namespace
		Shows code and example
	"{{hatnote|Some hatnote text}}" gives "" [1]	Shows code, example and a link to expand the template code
	Template:Hatnote	Produces a normal link to the template
	[[Template:Hatnote]] [[Template:Hatnote|Hatnote]]	Formats wikilink, with optional piped link text and blended suffix
	{{#invoke:}}	Counterpart to {{tl}} for linking to Lua modules
	{{#invoke:}}	Counterpart to {{tlx}} for linking to Lua modules
	|title=book title	Formats template parameters for display, with or without values
	[[[[LASTING]]]]	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
	<ref>...</ref> <templatedata>	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
	{{d:Ping project}}	Wikidata counterpart to {{tl}}
	{{#if}} {{#if:{{{1}}}|true|false}}	Parser function equivalent to {{tl}}

With utility links

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

Code example	Effect
	Template:Hatnote (edit | talk | history | links | watch | logs)
	Template:Hatnote(edit talk links history)
	Template:T links/sandbox links
	{{Hatnote}} links talk edit
	{{subst:Hatnote}}  links talk edit
	Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit)
	Template:Hatnote (talk links edit)
	m:Template:Hatnote (backlinks edit)
	Template:Hatnote (backlinks edit)
	{{Hatnote}} (talk)
	{{Hatnote}} (t/l)
	Template:Hatnote (links, talk)