Template:Mlix

Template documentation[view] [edit] [history] [purge]

This template is used to show example module usage without invoking the module itself.

Basic use

(Note: In the following examples, ellipses (groups of three dots) indicate where parameters have been omitted.)

{{mlix|Module|function|first parameter|second parameter|third|...|tenth}} produces:

{{Module|function|first parameter|second parameter|third|...|tenth}}

Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{=}}:

{{mlix|Module|function|first{{=}}something|second|third{{=}}something|...|tenth}} produces:

{{Module|function|first=something|second|third=something|...|tenth}}

For more than ten parameters, possibly also containing equals-signs, use TAG thus:

{{mlix|Module|function|<nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>}} produces:

{{Module|function|first|second|third=something|...|999th}}

Purpose and naming

Mnemonically, "[m]odule [l]ink [i]nvoke e[x]panded" (after {{mli}}, "[m]odule [l]ink [i]nvoke").

This template allows an example of calling a module and function, accompanied by one or more parameters, to be displayed without also causing the module to be called.

Up to ten of the module's parameters (numbered or nowiki-keywords) may be displayed as placeholders, while more than over 10 parameters can be displayed using a coded vertical-bar (as in "|..."). A keyword parameter can be used with equals code = or {{=}} or in nowiki-text: "TAG" or all parameters as a string in "TAG" tags.

Exceptions

If the intended module lists numerous parameters, then perhaps this template should really not be used, and just hardcode the usage with TAGTAG. For example:

TAG.

If a vertical display, with parameters on their own lines, is desired, this can also be laid out manually in this manner, or more rapidly done with TAG.

Parameters

• If the only parameter supplied is {{{1}}}, i.e. a module's name, {{tlx}}'s output is the same as {{mli}} – i.e. a link within braces – but in a monospaced font:
  • {{mli|sandbox}} and {{mli|sandbox|main}} produce: {{#invoke:sandbox}} and {{#invoke:sandbox|main}}
  • {{mlix|sandbox}} and {{mlix|sandbox|main}} produce: {{#invoke:sandbox}} and {{#invoke:sandbox|main}}

{{mli}} will also not take nor display additional parameters other than the function name.

Named parameters

|subst=

Setting this parameter to any non-blank value will prefix the string subst: linked to Help:Substitution. This is useful to indicate when a module should be substituted. For example, {{mlix|sandbox|main|subst=Y}} produces:

{{subst:#invoke:sandbox|main}}

Usage

{{mlix|Modulename|function}}

{{mlix|Modulename|function|param}}

{{mlix|Modulename|function|1|2|3|4|5|6|7|8|9|10}}

{{mlix|Modulename|function|1|2|3|4|5|6|7|8|9|10|more}}

{{mlix|Modulename|function|param=value}}

There are up to 10 placeholders for parameters of the specified template.

Examples

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

See also

• {{mli}}, a version without additional parameters and the monospaced font
• {{tlx}}, a version of {{mlix}} for templates.

External links

• Template:Mlix at Wikipedia, the free Terran encyclopedia that anyone can edit.

Link templates

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

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

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)

See also

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

Template data

Show example module usage without invoking the module itself. Template parameters This template prefers inline formatting of parameters. Parameter Description Type Status Module name 1 Name of the module to link Example Example String required Function name 2 no description String required 1st parameter 3 no description String optional 2nd parameter 4 no description String optional 3rd parameter 5 no description String optional 4th parameter 6 no description String optional 5th parameter 7 no description String optional 6th parameter 8 no description String optional 7th parameter 9 no description String optional 8th parameter 10 no description String optional 9th parameter 11 no description String optional 10th parameter 12 no description String optional 13 13 no description Unknown optional Subst subst Set to any value to show "subst:" before the template name Example true Boolean optional