Template:Module_function_link
{mfl} is similar to {ml}, but assumes that the function specified is documented, and thus creates a link to a section of the same name expected to be found in the documentation. Another difference with {ml} is that the behaviour of empty and undefined in the second parameter here is inverted.
Examples
| Code | Result | Notes |
|---|---|---|
| {mfl |
{#invoke:Example} | Omits the function name |
| {mfl |
{#invoke:Example|hello} | Usage with a function name. |
| {mfl |
{#invoke:Example|count_fruit|bananas=10|kiwis=5} | Usage with a function name and parameters. |
| {mfl |
{#invoke:Example|count_fruit|Fred|bananas=10|apples=5} | Usage with a function name and parameters, using {=}. |
| {mfl |
{#invoke:Example|function} | Usage with a generic function name. This does not produce a usable invocation. |
TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Module function link in articles based on its TemplateData.
TemplateData for Module function link
This template displays a module name as a link surrounded by braces with the {#invoke} parser function, itself linked, thus showing how the module name would be used in code. Its primary use is in instruction and documentation.
| 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, expected to be documented | String | optional |
| 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 without generating links
- {tl} - A version of this template for templates instead of modules.
General-purpose formatting
| Text style ↓ | {tlg} options[note 1]to achieve text style |
Link style | |||||
|---|---|---|---|---|---|---|---|
| Linked | Unlinked | Linked with subst | Unlinked with subst | Linked including braces | Linked with alternative text | ||
{tlg} options[note 1]to achieve link style |
— | DEFAULT | nolink=yes
|
subst=yes
|
nolink=yes
|
braceinside=yes
|
alttext=Foo2=Foo
|
| normal | DEFAULT | {tlg} {tl} {tlp|1|2|...} {Template:tlu} |
{tlf} <template link> |
{subst:tls} {subst:Template:tlsu} |
{subst:tlsf} <template link> |
{tn} | {tla} |
code
|
code=yes
|
{tl2}{tlx}{Template:tlxu} |
{tlc}<template link> {tnull}<template link>
|
{subst:tlxs}
|
{subst:tlsc}<template link> |
— | |
| monospace | plaincode=yes |
— | {subst:tltss} |
— | |||
| kbd | kbd=yes | ||||||
| bold | bold=yes
|
{tlb} | — | ||||
bold+code
|
bold=yes
|
{tlxb}
| |||||
italic+code
|
italic=yes
|
{tlxi}
| |||||
- ^ a b c
{tlg}is the most general template, allowing any combination of text style and/or link style options. - ^ a b c d e Prevents wrapping of text by placing it inside
<span class="nowrap">...</span>tags. - ^ a b c Allows links to templates in any namespace.
- ^
{tlg|plaincode=yes}uses<code style="border:none; background-color:transparent;">...</code>. - ^ a b Displays monospaced font using
<span style="font-family:monospace;">...</span>.
Other formatting templates
| Code example | Effect | Notes |
|---|---|---|
{Tj|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 |
{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}
|
{Hatnote |
Supports colors, placeholder texts, named and unnamed parameters |
|
{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>}
|
{hatnote|lang=fr|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 |
{mfl|Example|hello}
|
{#invoke:Example|hello} | Similar to {ml}, but expects the function to be documented and creates a link to the corresponding section |
{mlx|Example|hello}
|
{#invoke:Example|hello} |
Counterpart to {tlx} for linking to Lua modules |
{ml-lua|Module:Example}
|
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
| 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) |
{tetl|Hatnote}
|
{Hatnote} |
{tsetl|Hatnote}
|
{subst:Hatnote} |
{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}
|
Template:Hatnote (links, talk) |
{twlh|Hatnote}
|
Template:Hatnote (links, talk) |