ᱪᱷᱟᱸᱪ:Mlx/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|Bananas|function|first parameter|second parameter|third|...|tenth}} produces:

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

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

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

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

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

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

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

Examples

Code	Result	Notes
{{mlx|Bananas}}	{{#invoke:Bananas}}	Usage without function name. This does not produce a usable invocation.
{{mlx|Bananas|hello}}	{{#invoke:Bananas|hello}}	Usage with a function name
{{mlx|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

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

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}}
1  {{tlg}} is the most general, allowing any combination of text style and/or link style options. 2  Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags. 3  Allows links to templates in any namespace. 4  {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>. 5  Displays monospaced font using <kbd>...</kbd> tags (changed from <tt>...</tt> for HTML 5 compliance). 6  Displays monospaced font using <span style="font-family:monospace;">...</span>.

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}}	ᱪᱷᱟᱸᱪ:Xpd1	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
{{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}}	[[WP:LASTING]]	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}}	{{d:Ping project}}	Wikidata counterpart to {{tl}}

With utility links

Code example	Effect
{{lt|Hatnote}}	Template:Hatnote (edit | talk | history | links | watch | logs)
{{lts|Hatnote}}	Template:Hatnote(edit talk links history)
{{t links|Hatnote}}	Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{tfd links|Hatnote}}	ᱪᱷᱟᱸᱪ:Tfd links
{{tiw|Hatnote}}	Template:hatnote (backlinks edit)
{{tltt|Hatnote}}	ᱪᱷᱟᱸᱪ:Tltt
{{tetl|Hatnote}}	ᱪᱷᱟᱸᱪ:Tetl
{{tsetl|Hatnote}}	ᱪᱷᱟᱸᱪ:Tsetl
{{ti|Hatnote}}	Template:Hatnote (talk⧼dot-separator⧽links⧼dot-separator⧽edit)
{{tic|Hatnote}}	Template:Hatnote (talk links edit)
{{tiw|Hatnote}}	Template:Hatnote (backlinks edit)
{{tlt|Hatnote}}	{{Hatnote}} (talk)
{{ttl|Hatnote}}	ᱪᱷᱟᱸᱪ:Ttl
{{twlh|Hatnote}}	ᱪᱷᱟᱸᱪ:Twlh

TemplateData documentation used by VisualEditor and other tools

Italic textSee the monthly error report for this template. TemplateData for Mlx 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