Template:Mli/doc

This is a documentation subpage for Template:Mli.
It contains usage information, categories and other content that is not part of the original template page.

The Module Link Invocation template is a simple macro template 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. A short example of its use is:

{{mli|Example|main}}

which generates

TemplateData[edit source]

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Mli

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
Parameter		Description	Type	Status
module name	`1`	the module name without the namespace prefix “Module:”, which is added automatically	Line	required
function name	`2`	the function name within the module to call	Line	required

More complex variations are described below.

Examples[edit source]

Code	Result	Notes
`{{mli\|Bananas}}`	{{#invoke:Bananas}}	Usage without function name. This does not produce a usable invocation.
`{{mli\|Bananas\|hello}}`	{{#invoke:Bananas\|hello}}	Usage with a function name
`{{mlix\|BananasArgs\|custom_fruit_2\|Fred\|4=pineapples=10\|5=kiwis=5}}`	`{{#invoke:BananasArgs \|custom_fruit_2\|Fred\|pineapples=10\|kiwis=5}}`	Usage with a function name and parameters

External links[edit source]

Template:Mli/doc at Wikipedia, the free Terran encyclopedia that anyone can edit.

Link templates[edit source]


Page Type	Normal Link	Longer Link	Usage Link
Template	Template:ltb	Template:lt	General:{{tlg}} Normal: {{tl}} Code:`{{tlx}}`
File	Template:lfb	Template:lf	Template:fl
User	Template:lub	Template:lu	Template:ul
Category	Template:lcb	Template:lc	Template:cl
Module	Template:lmb	Template:lm	Template:ml
Wikipedia	Template:lwb	Template:lw
Portal	Template:lpb	Template:lp
Book	Template:lb2	Template:lb
Article	Template:lab	Template:la

General-purpose formatting[edit source]

Other formatting templates[edit source]

Code example	Effect	Notes
`{{tl2\|Hatnote\|lang=fr}}`	`{{hatnote}}`	Supports linking to sister projects (e.g., fr:Hatnote)
`{{tlu\|User:Ahunt/SSHFS}}`	{{User:Ahunt/SSHFS}}	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}}`	`"{{hatnote\|Some hatnote text}}"` gives " Some hatnote text " [1]	Shows code, example and a link to expand the template code
`{{elc\|Template:Hatnote}}` `{{elc\|Template:Hatnote\|Hatnote}}`	`[[Template:Hatnote]]` `[[Template:Hatnote\|Hatnote]]`	Formats wikilink, with optional piped link text and blended suffix
`{{mli\|Bananas\|hello}}` `{{mlix\|BananasArgs\|hello\|Fred}}`	{{#invoke:Bananas\|hello}} `{{#invoke:BananasArgs\|hello\|Fred}}`	Counterparts to {{tl}} and {{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}}`	`[[WP:LASTING]]`	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a [[WP:CODE\|TAG]] tag.
`{{tag\|ref}}` `{{xtag\|templatedata}}`	TAG `<templatedata>`	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing

With utility links[edit source]

Code example	Effect
`{{lts\|Hatnote}}`	Template:Hatnote `(`Edit Discussion links Page history`)`
`{{t links\|Hatnote}}`	Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test) · Module:hatnote
`{{tfd links\|Hatnote}}`	Template:Hatnote (edit · talk · history · links · logs · subpages · delete)
`{{tiw\|Hatnote}}`	Template:hatnote (backlinks edit)
`{{tltt\|Hatnote}}`	`{{Hatnote}}`
`{{tetl\|Hatnote}}`	{{Hatnote}} links talk view
`{{tsetl\|Hatnote}}`	{{subst:Hatnote}} links talk view
`{{ti\|Hatnote}}`	Template:Hatnote (talk · links · edit)
`{{tic\|Hatnote}}`	Template:Hatnote (talk links edit)
`{{tiw\|Hatnote}}`	Template:Hatnote (backlinks edit)
`{{tlt\|Hatnote}}`	{{Hatnote}} (talk)
`{{ttl\|Hatnote}}`	{{Hatnote}} (t/l)
`{{twlh\|Hatnote}}`	Template:Hatnote (links, talk)

	Link style →	Linked	Unlinked	Linked with subst	Linked including braces	Linked with alternative text
Text style ↓	↓ `{{tlg}}` options¹ →	N/A	`nolink=yes`	`subst=yes`	`braceinside=yes`	`alttext=Foo` `2=Foo`
normal	DEFAULT	`{{tlg}}`¹ `{{tl}}` `{{tlp}}`² `{{tlu}}`³	`{{tlf}}`²	`{{tls}}` `{{tlsp}}`	`{{tn}}`	`{{tla}}`
`code`	`code=yes`	`{{tl2}}` `{{tlx}}` `{{tlxu}}`³	`{{tlc}}`² `{{tld}}`² `{{tnull}}`	`{{tlxs}}`	N/A
monospace `kbd`	`plaincode=yes`⁴ `kbd=yes`⁵	`{{tltt}}`⁵ `{{tltt2}}`⁵	N/A	`{{tltts}}`⁵ `{{tltts3}}`⁵ `{{tltss}}`⁶	N/A
bold	`bold=yes`	`{{tlb}}`	N/A
`bold+code`	`bold=yes\|code=yes`	`{{tlxb}}`
`italic+code`	`italic=yes\|code=yes`	`{{tlxi}}`
¹ `{{tlg}}` is the most general, allowing any combination of text style and/or link style options. ² Prevents wrapping of text by placing it inside TAG tags. ³ Allows links to templates in any namespace. ⁴ `{{tlg\|plaincode=yes}}` uses [[HTML element#code\|TAG]]. ⁵ Displays monospaced font using [[HTML element#kbd\|TAG]] tags (changed from [[HTML element#tt\|TAG]] for HTML 5 compliance). ⁶ Displays monospaced font using TAG.

Template:Mli/doc

Contents