Template:Ml/doc
From The Kodiak Republic Wiki
This is a documentation subpage for Template:Ml. It contains usage information, categories and other content that is not part of the original page. |
This template uses Lua: |
Template:Lt is used to display a module name as a link surrounded by braces with the Template:((#invokeTemplate:)) 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 Template:((=Template:)). |
{{ml|Example|}}
|
{{#invoke:Example}} | Omits the function name |
TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.
TemplateData for Ml
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 |
See also
- {{mlx}} - Similar function but surrounded in
<code>...</code>
tags. - {{tl}} - A version of this template for templates instead of modules.
Template:Template-linking templates