Teamplaid:Mlx/documentation

Teamplaid:Mlx (deasaich | deasbaireachd | eachdraidh | ceanglaichean | faire | logaichean) 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.

Eisimpleirean - 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 {{=}}.

Teamplaid-dàta - TemplateData

This is the WP:TemplateData documentation for this template used by WP:VisualEditor and other tools; see the monthly parameter usage report for this template.

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.

Paramadairean na teamplaide[Stiùirich an TemplateData]

Paramadair		Tuairisgeul	Seòrsa	Staid
module name	1	the module name without the namespace prefix “Module:”, which is added automatically	Sreang	riatanach
function name	2	the function name within the module to call	Sreang	riatanach
parameter 1	3	the name (and value) of the first parameter, use {{=}} to add an equal sign	Sreang	roghainneil
parameter 2	4	the name (and value) of the second parameter, use {{=}} to add an equal sign	Sreang	roghainneil
parameter 3	5	the name (and value) of the third parameter, use {{=}} to add an equal sign	Sreang	roghainneil

Faic cuideachd - Also see

• {{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 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	{{Tlf}}2	{{Tls}} {{Tlsp}} {{Tlsu}}3	{{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	{{Tltss}}6
bold	bold=yes	{{Tlb}}	N/A
bold+code	code=yes	{{Tlxb}}
italic+code	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}}	"{{Hatnote|Some Hatnote text}}" gives " Some Hatnote text " [1]	Shows code, example and a link to expand the template code
{{Tln|Hatnote}}	Template:Hatnote	Produces a normal link to the template
{{Elc|Template:Hatnote}} {{Elc|Template:Hatnote|Hatnote}}	[[Template:Hatnote]] [[Template:Hatnote|Hatnote]]	Formats wikilink, with optional piped link text and blended suffix
{{Ml|Example|hello}}	{{#invoke:Example|hello}}	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}}	[[w:en: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}}
{{Pf|If}} {{Pf|If|{{{1}}}|true|false}}	{{#If}} {{#If:{{{1}}}|true|false}}	Parser function equivalent to {{Tl}}

With utility links

Code example	Effect
{{Lt|Hatnote}}	Teamplaid:Hatnote (deasaich | deasbaireachd | eachdraidh | ceanglaichean | faire | logaichean)
{{Lts|Hatnote}}	Teamplaid:Hatnote(deasaich deasbaireachd ceanglaichean-lìn eachdraidh)
{{T links|Hatnote}}	Hatnote (edit talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
{{Tfd links|Hatnote}}	Template:Hatnote (edit · talk · history · links · transclusions · logs · subpages · delete)
{{Tltt|Hatnote}}	{{Hatnote}}
{{Tetl|Hatnote}}	{{Hatnote}} links talk view
{{Tsetl|Hatnote}}	{{subst:Hatnote}}  links talk view
{{Ti|Hatnote}}	Teamplaid:Hatnote (deasbaireachd⧼dot-separator⧽ceanglaichean-lìn⧼dot-separator⧽deasaich)
{{Tic|Hatnote}}	Template:Hatnote (talk links edit)
{{Tim|Hatnote}}	m:Template:Hatnote (backlinks edit)
{{Tiw|Hatnote}}	Teamplaid:Hatnote  (ceanglaichean deasaich)
{{Tlt|Hatnote}}	{{Hatnote}} (talk)
{{Ttl|Hatnote}}	{{Hatnote}} (t/l)
{{Twlh|Hatnote}}	Template:Hatnote (links, talk)