Template:Mlx/doc
This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
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[edit]
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[edit]
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[edit]
- {{ml}} - Similar function but not surrounded in
<code>...</code>
tags. - {{tlx}} - A version of this template for templates instead of modules.
Template:Template-linking templates