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

模板参数

参数		描述	类型	状态
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

• {{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

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

Text style ↓	{{tlg}} options to achieve text style	Link style
		Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
{{tlg}} options to achieve link style	—	DEFAULT	nolink=yes	subst=yes	nolink=yes|subst=yes	braceinside=yes	alttext=Foo 2=Foo
normal	DEFAULT	{{tlg}} {{tl}} {{tlp|1|2|...}} {{Template:tlu}}	{{tlf}} <template link>	{{subst:tls}} {{subst:Template:tlsu}}	模板:Tlsf <template link>	{{tn}}	{{tla}}
code	code=yes	{{tl2}} {{tlx}} 模板:Tlxu	{{tlc}} <template link> {{tnull}}<template link>	{{subst:tlxs}}	模板:Tlsc <template link>	—
monospace	plaincode=yes	—		{{subst:tltss}}	—
kbd	kbd=yes
bold	bold=yes	{{tlb}}	—
bold+code	bold=yes|code=yes	{{tlxb}}
italic+code	italic=yes|code=yes	{{tlxi}}

Other formatting templates

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

Code example	Effect	Notes
{{模板:Template journal|<Hatnote>|<Some text>|<selfref: yes>|<category: no>|<lang: fr>}}	{{Hatnote | Some text | selfref = yes | category = no | lang = fr }}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext"> {{Hatnote | Some text | selfref = yes | category = no | lang = fr }} </syntaxhighlight>	{{Hatnote | Some text | selfref = yes | category = no | lang = fr }}	Same as above
{{模板:Template journal inline|<Hatnote>|<Some text>|<selfref: yes>|<category: no>|<lang: fr>}}	{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight>	{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}	Same as above
{{tl2|<Hatnote|lang=fr>}}	{{hatnote}}	Supports linking to sister projects (e.g., fr:Hatnote)
{{demo|<<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>>}}	模板:Demo	Shows code and example
{{tln|<Hatnote>}}	模板:Tln	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
{{mfl|<Example>|<hello>}}	模板:Mfl	Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
{{mlx|<Example>|<hello>}}	模板:Mlx	Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|<Module:Example>|<hello>}}	模板:Ml-lua	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>}}	模板:Sclx	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>}}	模板:Dtl	Wikidata counterpart to {{tl}}
{{pf|<if>}} {{pf|<if>|<{{{1}}}>|<true>|<false>}}	{{#if}} {{#if:{{{1}}}|true|false}}	Parser function equivalent to {{tl}}
{{magic word|<uc:>}}	模板:Magic word	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>}}	模板:Lts
{{t links|<Hatnote>}}	模板:T links
{{tfd links|<Hatnote>}}	模板:Tfd links
{{tetl|<Hatnote>}}	模板:Tetl
{{tsetl|<Hatnote>}}	模板:Tsetl
{{ti|<Hatnote>}}	模板:Ti
{{tic|<Hatnote>}}	模板:Tic
{{tim|<Hatnote>}}	模板:Tim
{{tiw|<Hatnote>}}	模板:Tiw
{{tlt|<Hatnote>}}	模板:Tlt
{{ttl|<Hatnote>}}	模板:Ttl
{{twlh|<Hatnote>}}	模板:Twlh

The above documentation is transcluded from 模板: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.