Template:Module link: Difference between revisions
(Created page with "{{{{{{{|safesubst:}}}#invoke:Separated entries|main|[[Module:{{{1}}}{{{section|}}}|#invoke:{{{1}}}]]|{{{2|''function''}}}|separator=|}}}}<noinclude> {{Documentation}} <!-- Add categories to the /doc subpage, not here! --> </noinclude>") |
m (Protected "Template:Module link" ([Edit=Require template editor access] (indefinite) [Move=Require template editor access] (indefinite))) |
(No difference)
|
Latest revision as of 06:51, 16 June 2023
{{[[Module:{{{1}}}|#invoke:{{{1}}}]]|function}}
This template uses Lua: |
{{ml}} 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 |
See also
- {{mlc}} - Similar function but surrounded in
<code>...</code>
tags.
TemplateData
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.
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 | String | required |
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 |