Template:Mlx

From TechInfoDepot
Jump to navigationJump to search
Documentation icon Template documentation[view] [edit] [history] [purge]

Template:Lt (often abbreviated {{mlx}}) 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
{{mlx|Example}} {{#invoke:Example|function}} Usage without function name. This does not produce a usable invocation.
{{mlx|Example|hello}} {{#invoke:Example|hello}} Usage with a function name.
{{mlx|Example|count_fruits|4=bananas=5|5=apples=10}} {{#invoke:Example|count_fruits|bananas=5|apples=10}} Usage with a function name and parameters.
{{mlx|Example|count_fruits|bananas{{=}}5|apples{{=}}510}} {{#invoke:Example|count_fruits|bananas=5|apples=10}} Usage with a function name and parameters, using {{=}}.

TemplateData

This is the TemplateData for this template, which is used by TemplateWizard, the VisualEditor and still other tools.

TemplateData for Mlx

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

  • {{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

General-purpose formatting

Comparison of template-linking templates according to their style
Link style → Linked Unlinked Linked with subst Linked including braces Linked with alternative text
Text style ↓ {{tlg}} options1 DEFAULT nolink=yes subst=yes braceinside=yes alttext=Foo
2=Foo
normal DEFAULT {{tlg}}1
{{tl}}
{{tlp}}2
{{tlu}}3
{{tln}}
{{tlf}}2 {{tls}}
{{tlsp}}
{{tn}} {{tla}}
code code=yes {{tl2}}
{{tlx}}
{{tlxu}}3
{{tlc}}2
{{tld}}2
{{tnull}}
{{tlxs}} N/A
monospace
kbd
plaincode=yes4
kbd=yes5
{{tltt}}5
{{tltt2}}5
N/A {{tltts}}5
{{tltts3}}5
{{tltss}}6
bold bold=yes {{tlb}} N/A
bold+code bold=yes|code=yes {{tlxb}}
italic+code italic=yes|code=yes {{tlxi}}

Other formatting templates

Code example Effect Notes
{{tl2|Hatnote|lang=fr}} {{hatnote}} Supports linking to sister projects (e.g., fr:Hatnote)
{{tlu|User:Ahunt/SSHFS}} Template:Tlu Supports linking to any namespace
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}}
{{hatnote|lang=fr|Some text}}
Some text
Shows code and example
{{xpd|Hatnote|Some hatnote text}} Template:Xpd Shows code, example and a link to expand the template code
{{elc|Template:Hatnote}}
{{elc|Template:Hatnote|Hatnote}}
Template:Elc
Template:Elc
Formats wikilink, with optional piped link text and blended suffix
{{mlx|Bananas|hello}} {{#invoke:Bananas|hello}} Counterpart to {{tlx}} for linking to Lua modules
{{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>
<templatedata>
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}} Template:Dtl Wikidata counterpart to {{tl}}

With utility links

Code example Effect
{{lt|Hatnote}} Template:Lt
{{lts|Hatnote}} Template:Hatnote (edit talk links history)
{{t links|Hatnote}} Template:T links
{{tfd links|Hatnote}} Template:Tfd links
{{tiw|Hatnote}} Template:hatnote (backlinks edit)
{{tltt|Hatnote}} Template:Tltt
{{tetl|Hatnote}} {{Hatnote}}
links talk edit
{{tsetl|Hatnote}} {{subst:Hatnote}}
 links talk edit
{{ti|Hatnote}} {{Hatnote}}
{{tic|Hatnote}} Template:Tic
{{tiw|Hatnote}} Template:Hatnote (backlinks edit)
{{tlt|Hatnote}} Template:Tlt
{{ttl|Hatnote}} Template:Ttl
{{twlh|Hatnote}} Template:Twlh