lua

WP:Lua (talk) Help To do Resources Reference manual

• Project subpages (mw:Lua – index at www.mediawiki.org)

This is an information page. It is not one of Wiki's policies or guidelines; rather, its purpose is to explain certain aspects of Wikipedia's norms, customs, technicalities, or practices. It may reflect differing levels of consensus and vetting.

Since February 2013, Lua code can be embedded into wiki templates by employing the "{{#invoke:}}" functionality of Scribunto. This extension supports Lua 5.1 as of October 2022^[update].

The Lua source code is stored in pages called modules (e.g., Module:Example). These individual modules are then invoked (by code {{#invoke:||(optional) param1 | param2...}}). Example:

Modules are run on normal wiki pages using the #invoke parser function. The syntax of #invoke is similar to template syntax, but with some differences. The most important difference is that you need to specify a function name. A function is a set of instructions that takes input values, processes them, and returns an output value. This is much like what a template does: you give it arguments, it processes them, and you get a result. However, you can define many functions in one Lua module, whereas you can only define one template on one page.

Furthermore, you can't just run a Lua module directly – you can only run one of the module's functions. The module is just a container for the functions, and doesn't do anything by itself. So there are two reasons that we need to input a function name: we can't run a module by itself, and without specifying a function name, Lua will not know which function it is we want to run.

The simplest way to run a module from a wiki page is like this:

{{#invoke:module name|function name}} 

For example, we can run Module:Example in this way, which has a function named "hello".

• {{#invoke:Example|hello}} → Hello World!

Using arguments

Arguments are passed to modules in the same way that they are passed to templates. Note, however, that the text after the first pipe character is always the function name; the first positional argument is the text after the second pipe.

{{#invoke:module name|function name|first positional argument|second positional argument|named argument = value}} 

In Module:Example, the "hello_to" function greets different people depending on the first positional argument. It works like this:

• {{#invoke:Example|hello_to|Kate}} → Hello, Kate!
• {{#invoke:Example|hello_to|Fred}} → Hello, Fred!

A third function in Module:Example, named "count_fruit", uses the named arguments bananas and apples to count the number of bananas and apples we have. It can be run like this:

• {{#invoke:Example|count_fruit|apples=3|bananas=4}} → I have 4 bananas and 3 apples
• {{#invoke:Example|count_fruit|bananas=5|apples=2}} → I have 5 bananas and 2 apples

Most modules have a documentation page explaining what arguments can be used and what their effects will be.

Visit Wiki talk:Lua to request help in writing a Lua script to perform a specific task on Wikipedia or another Wiki Foundation project.

Sordid history. {{qif}}, ParserFunctions, Lua extension, wiki scripting language debated (JavaScript v. Lua), mw:Extension:WikiScripts, Tim writes Scribunto with initial support for Lua.

Discussed for years, Lua was installed in 2012 for testing on test2.wikipedia.org, with open invitation to all editors to experiment with developing Lua modules. Lua was installed on the English Wikipedia in February 2013, after testing on mediawiki.org and Wiki test wikis.

See also Brad Jorsch's short presentation for a basic example of how to convert a wikitext template into a Lua module.

Lua is a scripting language which can be used to analyze data, calculate expressions, and format results using functions or object-oriented programming. Although some Lua scripts can be kept simple, for easy understanding, Lua allows complex structures including tables, dynamic functions, and associative arrays where index subscripts can be words as well as index numbers. Lua also supports recursion of re-nested functions, so care should be taken to avoid excessive complexity where other users would not understand how to maintain a Lua module. The following is the source code of the module used for the examples above.

local p = {};     --All Lua modules on Wikipedia must begin by defining a variable                      --that will hold their externally accessible functions.                     --Such variables can have whatever name you want and may                      --also contain various data as well as functions. p.hello = function( frame )     --Add a function to "p".                                           --Such functions are callable in Wikipedia                                         --via the #invoke command.                                         --"frame" will contain the data that Wikipedia                                         --sends this function when it runs.                                   -- 'Hello' is a name of your choice. The same name needs to be referred to when the module is used.          local str = "Hello World!"  --Declare a local variable and set it equal to                                 --"Hello World!".            return str    --This tells us to quit this function and send the information in                   --"str" back to Wiki English.      end  -- end of the function "hello" function p.hello_to(frame)-- Add another function local name = frame.args[1]  -- To access arguments passed to a module, use `frame.args`     -- `frame.args[1]` refers to the first unnamed parameter     -- given to the module return "Hello, " .. name .. "!"  -- `..` concatenates strings. This will return a customized  -- greeting depending on the name given, such as "Hello, Fred!" end function p.count_fruit(frame)  local num_bananas = tonumber(frame.args.bananas) or 0-- Named arguments ({{#invoke:Example|count_fruit|foo=bar}}) local num_apples = tonumber(frame.args.apples) or 0-- are likewise accessed by indexing `frame.args` by name (`frame.args["bananas"]`, --  or equivalently `frame.args.bananas`.  local conj_bananas = num_bananas == 1 and 'banana' or 'bananas'     local conj_apples = num_apples == 1 and 'apple' or 'apples'     -- Ternary operators assign values based on a condition in a compact way. -- Here, `conj_bananas` gets `'banana'` if `num_bananas` is 1, else `'bananas'`. -- Similarly, `conj_apples` gets `'apple'` if `num_apples` is 1, else `'apples'`.          return 'I have ' .. num_bananas ..  ' ' .. conj_bananas .. ' and ' .. num_apples .. ' ' .. conj_apples    -- Like above, concatenate a bunch of strings together to produce    -- a sentence based on the arguments given. end  return p    --All modules end by returning the variable containing their functions to Wiki English. -- Now we can use this module by calling {{#invoke: Example | hello }}, -- {{#invoke: Example | hello_to | foo }}, or {{#invoke:Example|count_fruit|bananas=5|apples=6}} -- Note that the first part of the invoke is the name of the Module's wikipage, -- and the second part is the name of one of the functions attached to the  -- variable that you returned.  -- The "print" function is not allowed in Wiki English.  All output is accomplished -- via strings "returned" to Wiki English. 

A sample of Lua is highlighted by tag "..." placed around the Lua source code. To view some more complex examples of Lua, see article: "Lua (programming language)".

For instructions on how to use Lua within MediaWiki (and hence Wikipedia), see mw:Extension:Scribunto/Lua reference manual.

A few unit testing frameworks are available for Lua scripts on Wiki English. These allow an editor to execute the module with a given set of inputs and verify that the expected outputs are produced. They are useful for rapidly detecting software regressions, where modifications to a script introduce new (or identify old) problems.

By convention, unit tests for a module like Module:Example are placed in Module:Example/testcases, and are executed on Module talk:Example/testcases.

Module:UnitTests is the prefilled code used when creating a testcases page. You run these unit tests by placing {{#invoke:Example/testcases|run_tests}} on the testcases talk page.

Module:ScribuntoUnit is another widely used test framework. Category:Modules for test tools has a few others to review which may be interesting.

Overall: Lua can only get input as text strings passed to the {{#invoke:}} and what can be fetched via mw.title.new(...):getContent() and frame:expandTemplate(). Lua output will not be preprocessed unless frame:preprocess() is explicitly called, meaning that template calls, parser functions, etc. in the output will not work correctly. Also, all Lua in the page is limited to 10 seconds CPU time (you can look in the source code of a rendered page to see how long a template or module took to parse). And relative to standard Lua, Scribunto's Lua lacks all sorts of functions (see mw:Extension:Scribunto/Lua reference manual § Differences from standard Lua).

Lua input limitations

Lua code in Scribunto is only run when the page is being parsed. Therefore, the only user input that Lua can receive is by page editing – it cannot create a box that calculates the square root of a number you type in, or recalculate a piece of the Mandelbrot set depending on which part of the parent set you click on. The input Lua can receive includes any transcludeable text page on Wiki English. This does not include graphics files (not even .SVG files, although they are actually text, unless you cut and paste it onto a Wiki text page), the list of pages listed in a category, nor the contents of non-transcludeable special pages.

Wikitext

Transcluded Wikipedia headers frequently contain a hidden code such as "UNIQ5ae8f2aa414ff233-h-3--QINU" which may need to be stripped out in order for them to be parsed effectively.

Wikilinks using the pipe trick [[Wikipedia:Help| ]] won't work if returned as output – they need to be written explicitly as [[Wikipedia:Help|Help]]. Other pre-save transforms, such as replacing ~~~~ with signatures, will also fail to be processed. Template transclusions, parser function calls, and variable substitutions (i.e. anything with a {{...}}) will not be processed, nor will tags such as or . Use frame:extensionTag to add tags like or to output.

This template uses Lua: Module:Example (sandbox)

Please place the {{lua}} template on the documentation subpage of all templates that use Lua. It will help to better communicate Lua usage and template conversions.

• Special:PrefixIndex/Module: – tracking of Lua modules can be done by using Special:PrefixIndex
• Help:Lua debugging – a how-to guide about debugging Lua modules
• Module:Sandbox provides a pseudo-namespace for experimenting with Lua modules
• Category:Lua-based templates – groups of Lua-based templates
• Category:Lua metamodules
• Manual:Coding conventions/Lua – standards to improve the readability of code through consistency
• mw:Extension:Scribunto/Lua reference manual and all Modules.
• Wiki: Advanced template coding