View source for 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, [[w:Ellipsis|ellipses (groups of three dots)]] indicate where parameters have been omitted.)''

: {{tlx|mlx|Example|function|''first parameter''|''second parameter''|''third''|...|''tenth''}} produces:<br /> 
{{mlx|Example|function|''first parameter''|''second parameter''|''third''|...|''tenth''}}

Where parameters might contain one or more equals-signs ("="), replace each equals-sign with {{tlf|{{=}}}}:
: {{tlx|mlx|Example|function|''first''<nowiki>{{=}}</nowiki>''something''|''second''|''third''<nowiki>{{=}}</nowiki>''something''|...|tenth}} produces:<br />
{{mlx|Example|function|''first{{=}}something''|''second''|''third{{=}}something''|...|''tenth''}}

For more than ten parameters, possibly also containing equals-signs, use {{tag|nowiki}} thus:
: {{tlx|mlx|Example|function|&lt;nowiki><nowiki>''first''|''second''|''third=something''|...|''999th''</nowiki>&lt;/nowiki>}} produces:<br />
{{mlx|Example|function|<nowiki>first|second|third=something|...|999th</nowiki>}}

==Examples==
{| class="wikitable"
! Code
! Result
! Notes
|-
| <code><nowiki>{{mlx|Example}}</nowiki></code>
| {{mlx|Example}}
| Usage without function name. This does not produce a usable invocation.
|-
| <code><nowiki>{{mlx|Example|hello}}</nowiki></code>
| {{mlx|Example|hello}}
| Usage with a function name
|-
| <code><nowiki>{{mlx|Example|custom_fruit_2|Fred|4=pineapples=10|5=kiwis=5}}</nowiki></code>
| {{mlx |Example|custom_fruit_2 |Fred |4=pineapples=10 |5=kiwis=5}}
| Usage with a function name and parameters
<!--|-
| <code><nowiki>{{tls|Example}}</nowiki></code>
| {{[[Wikipedia:Substitution|subst]]:[[Template:Example|Example]]}}
| For templates that should be [[Wikipedia:Substitution|substituted]]
|-
| <code><nowiki>{{tl2|X1}}</nowiki></code>
| <code><nowiki>{{</nowiki>[[{{{LANG|}}}{{{SISTER|}}}{{ns:Template}}:X1|X1]]<nowiki>}}</nowiki></code>
| This formats the link to show how it would look in code (i.e., monospace font)
|-
| <code><nowiki>{{tl2|sister=M:|3x}}</nowiki></code>
| <code><nowiki>{{</nowiki>[[{{{LANG|}}}M:{{ns:Template}}:3x|3x]]<nowiki>}}</nowiki></code>
| Same as above, for templates on another Wikimedia project (in this example, Meta)
|-
| <code><nowiki>{{tl2|sister=wikibooks|lang=de:|WP}}</nowiki></code>
| <code><nowiki>{{</nowiki>[http://de.wikibooks.org/wiki/Vorlage:WP WP]<nowiki>}}</nowiki></code>--><!--
––––– This is currently a fraudulent output result... the template code needs modified to work
––––– per this plan, then this /doc file fixed up to match whatever the correct syntax actually is.
––––– ALMOST work: 
[[:de:wikibooks:{{ns:template}}:WP|WP]]
[[de:wikibooks:{{ns:template}}:WP|WP]]
--><!--
| For templates on another language project
|-
| <code><nowiki>{{tl|1==)}}</nowiki></code>
| {{tl|1==)}}
| Use the format <code><nowiki>{{tl|1=templatename}}</nowiki></code> if the template contains template coding characters such as {{tl|1==)}} or {{tl|1=!}}-->
|}

== See also ==
* {{tl|tlx}}, a version of {{tl|mlx}} for templates

== TemplateData ==
<templatedata>
{
	"params": {
		"1": {
			"label": "Module name",
			"description": "Name of the module to link",
			"example": "Example",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Function name",
			"type": "string"
		},
		"3": {
			"label": "1st parameter",
			"type": "string"
		},
		"4": {
			"label": "2nd parameter",
			"type": "string"
		},
		"5": {
			"label": "3rd parameter",
			"type": "string"
		},
		"6": {
			"label": "4th parameter",
			"type": "string"
		},
		"7": {
			"label": "5th parameter",
			"type": "string"
		},
		"8": {
			"label": "6th parameter",
			"type": "string"
		},
		"9": {
			"label": "7th parameter",
			"type": "string"
		},
		"10": {
			"label": "8th parameter",
			"type": "string"
		},
		"11": {
			"label": "9th parameter",
			"type": "string"
		},
		"12": {
			"label": "10th parameter",
			"type": "string"
		},
		"13": {},
		"subst": {
			"description": "Set to any value to show \"subst:\" before the template name",
			"example": "true",
			"type": "boolean"
		}
	},
	"description": "Show example module usage without invoking the module itself.",
	"paramOrder": [
		"1",
		"2",
		"3",
		"4",
		"5",
		"6",
		"7",
		"8",
		"9",
		"10",
		"11",
		"12",
		"13",
		"subst"
	],
	"format": "inline"
}
</templatedata>