Jump to content

Template:Module link/doc

From Wikisource

< 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]
This is the TemplateData documentation for this template used by VisualEditor and other tools.

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.

Template parameters

ParameterDescriptionTypeStatus
module name1

the module name without the namespace prefix “Module:”, which is added automatically

Stringrequired
function name2

the function name within the module to call

Stringrequired
parameter 13

the name (and value) of the first parameter, use {{=}} to add an equal sign

Stringoptional
parameter 24

the name (and value) of the second parameter, use {{=}} to add an equal sign

Stringoptional
parameter 35

the name (and value) of the third parameter, use {{=}} to add an equal sign

Stringoptional

See also

[edit]
  • {{mlx}} - Similar function but surrounded in <code>...</code> tags.
  • {{tl}} - A version of this template for templates instead of modules.

General-purpose formatting

[edit]
Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ {{tlg}} optionsTemplate:NoteTag
to achieve text style
Link style
Linked Unlinked Linked with subst Unlinked with subst Linked including braces Linked with alternative text
{{tlg}} optionsTemplate:NoteTag
to achieve link style
-- -- nolink=yes subst=yes nolink=yes|subst=yes braceinside=yes alttext=Foo
2=Foo
normal -- {{tlg}}Template:NoteTag
{{tl}}
{{tlp|1|2|...}}Template:NoteTag
Template:TluTemplate:NoteTag
{{tlf}}Template:NoteTag
<template link>
{{subst:tls}}
Template:TlsuTemplate:NoteTag
Template:TlsfTemplate:NoteTag
<template link>
{{tn}} {{{{{2}}}}}
code code=yes {{tl2}}
{{tlx}}
Template:TlxuTemplate:NoteTag
{{tlc}}Template:NoteTag
<template link>
{{tnull}}<template link>
{{subst:tlxs}} Template:TlscTemplate:NoteTag
<template link>
colspan="2" rowspan="3" --
monospace plaincode=yesTemplate:NoteTag colspan="2" rowspan="2" -- Template:TltssTemplate:NoteTag rowspan="2" --
kbd kbd=yesTemplate:NoteTag
bold bold=yes {{tlb}} colspan="5" rowspan="3" --
bold+code bold=yes|code=yes {{tlxb}}
italic+code italic=yes|code=yes Template:Tlxi

Template:NoteFoot

Other formatting templates

[edit]
Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes
{{tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}} Template:Tj Supports colors, placeholder texts, named and unnamed parameters
{{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}}
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:Elc
Template:Elc
Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}} Template:Mlx Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|Module:Example|hello}} 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 WP: alias in a <code>...</code> tag.
{{tag|ref}}
{{xtag|templatedata}}
<ref>...</ref>
Template:Xtag
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}}
#if:
#if:
Parser function equivalent to {{tl}}
{{magic word|uc:}} Template:Magic word Magic word links
[edit]
Templates producing utility links for a given template (Hatnote used here as example)
Code example Effect
{{lt|Hatnote}} <
{{lts|Hatnote}} Template:Lts
{{t links|Hatnote}} Template:T links
{{tfd links|Hatnote}} Template:Tfd links
{{tetl|Hatnote}} Template:Tetl
{{tsetl|Hatnote}} Template:Tsetl
{{ti|Hatnote}}
{{tic|Hatnote}} Template:Tic
{{tim|Hatnote}} Template:Tim
{{tiw|Hatnote}} Template:Tiw
{{tlt|Hatnote}} Template:Tlt
{{ttl|Hatnote}} Template:Ttl
{{twlh|Hatnote}} Template:Twlh