Template:Module link expanded/doc
This is a documentation subpage for Template:Module link expanded. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
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.
(often abbreviated {{mlx}}) is used to display a module name as a link surrounded by braces with the {{#invoke}}Examples
editCode | Result | Notes |
---|---|---|
{{mlx |
{{#invoke:Example|function}}
|
Usage without function name. This does not produce a usable invocation. |
{{mlx |
{{#invoke:Example|hello}}
|
Usage with a function name. |
{{mlx |
{{#invoke:Example|count_fruits|bananas=5|apples=10}}
|
Usage with a function name and parameters. |
{{mlx |
{{#invoke:Example|count_fruits|bananas=5|apples=10}}
|
Usage with a function name and parameters, using {{=}}. |
TemplateData
editTemplateData for Module link expanded
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
edit- {{ml}} – similar function but not surrounded in
<code>...</code>
tags - {{mfl}} – similar to {{ml}} but creates a link to the function's documentation
- {{tlx}} – a version of this template for templates instead of modules
Other formatting templates
editCode example | Effect | Notes |
---|---|---|
{{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}} | Supports colors, placeholder texts, named and unnamed parameters | |
<syntaxhighlight lang="wikitext">
{{Hatnote
| Some text
| selfref = yes
| category = no
| lang = fr
}}
</syntaxhighlight>
|
{{Hatnote
| Some text
| selfref = yes
| category = no
| lang = fr
}}
|
Same as above |
{{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}} | {{Hatnote |
Supports colors, placeholder texts, named and unnamed parameters |
|
{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}
|
Same as above |
{{tl2|Hatnote|lang=fr}} | {{hatnote}} | Supports linking to sister projects (e.g., fr:Hatnote) |
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} | {{hatnote|lang=fr|Some text}}
|
Shows code and example |
{{tln|Hatnote}} | Template:Tln | Produces a normal link to the template |
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}} |
[[Template:Hatnote]] [[Template:Hatnote|Hatnote]] |
Formats wikilink, with optional piped link text and blended suffix |
{{ml|Example|hello}} |
Example#hello || Counterpart to {{tl}} for linking to Lua modules | |
{{mfl|Example|hello}} | Template:Mfl | Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section |
{{mlx|Example|hello}} | {{#invoke:Example|hello}} |
Counterpart to {{tlx}} for linking to Lua modules |
{{ml-lua|Module:Example}} | Template:Ml-lua | Link to Lua modules and built-in libraries, showing Lua code. |
{{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 WV: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}} |
Template:Pf Template:Pf |
Parser function equivalent to {{tl}} |
{{magic word|uc:}} | Template:Magic word | Magic word links |