Template:Module link expanded/doc

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.)

{{mlx|Example|function|first parameter|second parameter|third|...|tenth}} produces:

{{#invoke:Example|function|first parameter|second parameter|third|...|tenth}}

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

{{mlx|Example|function|first{{=}}something|second|third{{=}}something|...|tenth}} produces:

{{#invoke:Example|function|first=something|second|third=something|...|tenth}}

For more than ten parameters, possibly also containing equals-signs, use <nowiki>...</nowiki> thus:

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

{{#invoke:Example|function|first|second|third=something|...|999th}}

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|custom_fruit_2|Fred|4=pineapples=10|5=kiwis=5}}	{{#invoke:Example|custom_fruit_2|Fred|pineapples=10|kiwis=5}}	Usage with a function name and parameters

See also

• {{tlx}}, a version of {{mlx}} for templates

TemplateData

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	optional
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