Template:Mlx/doc

From Fanverse
Jump to navigation Jump to search

Template:Tsh

Template:Lt (often abbreviated {{mlx}}) is used to display a module name as a link surrounded by braces with the Template:((#invokeTemplate:)) 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.

Examples[edit source]

Code Result Notes
Template:Tji {{#invoke:Example|function}} Usage without function name. This does not produce a usable invocation.
Template:Tji {{#invoke:Example|hello}} Usage with a function name.
Template:Tji {{#invoke:Example|count_fruits|bananas=5|apples=10}} Usage with a function name and parameters.
Template:Tji {{#invoke:Example|count_fruits|bananas=5|apples=10}} Usage with a function name and parameters, using Template:((=Template:)).

TemplateData[edit source]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Template:Template parameter usage

TemplateData for Mlx

Template:Sandbox other

<templatedata>{ "description": "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.", "params": {

 "1": {
   "label": "module name",
   "description": "the module name without the namespace prefix “Module:”, which is added automatically",
   "type": "string",
   "required": true
 },
 "2": {
   "label": "function name",
   "description": "the function name within the module to call",
   "type": "string",
   "required": true
 },
 "3": {
   "label": "parameter 1",
   "description": "the name (and value) of the first parameter, use = to add an equal sign",
   "type": "string"
 },
 "4": {
   "label": "parameter 2",
   "description": "the name (and value) of the second parameter, use = to add an equal sign",
   "type": "string"
 },
 "5": {
   "label": "parameter 3",
   "description": "the name (and value) of the third parameter, use = to add an equal sign",
   "type": "string"
 }

}}</templatedata>

See also[edit source]

  • {{ml}} – similar function but not surrounded in Template:Tag tags
  • {{mfl}} – similar to {{ml}} but creates a link to the function's documentation
  • {{tlx}} – a version of this template for templates instead of modules

Template:Template-linking templates