Template:Ml-lua References

require('{{{1}}}')

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

{{ ml-lua}}

Examples:

{{ml-lua|strict}} → require('strict')
{{ml-lua|Module:Log globals}} → require('Module:Log globals')

Usage

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Module link lua in articles based on its TemplateData.

TemplateData for Module link lua

A template to create links to Lua modules or built-in Lua libraries, displaying the text "require('<name>')".

Template parameters Edit template data
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Module	`1`	Either the full title of a module ("Module:String") or the name of a built-in module ("strict").	String	required

Comparison of template-linking templates according to the styles of generated text and link produced
Text style ↓	`{{ tlg}}` options^{[note 1]} to achieve text style	Link style
Text style ↓	`{{ tlg}}` options^{[note 1]} to achieve text style	Linked	Unlinked	Linked with subst	Unlinked with subst	Linked including braces	Linked with alternative text
`{{ tlg}}` options^{[note 1]} to achieve link style	—	DEFAULT	`nolink=yes`	`subst=yes`	`nolink=yes\|subst=yes`	`braceinside=yes`	`alttext=Foo` `2=Foo`
normal	DEFAULT	{{ tlg}}^{[note 1]} {{ tl}} {{ tlp\|1\|2\|...}}^{[note 2]} {{ Template:tlu}}^{[note 3]}	{{tlf}}^{[note 2]} ^{< template link>}	{{ subst:tls}} {{ subst: Template:tlsu}}^{[note 3]}	{{subst:tlsf}}^{[note 2]} ^{< template link>}	{{tn}}	{{ tla}}
`code`	`code=yes`	`{{ tl2}}` `{{ tlx}}` `{{ Template:tlxu}}`^{[note 3]}	`{{tlc}}`^{[note 2]} ^{< template link>} `{{tnull}}`^{< template link>}	`{{ subst:tlxs}}`	`{{subst:tlsc}}`^{[note 2]} ^{< template link>}	—
monospace	`plaincode=yes`^{[note 4]}	—		{{ subst: tltss}}^{[note 5]}	—
`kbd`	`kbd=yes`^{[note 5]}	—		{{ subst: tltss}}^{[note 5]}	—
bold	`bold=yes`	{{ tlb}}	—
`bold+code`	`bold=yes\|code=yes`	`{{ tlxb}}`
`italic+code`	`italic=yes\|code=yes`	`{{ tlxi}}`

