Template:Mlx/doc

From MicroWiki, the free micronational encyclopædia
Jump to navigation Jump to search

Template:Lt 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{{=}}10}} {{#invoke:Example|count_fruits|bananas=

5|apples= 10}}

Usage with a function name and parameters, using {{=}}.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and 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.
  • {{tlx}} - A version of this template for templates instead of modules.

General-purpose formatting

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓ Template:Template link expanded options[note 1]
to achieve text style
Link style
Linked Unlinked Linked with subst Unlinked with subst Linked including braces Linked with alternative text
Template:Template link expanded options[note 1]
to achieve link style
N/A DEFAULT nolink= yes subst= yes nolink=yes|subst=yes braceinside= yes alttext= Foo
2= Foo
normal DEFAULT {{tlg}}[note 1]
{{tl}}
{{tlp|1|2|...}}[note 2]
Template:Tlu[note 3]
{{tlf}}[note 2]
<template link>
Template:Tls
Template:Tlsu[note 3]
{{tlsf}}[note 2]
<template link>
Template:Tn {{tla}}
code code= yes Template:Tl2
Template:Template link expanded
Template:Tlxu[note 3]
{{tlc}}[note 2]
<template link>
{{tnull}}<template link>
Template:Tlxs Template:Tlsc[note 2]
<template link>
N/A
monospace plaincode= yes[note 4] N/A Template:Tltss[note 5] N/A
kbd kbd= yes[note 5]
bold bold= yes Template:Tlb N/A
bold+code bold=yes|code=yes Template:Tlxb
italic+code italic=yes|code=yes Template:Tlxi
  1. 1.0 1.1 1.2 {{tlg}} is the most general template, allowing any combination of text style and/or link style options.
  2. 2.0 2.1 2.2 2.3 2.4 Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
  3. 3.0 3.1 3.2 Allows links to templates in any namespace.
  4. {{tlg|plaincode= yes}} uses <code style="border:none; background-color:transparent;">...</code>.
  5. 5.0 5.1 Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes
{{tl2|Hatnote|lang=fr}} Template:Tl2 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:Elc
Template:Elc
Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}} Template:Ml Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}} {{#invoke:Example|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>
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}}
Template:Pf
Template:Pf
Parser function equivalent to {{tl}}
{{magic word|uc:}} {{uc:}} Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)
Code example Effect
{{lt|Hatnote}} Template:Lt
{{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}} Template:Ti
{{tic|Hatnote}} Template:Tic
{{tim|Hatnote}} Template:Tim
{{tiw|Hatnote}} Template:Tiw
{{tlt|Hatnote}} Template:Tlt
{{ttl|Hatnote}} Template:Ttl
{{twlh|Hatnote}} Template:Twlh