Jump to content

ᥗᥦᥛᥰ ᥙᥣ ᥘᥥᥐᥳ:Module function link/doc

ᥘᥧᥐ ᥖᥤ ᥝᥤᥱ ᥑᥤᥱ ᥚᥤᥱ ᥖᥤᥱ ᥕᥣᥱ ᥛᥣᥰ

{{mfl}} is similar to {{ml}}, but assumes that the function specified is documented, and thus creates a link to a section of the same name expected to be found in the documentation. Another difference with {{ml}} is that the behaviour of empty and undefined in the second parameter here is inverted.

Code Result Notes
{{mfl|Example}} {{#invoke:Example}} Omits the function name
{{mfl|Example|hello}} {{#invoke:Example|hello}} Usage with a function name.
{{mfl|Example|count_fruit|3=bananas=10|4=kiwis=5}} {{#invoke:Example|count_fruit|bananas=10|kiwis=5}} Usage with a function name and parameters.
{{mfl|Example|count_fruit|Fred|bananas{{=}}10|apples{{=}}5}} {{#invoke:Example|count_fruit|Fred|bananas=10|apples=5}} Usage with a function name and parameters, using ᥗᥦᥛᥰ ᥙᥣ ᥘᥥᥐᥳ:((=ᥗᥦᥛᥰ ᥙᥣ ᥘᥥᥐᥳ:)).
{{mfl|Example|}} {{#invoke:Example|function}} Usage with a generic function name. This does not produce a usable invocation.
ᥑᥩᥲ ᥛᥧᥢᥰ ᥓᥫᥰ ᥚᥣᥭᥱ ᥖᥬᥲ ᥢᥭᥳ ᥙᥥᥢᥴ ᥖᥨᥝᥴ ᥗᥖᥰ ᥖᥣᥴ ᥞᥢᥴ(VisualEditor) ᥟᥢᥴ ᥛᥤᥰ ᥖᥤᥲ ᥝᥤᥱ ᥑᥤᥱ ᥚᥤᥰᥖᥤᥰ ᥕᥣᥰ ᥢᥢᥳ ᥕᥫᥒᥰ ᥟᥣᥢᥰ ᥖᥣᥱ ᥟᥝᥴ ᥑᥫᥒᥲ ᥓᥫᥰ ᥢᥢᥳ ᥓᥬᥳ ᥘᥭᥲ ᥖᥤᥲ ᥝᥤᥱ ᥑᥤᥱ ᥚᥤᥰ ᥖᥤᥰ ᥕᥣᥰ ᥖᥭᥰ ᥔᥥᥴ ᥓᥒᥱ ᥘᥭᥲ ᥟᥝᥴ ᥙᥫᥒᥴ ᥑᥩᥲ ᥛᥧᥢᥰ ᥗᥦᥛᥰ ᥙᥘᥥᥐᥳ (TemplateData) ᥟᥢᥴ ᥛᥤᥰ ᥖᥤᥲ ᥝᥤᥱ ᥑᥤᥱ ᥚᥤᥰ ᥖᥤᥰ ᥕᥣᥰ ᥟᥤᥒᥰ ᥐᥘᥥᥖᥲ ᥢᥢᥳ ᥞᥥᥖᥰ ᥝᥭᥳ ᥙᥥᥢᥴ ᥖᥤᥲ ᥛᥣᥭᥴ ᥖᥤᥲ ᥖᥩᥒᥰ ᥕᥝᥳ။ ᥞᥨᥛᥲ ᥝᥣᥲ ᥙᥭᥱ ᥓᥬᥳ ᥑᥫᥒᥲ ᥓᥫᥰ ᥢᥢᥳ ᥔᥥᥴ ᥖᥣᥳ ᥙᥩᥰ ᥙᥥᥢᥴ ᥐᥨᥢᥰ ᥞᥧᥳ ᥘᥩᥒᥲ ᥖᥦᥛᥲ ᥙရᥨᥝᥱ ᥐᥦᥛᥱ (computer programming) ᥟᥤᥖᥰ ᥟᥩᥖᥰ ᥐᥩᥲ ᥞᥬᥲ ᥙᥩᥰ ᥞᥢᥴ ᥘᥭᥲ ᥓᥦᥒᥲ ᥘᥦᥒᥰ ᥘᥤᥴᥢᥭᥴ ᥔᥥᥴ ᥓᥣᥒᥲ ᥟᥝᥴ ᥓᥬᥳ ᥘᥭᥲ ᥔᥚᥩᥰ ᥖᥤᥲ ᥐᥦᥙᥲ ᥛᥢᥰ ᥘᥭᥲ ᥕᥧᥱ.

Module function link

This template displays a module name as a link surrounded by braces with the {{#invoke}} parser function, itself linked, thus showing how the module name would be used in code. Its primary use is in instruction and documentation.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
module name1

the module name without the namespace prefix “Module:”, which is added automatically

Stringrequired
function name2

the function name within the module to call, expected to be documented

Stringoptional
parameter 13

the name (and value) of the first parameter, use {{=}} to add an equal sign

Stringoptional
parameter 24

the name (and value) of the second parameter, use {{=}} to add an equal sign

Stringoptional
parameter 35

the name (and value) of the third parameter, use {{=}} to add an equal sign

Stringoptional
  • {{ml}} - Similar function but without generating links
  • {{tl}} - A version of this template for templates instead of modules.

ᥗᥦᥛᥰ ᥙᥣ ᥘᥥᥐᥳ:Template-linking templates