Template:Mlx
{{#invoke:[[Module:{{{1}}}|{{{1}}}]]|function}}
This template uses Lua: |
Template:Module link expanded (edit|talk|history|links|watch|logs) (often abbreviated {{mlx}}) 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
TemplateData for Mlx
<templatedata>{ "description": "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.", "params": {
"1": { "label": "module name", "description": "the module name without the namespace prefix “Module:”, which is added automatically", "type": "string", "required": true }, "2": { "label": "function name", "description": "the function name within the module to call", "type": "string", "required": true }, "3": { "label": "parameter 1", "description": "the name (and value) of the first parameter, use = to add an equal sign", "type": "string" }, "4": { "label": "parameter 2", "description": "the name (and value) of the second parameter, use = to add an equal sign", "type": "string" }, "5": { "label": "parameter 3", "description": "the name (and value) of the third parameter, use = to add an equal sign", "type": "string" }
}}</templatedata>
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
Link style → | Linked | Unlinked | Linked with subst | Linked including braces | Linked with alternative text | |
---|---|---|---|---|---|---|
Text style ↓ | ↓ {{tlg}} options1 →
|
DEFAULT | <syntaxhighlight lang="text" enclose="none">nolink=yes</syntaxhighlight>
|
<syntaxhighlight lang="text" enclose="none">subst=yes</syntaxhighlight>
|
<syntaxhighlight lang="text" enclose="none">braceinside=yes</syntaxhighlight>
|
<syntaxhighlight lang="text" enclose="none">alttext=Foo</syntaxhighlight> <syntaxhighlight lang="text" enclose="none">2=Foo</syntaxhighlight>
|
normal | DEFAULT | {{tlg}} 1{{tl}} {{tlp}} 2{{tlu}} 3
|
{{tlf}} 2
|
{{tls}} {{tlsp}} {{tlsu}} 3
|
{{tn}}
|
{{tla}}
|
code
|
<syntaxhighlight lang="text" enclose="none">code=yes</syntaxhighlight>
|
{{tl2}} {{tlx}} {{tlxu}} 3
|
{{tlc}} 2{{tld}} 2{{tnull}}
|
{{tlxs}}
|
N/A | |
monospace kbd |
<syntaxhighlight lang="text" enclose="none">plaincode=yes</syntaxhighlight> 4<syntaxhighlight lang="text" enclose="none">kbd=yes</syntaxhighlight> 5
|
{{tltt}} 5{{tltt2}} 5
|
N/A | {{tltss}} 6
| ||
bold | <syntaxhighlight lang="text" enclose="none">bold=yes</syntaxhighlight>
|
{{tlb}}
|
N/A | |||
bold+code
|
code=yes</syntaxhighlight> | {{tlxb}}
| ||||
italic+code
|
code=yes</syntaxhighlight> | {{tlxi}}
| ||||
|
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}} |
{{User:Ahunt/SSHFS}} | Supports linking to any namespace |
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} |
{{hatnote|lang=fr|Some text}} |
Shows code and example |
{{xpd|Hatnote|Some hatnote text}} |
"{{hatnote|Some hatnote text}}" gives " " [1] |
Shows code, example and a link to expand the template code |
{{tln|Hatnote}} |
Template:Tln | Produces a normal link to the template |
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}} |
Template:Elc Template:Elc |
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 |
{{para|title|<var>book title</var>}} |
|title=book title |
Formats template parameters for display, with or without values |
{{sclx|LASTING}} |
Template: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}} |
Template:Dtl | Wikidata counterpart to {{tl}} |
{{pf|if}} {{pf|if|{{{1}}}|true|false}} |
{{#if}} {{#if:{{{1}}}|true|false}} |
Parser function equivalent to {{tl}} |
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) |
{{tltt|Hatnote}} |
{{Hatnote}} |
{{tetl|Hatnote}} |
{{ Hatnote }} |
{{tsetl|Hatnote}} |
Template:Tsetl |
{{ti|Hatnote}} |
Template:Hatnote (talk, links, edit) |
{{tic|Hatnote}} |
Template:Tic |
{{tim|Hatnote}} |
m:Template:Hatnote (talk, backlinks, edit) |
{{tiw|Hatnote}} |
Template:Hatnote (talk, backlinks, edit) |
{{tlt|Hatnote}} |
{{Hatnote}} (talk) |
{{ttl|Hatnote}} |
Template:Ttl |
{{twlh|Hatnote}} |
Template:Hatnote (links, talk) |
The above documentation is transcluded from Template:Mlx/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |