FilipeFonseca: 1 revision imported

2021-07-08T08:34:34Z

1 revision imported

New page

{{Documentation subpage}}
{{lua|Module:Separated entries}}

{{lt|ml}} is used to display a module name as a link surrounded by braces with the {{((}}#invoke{{))}} [[WP:PF|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 ==

{| class="wikitable"
! Code
! Result
! Notes
|-
| <code><nowiki>{{ml|Example}}</nowiki></code>
| {{ml|Example}}
| Usage without function name. This does not produce a usable invocation.
|-
| <code><nowiki>{{ml|Example|hello}}</nowiki></code>
| {{ml|Example|hello}}
| Usage with a function name.
|-
| <code><nowiki>{{ml|Example|count_fruit|4=bananas=10|5=kiwis=5}}</nowiki></code>
| {{ml|Example|count_fruit|4=bananas=10|5=kiwis=5}}
| Usage with a function name and parameters.
|-
| <code><nowiki>{{ml|Example|count_fruit|Fred|bananas{{=}}10|apples{{=}}5}}</nowiki></code>
| {{ml|Example|count_fruit|Fred|bananas{{=}}10|apples{{=}}5}}
| Usage with a function name and parameters, using {{((}}={{))}}.
|-
| <code><nowiki>{{ml|Example|}}</nowiki></code>
| {{ml|Example|}}
| Omits the function name
|}

== TemplateData ==
{{TemplateData header}}
<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 ==
* {{tl|mlx}} - Similar function but surrounded in {{tag|code}} tags.
* {{tl|tl}} - A version of this template for templates instead of modules.

{{Template:Template-linking templates}}

<includeonly>{{Sandbox other||
[[Category:Internal module-link templates]]

}}</includeonly>

Template:Ml/doc - Revision history

FilipeFonseca: 1 revision imported