Template:Module link/doc
 | This is a documentation subpage for Template:Module link. It contains usage information, categories, and other content that is not part of the original template page. |
 | This template uses Lua: |
< 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 |
|---|---|---|
| {{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 |
TemplateData
[edit]Module link
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]- {{tl}} - A version of this template for templates instead of modules.
General-purpose formatting
[edit]| Link style → | Linked | Unlinked | Linked with subst | Linked including braces | Linked with alternative text | |
|---|---|---|---|---|---|---|
| Text style ↓ | ↓ {{tlg}} options1 → | N/A | nolink=yes
|
subst=yes
|
braceinside=yes
|
alttext=Foo2=Foo
|
| Normal | N/A | {{tlg}}1, 2 {{tl}} {{tlp}}2 |
{{tlf}}2 | {{tls}} {{tlsp}} |
{{tn}} | {{tla}} |
Code
|
code=yes ortt=yes
|
{{tlx}} {{tl2}} |
{{tlc}}2 {{tld}}2 {{tnull}} |
{{tlxs}} | N/A | |
| Bold | bold=yes
|
{{tlb}} | N/A | |||
Bold code
|
bold=yes|code=yes
|
{{tlxb}} | ||||
Italic code
|
italic=yes|code=yes
|
|||||
- 1 {{tlg}} is the most general, allowing any combination of text style and/or link style options.
- 2 Prevents wrapping of text by placing it inside
<span class="nowrap">...</span>tags. - 3 Uses monospace font but not
<code>...</code>. - 4 Allows links to templates in any namespace.
Other formatting templates
[edit]| Code example | Effect | Notes |
|---|---|---|
| {{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 |
| {{ml|Example|hello}} | {{#invoke:Example|hello}} | Counterpart to {{tl}} for linking to Lua modules |
| {{para|title|<var>book title</var>}} | |title=book title
|
Formats template parameters for display, with or without values |
| {{tag|ref}} | <ref>...</ref>
|
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing |
| {{pf|if}} {{pf|if|{{{1}}}|true|false}} |
#if:#if:
|
Parser function equivalent to {{tl}} |