Template:Module link

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

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}}	Template:Ml	Usage without function name. This does not produce a usable invocation.
{{ml}}	Template:Ml	Usage with a function name.
{{ml}}	Template:Ml	Usage with a function name and parameters.
{{ml}}	Template:Ml	Usage with a function name and parameters, using {{=}}.
{{ml}}	Template:Ml	Omits the function name

TemplateData

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

TemplateData for Module link

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

• {{mfl}} - Similar function but creates a link to the function paragraph in the documentation.
• {{mlx}} - Similar function but surrounded in <code>...</code> tags.
• {{tl}} - A version of this template for templates instead of modules.

General-purpose formatting

• ¹ {{tlg}} is the most general, allowing any combination of text style and/or link style options.
• ² Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
• ³ Uses monospace font but not <code>...</code>.
• ⁴ Allows links to templates in any namespace.

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}}	REDIRECT Template:Template link universal || Supports linking to any namespace
{{xpd|Hatnote|Some hatnote text}}	Template:Xpd	Shows code, example and a link to expand the template code

With utility links

Code example	Effect
{{lts|Hatnote}}	Template:Hatnote (edit talk links history)
{{t links|Hatnote}}	Template:T links
{{tfd links|Hatnote}}	Template:Tfd links
{{tiw|Hatnote}}	Template:hatnote (backlinks edit)
{{tltt|Hatnote}}	Template:Tltt
{{tetl|Hatnote}}	{{ Hatnote }} links talk view
{{tsetl|Hatnote}}	Template:Tsetl
{{ti|Hatnote}}	Template:Ti
{{tic|Hatnote}}	Template:Tic
{{tiw|Hatnote}}	Template:Hatnote (backlinks edit)
{{tlt|Hatnote}}	Template:Tlt
{{ttl|Hatnote}}	Template:Ttl
{{twlh|Hatnote}}	Template:Twlh

The above documentation is transcluded from Template:Module link/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.