^ ^a ^b ^c {{ tlg}} is the most general template, allowing any combination of text style and/or link style options.
^ ^a ^b ^c ^d ^e Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.
^ ^a ^b ^c Allows links to templates in any namespace.
^ {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.
^ ^a ^b Displays monospaced font using <span style="font-family:monospace;">...</span>.

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code example	Effect	Notes
`{{ Tj\|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{ Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext"> {{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }} </syntaxhighlight>	{{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }}	Same as above
`{{ Tji\|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{ Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}	Supports colors, placeholder texts, named and unnamed parameters
`< syntaxhighlight lang="wikitext" inline>{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}</syntaxhighlight>`	`{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}`	Same as above
`{{ tl2\|Hatnote\|lang=fr}}`	`{{ hatnote}}`	Supports linking to sister projects (e.g., fr:Hatnote)
`{{ demo\|<nowiki>{{Hatnote\|lang=fr\|Some text}}</nowiki>}}`	{{hatnote\|lang=fr\|Some text}} Some text	Shows code and example
`{{ 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
`{{ mfl\|Example\|hello}}`	{{ #invoke:Example\| hello}}	Similar to {{ ml}}, but expects the function to be documented and creates a link to the corresponding section
`{{ mlx\|Example\|hello}}`	`{{ #invoke:Example\|hello}}`	Counterpart to {{ tlx}} for linking to Lua modules
`{{ ml-lua\|Module:Example\|hello}}`	`require('Module:Example')`	Link to Lua modules and built-in libraries, showing Lua code.
`{{ 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}}
`{{ pf\|if}}` `{{ pf\|if\|{{{1}}}\|true\|false}}`	{{ #if}} {{ #if:{{{1}}}\|true\|false}}	Parser function equivalent to {{ tl}}
`{{ magic word\|uc:}}`	{{ uc:}}	Magic word links

With utility links

Templates producing utility links for a given template ( Hatnote used here as example)
Code example	Effect
`{{ lt\|Hatnote}}`	Template:Hatnote ( \| talk \| history \| links \| watch \| logs)
`{{ lts\|Hatnote}}`	Template:Hatnote( talk links history)
`{{ t links\|Hatnote}}`	{{ Hatnote}} ( talk history links # /subpages /doc /doc edit /sbox /sbox diff /test)
`{{ tfd links\|Hatnote}}`	Template:Hatnote ( talk · history · transclusions · logs · subpages)
`{{ tetl\|Hatnote}}`	{{ Hatnote}} links talk
`{{ tsetl\|Hatnote}}`	{{ subst: Hatnote}} links talk
`{{ ti\|Hatnote}}`	Template:Hatnote ( talk · links · )
`{{ tic\|Hatnote}}`	Template:Hatnote ( talk links )
`{{ tim\|Hatnote}}`	m:Template:Hatnote ( backlinks )
`{{ tiw\|Hatnote}}`	Template:Hatnote ( backlinks )
`{{ tlt\|Hatnote}}`	{{ Hatnote}} ( talk)
`{{ ttl\|Hatnote}}`	{{ Hatnote}} ( t/ l)
`{{ twlh\|Hatnote}}`	Template:Hatnote ( links, talk)

The above documentation is transcluded from Template:Module link lua/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

[TlTfn1-1] {{ tlg}} is the most general template, allowing any combination of text style and/or link style options.

[TlTfn2-2] Prevents wrapping of text by placing it inside <span class="nowrap">...</span> tags.

[TlTfn3-3] Allows links to templates in any namespace.

[TlTfn4-4] {{tlg|plaincode=yes}} uses <code style="border:none; background-color:transparent;">...</code>.

[TlTfn5-5] Displays monospaced font using <span style="font-family:monospace;">...</span>.

[note 1]

[note 2]

[note 3]

[note 4]

[note 5]

Code example	Effect	Notes
`{{ Tj\|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{ Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }}	Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext"> {{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }} </syntaxhighlight>	{{Hatnote \| Some text \| selfref = yes \| category = no \| lang = fr }}	Same as above
`{{ Tji\|Hatnote\|Some text\|selfref: yes\|category: no\|lang: fr}}`	{{ Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}	Supports colors, placeholder texts, named and unnamed parameters
`< syntaxhighlight lang="wikitext" inline>{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}</syntaxhighlight>`	`{{Hatnote\|Some text\|selfref=yes\|category=no\|lang=fr}}`	Same as above
`{{ tl2\|Hatnote\|lang=fr}}`	`{{ hatnote}}`	Supports linking to sister projects (e.g., fr:Hatnote)
`{{ demo\|<nowiki>{{Hatnote\|lang=fr\|Some text}}</nowiki>}}`	{{hatnote\|lang=fr\|Some text}} Some text	Shows code and example
`{{ 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
`{{ mfl\|Example\|hello}}`	{{ #invoke:Example\| hello}}	Similar to {{ ml}}, but expects the function to be documented and creates a link to the corresponding section
`{{ mlx\|Example\|hello}}`	`{{ #invoke:Example\|hello}}`	Counterpart to {{ tlx}} for linking to Lua modules
`{{ ml-lua\|Module:Example\|hello}}`	`require('Module:Example')`	Link to Lua modules and built-in libraries, showing Lua code.
`{{ 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}}
`{{ pf\|if}}` `{{ pf\|if\|{{{1}}}\|true\|false}}`	{{ #if}} {{ #if:{{{1}}}\|true\|false}}	Parser function equivalent to {{ tl}}
`{{ magic word\|uc:}}`	{{ uc:}}	Magic word links

Usage

See also

General-purpose formatting

Other formatting templates

With utility links