Extension:Scribunto/Lua reference manual: Difference between revisions

<translate>

{{languages|Extension:Scribunto/Lua reference manual}}

{{TNT|Shortcut|Lua manual|LUAREF}}

 

This manual documents [[Lua]] as it is used in MediaWiki with the [[Extension:Scribunto|Scribunto]] extension. Some parts are derived from the [http://www.lua.org/manual/5.1/index.html Lua 5.1 reference manual], which is available under the [[#License|MIT license]].

 

{{mbox

| type = notice

<div style="float:right;margin-left:1em;"> __TOC__ </div>

 

=== Getting started ===

 

On a MediaWiki wiki with Scribunto enabled, [[Help:Starting a new page|create a page]] with a title starting with "Module:", for example "Module:Bananas". Into this new page, copy the following text:

 

<syntaxhighlight lang="lua">

local p = {}

 

function p.hello( frame )

return "Hello, world!"

end

 

return p

</syntaxhighlight>

 

Save that, then on another (non-module) page, write:

 

<pre>

{{#invoke:Bananas|hello}}

</pre>

 

Except that you should replace "Bananas" with whatever you called your module. This will call the "hello" function exported from that module. The <nowiki>{{#invoke:Bananas|hello}}</nowiki> will be replaced with the text that the function returned, in this case, "Hello, world!"

 

It's generally a good idea to invoke Lua code from the context of a template. This means that from the perspective of a calling page, the syntax is independent of whether the template logic is implemented in Lua or in wikitext. It also avoids the introduction of additional complex syntax into the content namespace of a wiki.

 

 

The module itself must return a table containing the functions that may be called by <code><nowiki>{{#invoke:}}</nowiki></code>. Generally, as shown above, a local variable is declared holding a table, functions are added to this table, and the table is returned at the end of the module code.

 

Any functions that are not added to this table, whether local or global, will not be accessible by <code><nowiki>{{#invoke:}}</nowiki></code>, but globals might be accessible from other modules loaded using <code>[[#require|require()]]</code>. It is generally good style for the module to declare all functions and variables local.

 

 

Functions called by <code><nowiki>{{#invoke:}}</nowiki></code> will be passed a single parameter, that being a [[#Frame object|frame object]]. To access the parameters passed to the <code><nowiki>{{#invoke:}}</nowiki></code>, code will typically use the [[#frame.args|<code>args</code> table of that frame object]]. It's also possible to access the parameters passed to the template containing the <code><nowiki>{{#invoke:}}</nowiki></code> by using [[#frame:getParent|</code>frame:getParent()</code>]] and accessing that frame's <code>args</code>.

 

This frame object is also used to access context-specific features of the wikitext parser, such as [[#frame:callParserFunction|calling parser functions]], [[#frame:expandTemplate|expanding templates]], and [[#frame:preprocess|expanding arbitrary wikitext strings]].

 

 

The module function should usually return a single string; whatever values are returned will be passed through [[#tostring|tostring()]] and then concatenated with no separator. This string is incorporated into the wikitext as the result of the <code><nowiki>{{#invoke:}}</nowiki></code>.

 

At this point in the page parse, templates have already been expanded, parser functions and extension tags have already been processed, and pre-save transforms (e.g. signature tilde expansion and the [[Help:Pipe trick|pipe trick]]) have already happened. Therefore the module cannot use these features in its output text. For example, if a module returns <code><nowiki>"Hello, [[world]]! {{welcome}}"</nowiki></code>, the page will read "Hello, [[world]]! <nowiki>{{welcome}}</nowiki>".

 

On the other hand, [[mw:Help:Substitution|subst]] is handled at an earlier stage of processing, so with <code><nowiki>{{subst:#invoke:}}</nowiki></code> only other attempted substitutions will be processed. Since the failed substitution will remain in the wikitext, they will then be processed on the ''next'' edit. This should generally be avoided.

 

 

Scribunto allows modules to be documented by automatically associating the module with a wikitext documentation page; by default, the "/doc" subpage of the module is used for this purpose and is transcluded above the module source code on the module page. For example, the documentation for "Module:Bananas" would be at "Module:Bananas/doc".

 

This can be configured using the following [[:meta:Help:System message|MediaWiki-namespace messages]]:

* '''scribunto-doc-page-name''': Sets the name of the page used for documentation. The name of the module (without the Module: prefix) is passed as <code>$1</code>. If in the module namespace, the pages specified here will be interpreted as wikitext rather than Lua source and may not be used with <code><nowiki>{{#invoke:}}</nowiki></code>. The default is "Module:$1/doc", i.e. the /doc subpage of the module. Note that parser functions and other brace expansion may not be used in this message.

* '''scribunto-doc-page-header''': Header displayed when viewing the documentation page itself. The name of the module (with Module: prefix) being documented is passed as <code>$1</code>. The default simply displays a short explanation in italics.

 

Note that modules cannot be directly categorized and cannot have interwiki links directly added. These could be placed on the documentation page inside <code><nowiki><includeonly>...</includeonly></nowiki></code> tags, where they will be applied to the module when the documentation page is transcluded onto the module page.

 

 

 

{{Anchor|name}}

''Names'' (also called ''identifiers'') in Lua can be any string of letters, digits, and underscores, not beginning with a digit. Names are case-sensitive; "foo", "Foo", and "FOO" are all different names.

 

The following keywords are reserved and may not be used as names:

<div style="margin:0.3em 1.6em; column-width: 10em; -moz-column-width: 10em; -webkit-column-width: 10em">

Names starting with an underscore followed by uppercase letters are reserved for internal Lua global variables.

 

Other tokens are:

<div style="margin:0.3em 1.6em; column-width: 10em; -moz-column-width: 10em; -webkit-column-width: 10em">

</div>

 

 

A comment starts with a <code>--</code> anywhere outside a string. If the <code>--</code> is immediately followed by [[#long brackets|an opening long bracket]], the comment continues to the corresponding closing long bracket; otherwise the comment runs to the end of the current line.

<source lang="lua">

</source>

 

 

Lua is a dynamically-typed language, which means that variables and function arguments have no type, only the values assigned to them. All values carry a type.

 

Lua has eight basic data types, however only six are relevant to the Scribunto extension. The <code>[[#type|type()]]</code> function will return the type of a value.

 

The <code>[[#tostring|tostring()]]</code> function will convert a value to a string. The <code>[[#tonumber|tonumber()]]</code> function will convert a value to a number if possible, and otherwise will return nil. There are no explicit functions to convert a value to other data types.

 

Numbers are automatically converted to strings when used where a string is expected, e.g. when used with the concatenation operator. Strings recognized by <code>[[#tonumber|tonumber()]]</code> are automatically converted to numbers when used with arithmetic operators. When a boolean value is expected, all values other than nil and false are considered to be true.

 

 

"nil" is the data type of <code>nil</code>, which exists to represent the absence of a value.

 

Nil may not be used as a key in a table, and there is no difference between an unassigned table key and a key assigned a nil value.

 

When converted to a string, the result is "nil". When converted to boolean, nil is considered false.

 

 

Boolean values are <code>true</code> and <code>false</code>.

 

When converted to a string, the result is "true" or "false".

 

Unlike many other languages, boolean values may not be directly converted to numbers. And unlike many other languages, only false and nil are considered false for boolean conversion; the number 0 and the empty string are both considered true.

 

 

Lua strings are considered a series of 8-bit bytes; it is up to the application to interpret them in any particular encoding.

 

String literals may be delimited by either single or double quotes (<code>'</code> or <code>"</code>); like JavaScript and unlike PHP, there is no difference between the two. The following escape sequences are recognized:

<div style="column-width:20em; -moz-column-width:20em; -webkit-column-width:20em">

A literal newline may also be included in a string by preceding it with a backslash. Bytes may also be specified using an escape sequence '\''ddd''', where ''ddd'' is the decimal value of the byte in the range 0–255. To include Unicode characters using escape sequences, the individual bytes for the [[:en:UTF-8|UTF-8]] encoding must be specified; in general, it will be more straightforward to enter the Unicode characters directly.

 

{{Anchor|long brackets}}

Literal strings can also be defined using ''long brackets''. An opening long bracket consists of an opening square bracket followed by zero or more equal signs followed by another opening square bracket, e.g. <code>[[</code>, <code>[=[</code>, or <code>[=====[</code>. The opening long bracket must be matched by the corresponding closing long bracket, e.g. <code>]]</code>, <code>]=]</code>, or <code>]=====]</code>. As a special case, if an opening long bracket is immediately followed by a newline then the newline is not included in the string, but a newline just before the closing long bracket is kept. Strings delimited by long brackets do not interpret escape sequences.

]]

 

-- is equivalent to this quote-delimited string

bar = 'bar\\tbaz\n'

</syntaxhighlight>

 

Note that all strings are considered true when converted to boolean. This is unlike most other languages, where the empty string is usually considered false.

 

 

Lua has only one numeric type, which is typically represented internally as a [[:en:double-precision floating-point format|double-precision floating-point value]]. In this format, integers between -9007199254740992 and 9007199254740992 may be represented exactly, while larger numbers and numbers with a fractional part may suffer from round-off error.

 

Number constants are specified using a period (<code>.</code>) as a decimal separator and without grouping separators, e.g. <code>123456.78</code>. Numbers may also be represented using [[:en:E notation|E notation]] without spaces, e.g. <code>1.23e-10</code>, <code>123.45e20</code>, or <code>1.23E5</code>. Integers may also be specified in hexadecimal notation using a <code>0x</code> prefix, e.g. <code>0x3A</code>.

 

Although [[:en:NaN|NaN]] and positive and negative infinities are correctly stored and handled, Lua does not provide corresponding literals. The constant <code>math.huge</code> is positive infinity, as is a division such as <code>1/0</code>, and a division such as <code>0/0</code> may be used to quickly generate a NaN.

 

Note that all numbers are considered true when converted to boolean. This is unlike most other languages, where the number 0 is usually considered false. When converted to a string, finite numbers are represented in decimal, possibly in E notation; NaN is "nan" or "-nan"; and infinities are "inf" or "-inf".

 

 

Lua tables are associative arrays, much like PHP arrays and JavaScript objects.

 

Tables are created using curly braces. The empty table is <code>{}</code>. To populate fields on creation, a comma- and/or semicolon-separated list of field specifiers may be included in the braces. These take any of several forms:

* <code style="white-space:nowrap">[''[[#Expressions|expression1]]''] = ''[[#Expressions|expression2]]''</code> uses the (first) value of ''expression1'' as the key and the (first) value of ''expression2'' as the value.

* <code>''[[#Expressions|expression]]''</code> is roughly equivalent to <code style="white-space:nowrap">[''i''] = ''expression''</code>, where ''i'' is an integer starting at 1 and incrementing with each field specification of this form. If this is the last field specifier and the expression has multiple values, all values are used; otherwise only the first is kept.

 

The fields in a table are accessed using bracket notation, e.g. <code>table[key]</code>. String keys that are also valid [[#name|names]] may also be accessed using dot notation, e.g. <code>table.key</code> is equivalent to <code>table['key']</code>. Calling a function that is a value in the table may use colon notation, e.g. <code style="white-space:nowrap">table:func( ... )</code>, which is equivalent to <code style="white-space:nowrap">table['func']( table, ... )</code>.

 

{{Anchor|sequence}}

A ''sequence'' is a table with non-nil values for all positive integers from 1 to N and no value (nil) for all positive integers greater than N. Many Lua functions operate only on sequences, and ignore non-positive-integer keys.

 

Unlike many other languages such as PHP or JavaScript, any value except nil and NaN may be used as a key and no type conversion is performed. These are all valid and distinct:

<syntaxhighlight lang="lua">

t = {}

 

t["foo"] = "foo"

t.bar = "bar"

t[t] = "yes, a table may be a table key too. Even in itself."

 

-- This creates a table roughly equivalent to the above

t2 = {

</syntaxhighlight>

 

Similarly, any value except nil may be stored as a value in a table. Storing nil is equivalent to deleting the key from the table, and accessing any key that has not been set will result in a nil value.

 

Note that tables are never implicitly copied in Lua; if a table is passed as an argument to the function and the function manipulates the keys or values in the table, those changes will be visible in the caller.

 

When converted to a string, the usual result is "table" but may be overridden using the <code>__tostring</code> [[#Metatables|metamethod]]. Even the empty table is considered true as a boolean.

 

 

Functions in Lua are first-class values: they may be created anonymously, passed as arguments, assigned to variables, and so on.

 

Functions are created using the <code>function</code> keyword, and called using parentheses. Syntactic sugar is available for named functions, local functions, and functions that act like member functions to a table. See [[#Function declarations|Function declarations]] and [[#Function calls|Function calls]] below for details.

 

Lua functions are [[:en:Closure (computer science)|closures]], meaning that they maintain a reference to the scope in which they are declared and can access and manipulate variables in that scope.

 

Like tables, if a function is assigned to a different variable or passed as an argument to another function, it is still the same underlying "function object" that will be called.

 

When converted to a string, the result is "function".

 

 

{{Anchor|userdata}}

The ''userdata'' type is used to hold opaque values for extensions to Lua written in other languages; for example, a userdata might be used to hold a C pointer or struct. To allow for use of Scribunto in hosting environments where custom-compiled code is not allowed, no such extensions are used.

 

{{Anchor|thread}}

The ''thread'' type represents the handles for coroutines, which are not available in Scribunto's sandbox.

 

 

Every table may have an associated table known as a ''metatable''. The fields in the metatable are used by some operators and functions to specify different or fallback behavior for the table. The metatable for a table may be accessed using the [[#getmetatable|getmetatable()]] function, and set with the [[#setmetatable|setmetatable()]] function.

 

When being accessed for their meta functions, metatable fields are accessed as if with [[#rawget|rawget()]].

 

Metatable fields that affect the table itself are:

; __index : This is used when a table access <code>t[key]</code> would return nil. If the value of this field is a table, the access will be repeated in that table, i.e. <code>__index[key]</code> (which may invoke that table's metatable's __index). If the value of this field is a function, the function will be called as <code style="white-space:nowrap">__index( t, key )</code>. The [[#rawget|rawget()]] function bypasses this metamethod.

; {{Anchor|weak tables}}__mode : This is used to make tables holding weak references. The value must be a string. By default, any value that is used as a key or as a value in a table will not be garbage collected. But if this metafield contains the letter 'k', keys may be garbage collected if there are no non-weak references, and if it contains 'v' values may be; in either case, both the corresponding key and value are removed from the table. Note that behavior is undefined if this field is altered after the table is used as a metatable.

 

Other metatable fields include:

<div style="margin:0 1.6em; column-width: 10em; -moz-column-width: 10em; -webkit-column-width: 10em">

</div>

 

Note: In Lua, all strings also share a single metatable, in which __index refers to the [[#String library|<code>string</code>]] table. This metatable is not accessible in Scribunto, nor is the referenced <code>string</code> table; the string table available to modules is a copy.

 

 

Variables are places that store values. There are three kinds of variables in Lua: global variables, local variables, and table fields.

 

A [[#name|name]] represents a global or local variable (or a function argument, which is just a kind of local variable). Variables are assumed to be global unless explicitly declared as local using the <code>local</code> keyword. Any variable that has not been assigned a value is considered to have a nil value.

 

Global variables are stored in a standard Lua table called an ''environment''; this table is often available as the global variable <code>_G</code>. It is possible to set a metatable for this global variable table; the __index and __newindex metamethods will be called for accesses of and assignments to global variables just as they would for accesses of and assignments to fields in any other table.

 

The environment for a function may be accessed using the [[#getfenv|getfenv()]] function and changed using the [[#setfenv|setfenv()]] function; in Scribunto, these functions are severely restricted if they are available at all.

 

Local variables are lexically scoped; see [[#Local variable declarations|Local variable declarations]] for details.

 

 

An ''expression'' is something that has values: literals (numbers, strings, true, false, nil), anonymous function declarations, table constructors, variable references, function calls, the [[#varargs|vararg expression]], expressions wrapped in parentheses, unary operators applied to expressions, and expressions combined with binary operators.

 

Most expressions have one value; function calls and the vararg expression can have any number. Note that wrapping a function call or vararg expression in parentheses will lose all except the first value.

 

{{Anchor|expression-list|exp-list}}

Expression lists are comma-separated lists of expressions. All except the last expression are forced to one value (dropping additional values, or using nil if the expression has no values); all values from the last expression are included in the values of the expression list.

 

 

Lua supports the usual arithmetic operators: addition, subtraction, multiplication, division, modulo, exponentiation, and negation.

 

When all operands are numbers or strings for which [[#tonumber|tonumber()]] returns non-nil, the operations have their usual meaning.

 

If either operand is a table with an appropriate [[#Metatables|metamethod]], the metamethod will be called.

 

{| class="wikitable" style="text-align:center"

|-

|}

 

 

The relational operators in Lua are <code>==</code>, <code>~=</code>, <code><</code>, <code>></code>, <code><=</code>, and <code>>=</code>. The result of a relational operator is always a boolean.

 

Equality (<code>==</code>) first compares the types of its operands; if they are different, the result is false. Then it compares the values: nil, boolean, number, and string are compared in the expected manner. Functions are equal if they refer to the exact same function object; <code style="white-space:nowrap">function() end == function() end</code> will return false, as it is comparing two different anonymous functions. Tables are by default compared in the same manner, but this may be changed using the __eq [[#Metatables|metamethod]].

 

Inequality (<code>~=</code>) is the exact negation of equality.

 

For the ordering operators, if both are numbers or both are strings, they are compared directly. Next, metamethods are checked:

* <code style="white-space:nowrap">a < b</code> uses <code>__lt</code>

If the necessary metamethods are not available, an error is raised.

 

 

The logical operators are <code>and</code>, <code>or</code>, and <code>not</code>. All use the standard interpretation where nil and false are considered false and anything else is considered true.

 

For <code>and</code>, if the left operand is considered false then it is returned and the second operand is not evaluated; otherwise the second operand is returned.

 

For <code>or</code>, if the left operand is considered true then it is returned and the second operand is not evaluated; otherwise the second operand is returned.

 

For <code>not</code>, the result is always true or false.

 

Note that <code>and</code> and <code>or</code> short circuit. For example, <code style="white-space:nowrap">foo() or bar()</code> will only call <code>bar()</code> if <code>foo()</code> returns false or nil as its first value.

 

 

The concatenation operator is two dots, used as <code style="white-space:nowrap">a .. b</code>. If both operands are numbers or strings, they are converted to strings and concatenated. Otherwise if a __concat [[#Metatables|metamethod]] is available, it is used. Otherwise, an error is raised.

 

Note that Lua strings are immutable and Lua does not provide any sort of "string builder", so a loop that repeatedly does <code style="white-space:nowrap">a = a .. b</code> will have to create a new string for each iteration and eventually garbage-collect the old strings. If many strings need concatenating, it may be faster to use [[#string.format|string.format()]] or to insert all the strings into a [[#sequence|sequence]] and use [[#table.concat|table.concat()]] at the end.

 

 

The length operator is <code>#</code>, used as <code>#a</code>. If <code>a</code> is a string, it returns the length in bytes. If <code>a</code> is a [[#sequence|sequence]] table, it returns the length of the sequence.

 

If <code>a</code> is a table that is ''not'' a sequence, the <code>#a</code> may return any value N such that a[N] is not nil and a[N+1] is nil, even if there are non-nil values at higher indexes. For example,

 

<syntaxhighlight lang="lua">

-- This is not a sequence, because a[3] is nil and a[4] is not

a = { 1, 2, nil, 4 }

 

-- This may output either 2 or 4.

-- And this may change even if the table is not modified.

</syntaxhighlight>

 

 

Lua's [[:en:operator precedence|operator precedence]], from highest to lowest:

 

* ^

* not # - (negation)

* or

 

Within a precedence level, most binary operators are left-associative, i.e. <code style="white-space:nowrap">a + b + c</code> is interpreted as <code style="white-space:nowrap">(a + b) + c</code>. Exponentiation and concatenation are right-associative, i.e. <code style="white-space:nowrap">a ^ b ^ c</code> is interpreted as <code style="white-space:nowrap">a ^ (b ^ c)</code>.

 

 

Lua function calls look like those in most other languages: a name followed by a list of arguments in parentheses:

 

 

As is usual with expression lists in Lua, the last expression in the list may supply multiple argument values.

 

If the function is called with fewer values in the expression list than there are arguments in the function definition, the extra arguments will have a nil value. If the expression list contains more values than there are arguments, the excess values are discarded. It is also possible for a function to take a variable number of arguments; see [[#Function declarations|Function declarations]] for details.

 

Lua also allows direct calling of a function return value, i.e. <code>func()()</code>. If an expression more complex than a variable access is needed to determine the function to be called, a parenthesized expression may be used in place of the variable access.

 

Lua has [[:en:syntactic sugar|syntactic sugar]] for two common cases. The first is when a table is being used as an object, and the function is to be called as a method on the object. The syntax

 

 

is exactly equivalent to

 

 

{{Anchor|named arguments}}

The second common case is Lua's method of implementing ''named arguments'' by passing a table containing the name-to-value mappings as the only positional argument to the function. In this case, the parentheses around the argument list may be omitted. This also works if the function is to be passed a single literal string. For example, the calls

 

func"string"

 

are equivalent to

 

func( "string" )

 

These may be combined; the following calls are equivalent:

 

table.name( table, { arg1 = ''exp'', arg2 = ''exp'' } )

 

 

The syntax for function declaration looks like this:

 

''block''

end

 

All variables in ''var-list'' are local to the function, with values assigned from the expression list in the [[#Function calls|function call]]. Additional local variables may be declared inside the block.

 

When the function is called, the statements in ''block'' are executed after local variables corresponding to ''var-list'' are created and assigned values. If a [[#return|return statement]] is reached, the block is exited and the values of the function call expression are those given by the return statement. If execution reaches the end of the function's block without encountering a return statement, the result of the function call expression has zero values.

 

Lua functions are [[:en:Closure (computer science)|lexical closures]]. A common idiom is to declare "private static" variables as locals in the scope where the function is declared. For example,

 

function makeAdder( n )

return function( x )

-- prints 11

 

{{Anchor|varargs}}

A function may be declared to accept a variable number of arguments, by specifying <code>...</code> as the final item in the ''var-list'':

 

''[[#block|block]]''

end

 

Within the block, the varargs expression <code>...</code> may be used, with the result being all the extra values in the function call. For example,

 

-- get the extra arguments as a table

local args = { ... }

-- returns the string "foo, bar, baz"

 

The [[#select|select()]] function is designed to work with the varargs expression; in particular, <code style="white-space:nowrap">select( '#', ... )</code> should be used instead of <code style="white-space:nowrap">#{ ... }</code> to count the number of values in the varargs expression.

 

 

Lua provides [[:en:syntactic sugar|syntactic sugar]] to combine function declaration and assignment to a variable; see [[#Function declaration statements|Function declaration statements]] for details.

 

Note that this will not work:

<pre style="background-color:#fcc">

Since the function declaration is processed before the local variable assignment statement is complete, "factorial" inside the function body refers to the (probably undefined) variable of that name in an outer scope. This problem may be avoided by declaring the local variable first and then assigning it in a subsequent statement, or by using the [[#Function declaration statements|function declaration statement]] syntax.

 

 

A ''statement'' is the basic unit of execution: one assignment, control structure, function call, variable declaration, etc.

 

{{Anchor|chunk}}

A ''chunk'' is a sequence of statements, optionally separated by semicolons. A chunk is basically considered the body of an anonymous function, so it can declare local variables, receive arguments, and return values.

 

{{Anchor|block}}

A ''block'' is also a sequence of statements, just like a chunk. A block can be delimited to create a single statement: <code style="white-space:nowrap">do ''block'' end</code>. These may be used to limit the scope of local variables, or to add a <code>return</code> or <code>break</code> in the middle of another block.

 

 

<code style="white-space:nowrap">''variable-list'' = [[#expression-list|''expression-list'']]</code>

 

The ''variable-list'' is a comma-separated list of variables; the ''expression-list'' is a comma-separated list of one or more expressions. All expressions are evaluated before any assignments are performed, so <code style="white-space:nowrap">a, b = b, a</code> will swap the values of <var>a</var> and <var>b</var>.

 

 

<code style="white-space:nowrap">local ''variable-list''</code>

 

<code style="white-space:nowrap">local ''variable-list'' = [[#expression-list|''expression-list'']]</code>

 

Local variables may be declared anywhere within a [[#block|block]] or [[#block|chunk]]. The first form, without an expression list, declares the variables but does not assign a value so all variables have nil as a value. The second form assigns values to the local variables, as described in [[#Assignments|Assignments]] above.

 

Note that visibility of the local variable begins with the statement after the local variable declaration. So a declaration like <code style="white-space:nowrap">local x = x</code> declares a local variable x and assigns it the value of x from the outer scope. The local variable remains in scope until the end of the innermost block containing the local variable declaration.

 

 

{{Anchor|while}}

<code style="white-space:nowrap">while ''exp'' do ''[[#block|block]]'' end</code>

 

The while statement repeats a block as long as an expression evaluates to a true value.

 

{{Anchor|repeat}}

<code style="white-space:nowrap">repeat ''[[#block|block]]'' until ''exp''</code>

 

The repeat statement repeats a block until an expression evaluates to a true value. Local variables declared inside the block may be accessed in the expression.

 

{{Anchor|for}}

<code style="white-space:nowrap">for ''name'' = ''exp1'', ''exp2'', ''exp3'' do ''[[#block|block]]'' end</code><br>

<code style="white-space:nowrap">for ''name'' = ''exp1'', ''exp2'' do ''[[#block|block]]'' end</code>

 

This first form of the for loop will declare a local variable, and repeat the block for values from ''exp1'' to ''exp2'' adding ''exp3'' on each iteration. Note that ''exp3'' may be omitted entirely, in which case 1 is used, but non-numeric values such as <code>nil</code> and <code>false</code> are an error. All expressions are evaluated once before the loop is started.

 

This form of the for loop is roughly equivalent to

 

local var, limit, step = tonumber( ''exp1'' ), tonumber( ''exp2'' ), tonumber( ''exp3'' )

if not ( var and limit and step ) then error() end

end

 

except that the variables var, limit, and step are not accessible anywhere else. Note that the variable ''name'' is local to the block; to use the value after the loop, it must be copied to a variable declared outside the loop.

 

{{Anchor|iterators}}

<code style="white-space:nowrap">for ''var-list'' in [[#expression-list|''expression-list'']] do ''[[#block|block]]'' end</code>

 

The second form of the for loop works with ''iterator'' functions. As in the first form, the ''expresssion-list'' is evaluated only once before beginning the loop.

 

This form of the for loop is roughly equivalent to

 

local func, static, var = ''expression-list''

while true do

end

 

except that again the variables func, static, and var are not accessible anywhere else. Note that the variables in ''var-list'' are local to the block; to use them after the loop, they must be copied to variables declared outside the loop.

 

Often the ''expression-list'' is a single function call that returns the three values. If the iterator function can be written so it only depends on the parameters passed into it, that would be the most efficient. If not, [http://www.lua.org/pil/7.4.html Programming in Lua] suggests that a closure be preferred to returning a table as the static variable and updating its members on each iteration.

 

{{Anchor|if}}

<code style="white-space:nowrap">if ''exp1'' then ''[[#block|block1]]'' elseif ''exp2'' then ''[[#block|block2]]'' else ''[[#block|block3]]'' end</code>

 

Executes ''block1'' if ''exp1'' returns true, otherwise executes ''block2'' if ''exp2'' returns true, and ''block3'' otherwise. The <code style="white-space:nowrap">else ''block3''</code> portion may be omitted, and the <code style="white-space:nowrap">elseif ''exp2'' then ''block2''</code> portion may be repeated or omitted as necessary.

 

{{Anchor|return}}

<code style="white-space:nowrap">return [[#expression-list|''expression-list'']]</code>

 

The return statement is used to return values from a function or a [[#chunk|chunk]] (which is just a function). The ''expression-list'' is a comma-separated list of zero or more expressions.

 

Lua implements [[:en:tail call|tail calls]]: if ''expression-list'' consists of exactly one expression which is a function call, the current stack frame will be reused for the call to that function. This has implication for functions that deal with the call stack, such as [[#getfenv|<code>getfenv()</code>]] and [[#debug.traceback|<code>debug.traceback()</code>]].

 

The return statement must be the last statement in its [[#block|block]]. If for some reason a return is needed in the middle of a block, an explicit block <code style="white-space:nowrap">do return end</code> may be used.

 

{{Anchor|break}}

<code>break</code>

 

The break statement is used to terminate the execution of a while, repeat, or for loop, skipping to the next statement after the loop.

 

The break statement must be the last statement in its [[#block|block]]. If for some reason a break is needed in the middle of a block, an explicit block <code style="white-space:nowrap">do break end</code> may be used.

 

 

A function call may be used as a statement; in this case, the function is being called only for any side effects it may have (e.g. [[#mw.log|mw.log()]] logs values) and any return values are discarded.

 

 

Lua provides syntactic sugar to make declaring a function and assigning it to a variable more natural. The following pairs of declarations are equivalent

 

function func( ''var-list'' ) ''[[#block|block]]'' end

func = function ( ''var-list'' ) ''[[#block|block]]'' end

 

local function func( ''var-list'' ) ''[[#block|block]]'' end

local func; func = function ( ''var-list'' ) ''[[#block|block]]'' end

 

function table.func( ''var-list'' ) ''[[#block|block]]'' end

table.func = function ( ''var-list'' ) ''[[#block|block]]'' end

 

function table:func( ''var-list'' ) ''[[#block|block]]'' end

table.func = function ( self, ''var-list'' ) ''[[#block|block]]'' end

 

Note the colon notation here parallels the colon notation for function calls, adding an implicit argument named "self" at the beginning of the arguments list.

 

 

Errors may be "thrown" using the [[#error|error()]] and [[#assert|assert()]] functions. To "catch" errors, use [[#pcall|pcall()]] or [[#xpcall|xpcall()]]. Note that certain internal Scribunto errors cannot be caught in Lua code.

 

 

Lua performs automatic memory management. This means that you have to worry neither about allocating memory for new objects nor about freeing it when the objects are no longer needed. Lua manages memory automatically by running a ''garbage collector'' from time to time to collect all dead objects (that is, objects that are no longer accessible from Lua) and objects that are only reachable via [[#weak tables|weak references]]. All memory used by Lua is subject to automatic management: tables, functions, strings, etc.

 

Garbage collection happens automatically, and cannot be configured from within Scribunto.

 

 

The standard Lua libraries provide essential services and performance-critical functions to Lua. Only those portions of the standard libraries that are available in Scribunto are documented here.

 

 

<span id="_G"></span>

 

This variable holds a reference to the current global variable table; the global variable <code>foo</code> may also be accessed as <code>_G.foo</code>. Note, however, that there is nothing special about _G itself; it may be reassigned in the same manner as any other variable:

 

<syntaxhighlight lang="lua">

foo = 1

</syntaxhighlight>

 

The global variable table may be used just like any other table. For example,

 

<syntaxhighlight lang="lua">

-- Call a function whose name is stored in a variable

_G[var]()

 

-- Log the names and stringified values of all global variables

for k, v in pairs( _G ) do

end

 

-- Log the creation of new global variables

setmetatable( _G, {

</syntaxhighlight>

 

<span id="_VERSION"></span>

 

A string containing the running version of Lua, e.g. "Lua 5.1".

 

 

<code style="white-space:nowrap">assert( v, message, ... )</code>

 

If <code>v</code> is nil or false, issues an error. In this case, <code>message</code> is used as the text of the error: if nil (or unspecified), the text is "assertion failed!"; if a string or number, the text is that value; otherwise assert itself will raise an error.

 

If <code>v</code> is any other value, assert returns all arguments including <code>v</code> and <code>message</code>.

 

A somewhat common idiom in Lua is for a function to return a "true" value in normal operation, and on failure return nil or false as the first value and an error message as the second value. Easy error checking can then be implemented by wrapping the call in a call to <code>assert</code>:

 

<syntaxhighlight lang="lua">

-- This doesn't check for errors

local result1, result2, etc = func( ... )

 

-- This works the same, but does check for errors

local result1, result2, etc = assert( func( ... ) )

</syntaxhighlight>

 

 

<code style="white-space:nowrap">error( message, level )</code>

 

Issues an error, with text <code>message</code>.

 

<code>error</code> normally adds some information about the location of the error. If <code>level</code> is 1 or omitted, that information is the location of the call to <code>error</code> itself; 2 uses the location of the call of the function that called error; and so on. Passing 0 omits inclusion of the location information.

 

 

<code style="white-space:nowrap">getfenv( f )</code>

 

Note this function may not be available, depending on <code>allowEnvFuncs</code> in the engine configuration.

 

Returns an ''environment'' (global variable table), as specified by <code>f</code>:

* If 1, nil, or omitted, returns the environment of the function calling <code>getfenv</code>. Often this will be the same as [[#_G|_G]].

* Passing a function returns the environment that will be used when that function is called.

 

The environments used by all standard library functions and Scribunto library functions are protected. Attempting to access these environments using <code>getfenv</code> will return nil instead.

 

 

<code style="white-space:nowrap">getmetatable( table )</code>

 

Returns the [[#Metatables|metatable]] of a [[#table|table]]. Any other type will return nil.

 

If the metatable has a <code>__metatable</code> field, that value will be returned instead of the actual metatable.

 

 

<code style="white-space:nowrap">ipairs( t )</code>

 

Returns three values: an iterator function, the table <code>t</code>, and 0. This is intended for use in the [[#iterators|iterator form of <code>for</code>]]:

 

''block''

end

 

This will iterate over the pairs ( 1, t[1] ), ( 2, t[2] ), and so on, stopping when t[i] would be nil.

 

The standard behavior may be overridden by providing an <code>__ipairs</code> [[#Metatables|metamethod]]. If that metamethod exists, the call to ipairs will return the three values returned by <code style="white-space:nowrap">__ipairs( t )</code> instead.

 

 

<code style="white-space:nowrap">next( table, key )</code>

 

This allows for iterating over the keys in a table. If <code>key</code> is nil or unspecified, returns the "first" key in the table and its value; otherwise, it returns the "next" key and its value. When no more keys are available, returns nil. It is possible to check whether a table is empty using the expression <code style="white-space:nowrap">next( t ) == nil</code>.

 

Note that the order in which the keys are returned is not specified, even for tables with numeric indexes. To traverse a table in numerical order, use a [[#for|numerical for]] or [[#ipairs|ipairs]].

 

Behavior is undefined if, when using next for traversal, any non-existing key is assigned a value. Assigning a new value (including nil) to an existing field is allowed.

 

 

<code style="white-space:nowrap">pairs( t )</code>

 

Returns three values: an iterator function ([[#next|next]] or a work-alike), the table <code>t</code>, and nil. This is intended for use in the [[#iterators|iterator form of <code>for</code>]]:

 

<syntaxhighlight lang="lua">

for k, v in pairs( t ) do

</syntaxhighlight>

 

This will iterate over the key-value pairs in <code>t</code> just as [[#next|next]] would; see the documentation for [[#next|next]] for restrictions on modifying the table during traversal.

 

The standard behavior may be overridden by providing a __pairs [[#Metatables|metamethod]]. If that metamethod exists, the call to pairs will return the three values returned by <code style="white-space:nowrap">__pairs( t )</code> instead.

 

 

<code style="white-space:nowrap">pcall( f, ... )</code>

 

Calls the function <code>f</code> with the given arguments in ''protected mode''. This means that if an error is raised during the call to <code>f</code>, pcall will return false and the error message raised. If no error occurs, pcall will return true and all values returned by the call.

 

In [[:en:pseudocode|pseudocode]], <code>pcall</code> might be defined something like this:

 

<syntaxhighlight lang="lua">

function pcall( f, ... )

</syntaxhighlight>

 

 

<code style="white-space:nowrap">rawequal( a, b )</code>

 

This is equivalent to <code style="white-space:nowrap">a == b</code> except that it ignores any __eq [[#Metatables|metamethod]].

 

 

<code style="white-space:nowrap">rawget( table, k )</code>

 

This is equivalent to <code>table[k]</code> except that it ignores any __index [[#Metatables|metamethod]].

 

 

<code style="white-space:nowrap">rawset( table, k, v )</code>

 

This is equivalent to <code style="white-space:nowrap">table[k] = v</code> except that it ignores any __newindex [[#Metatables|metamethod]].

 

 

<code style="white-space:nowrap">select( index, ... )</code>

 

If <code>index</code> is a number, returns all arguments in <code>...</code> after that index. If <code>index</code> is the string '#', returns the count of arguments in <code>...</code>.

 

In other words, <code>select</code> is something roughly like the following except that it will work correctly even when <code>...</code> contains nil values (see documentation for [[#Length operator|#]] and [[#unpack|unpack]] for the problem with nils).

 

<syntaxhighlight lang="lua">

function select( index, ... )

</syntaxhighlight>

 

 

<code style="white-space:nowrap">setmetatable( table, metatable )</code>

 

Sets the [[#Metatables|metatable]] of a [[#table|table]]. <code>metatable</code> may be nil, but must be explicitly provided.

 

If the current metatable has a __metatable field, <code>setmetatable</code> will throw an error.

 

 

<code style="white-space:nowrap">tonumber( value, base )</code>

 

Tries to convert <code>value</code> to a number. If it is already a number or a string convertible to a number, then <code>tonumber</code> returns this number; otherwise, it returns nil.

 

The optional <code>base</code> (default 10) specifies the base to interpret the numeral. The base may be any integer between 2 and 36, inclusive. In bases above 10, the letter 'A' (in either upper or lower case) represents 10, 'B' represents 11, and so forth, with 'Z' representing 35.

 

In base 10, the value may have a decimal part, be expressed in [[:en:E notation|E notation]], and may have a leading "0x" to indicate base 16. In other bases, only unsigned integers are accepted.

 

 

<code style="white-space:nowrap">tostring( value )</code>

 

Converts <code>value</code> to a string. See [[#Data types|Data types]] above for details on how each type is converted.

 

The standard behavior for tables may be overridden by providing a __tostring [[#Metatables|metamethod]]. If that metamethod exists, the call to tostring will return the single value returned by <code style="white-space:nowrap">__tostring( value )</code> instead.

 

 

<code style="white-space:nowrap">type( value )</code>

 

Returns the type of <code>value</code> as a string: "[[#nil|nil]]", "[[#number|number]]", "[[#string|string]]", "[[#boolean|boolean]]", "[[#table|table]]", or "[[#function|function]]".

 

 

<code style="white-space:nowrap">unpack( table, i, j )</code>

 

Returns values from the given table, something like <code style="white-space:nowrap">table[i], table[i+1], ···, table[j]</code> would do if written out manually. If nil or not given, <code>i</code> defaults to 1 and <code>j</code> defaults to <code style="white-space:nowrap">[[#Length operator|#]]table</code>.

 

Note that results are not deterministic if <code>table</code> is not a [[#sequence|sequence]] and <code>j</code> is nil or unspecified; see [[#Length operator|Length operator]] for details.

 

 

<code style="white-space:nowrap">xpcall( f, errhandler )</code>

 

This is much like [[#pcall|<code>pcall</code>]], except that the error message is passed to the function <code>errhandler</code> before being returned.

 

In [[:en:pseudocode|pseudocode]], <code>xpcall</code> might be defined something like this:

 

<syntaxhighlight lang="lua">

function xpcall( f, errhandler )

</syntaxhighlight>

 

 

 

<code style="white-space:nowrap">debug.traceback( message, level )</code>

 

Returns a string with a traceback of the call stack. An optional message string is appended at the beginning of the traceback. An optional level number tells at which stack level to start the traceback.

 

 

 

<code style="white-space:nowrap">math.abs( x )</code>

 

Returns the absolute value of <code>x</code>.

 

 

<code style="white-space:nowrap">math.acos( x )</code>

 

Returns the arc cosine of <code>x</code> (given in radians).

 

 

<code style="white-space:nowrap">math.asin( x )</code>

 

Returns the arc sine of <code>x</code> (given in radians).

 

 

<code style="white-space:nowrap">math.atan( x )</code>

 

Returns the arc tangent of <code>x</code> (given in radians).

 

 

<code style="white-space:nowrap">math.atan2( y, x )</code>

 

Returns the arc tangent of <code>y/x</code> (given in radians), using the signs of both parameters to find the

quadrant of the result.

 

 

<code style="white-space:nowrap">math.ceil( x )</code>

 

Returns the smallest integer larger than or equal to <code>x</code>.

 

 

<code style="white-space:nowrap">math.cos( x )</code>

 

Returns the cosine of <code>x</code> (given in radians).

 

 

<code style="white-space:nowrap">math.cosh( x )</code>

 

Returns the hyperbolic cosine of <code>x</code>.

 

 

<code style="white-space:nowrap">math.deg( x )</code>

 

Returns the angle <code>x</code> (given in radians) in degrees.

 

 

<code style="white-space:nowrap">math.exp( x )</code>

 

Returns the value <math>e^x</math>.

 

 

<code style="white-space:nowrap">math.floor( x )</code>

 

Returns the largest integer smaller than or equal to <code>x</code>.

 

 

<code style="white-space:nowrap">math.fmod( x, y )</code>

 

Returns the remainder of the division of <code>x</code> by <code>y</code> that rounds the quotient towards zero.

 

 

<code style="white-space:nowrap">math.frexp( x )</code>

 

Returns two values <code>m</code> and <code>e</code> such that:

* If <code>x</code> is finite and non-zero: <math>x = m \times 2^e</math>, <code>e</code> is an integer, and the absolute value of <code>m</code> is in the range <math>[0.5, 1)</math>

* If <code>x</code> is NaN or infinite: <code>m</code> is <code>x</code> and <code>e</code> is not specified

 

 

The value representing positive infinity; larger than or equal to any other numerical value.

 

 

<code style="white-space:nowrap">math.ldexp( m, e )</code>

 

Returns <math>m \times 2^e</math> (<code>e</code> should be an integer).

 

 

<code style="white-space:nowrap">math.log( x )</code>

 

Returns the natural logarithm of <code>x</code>.

 

 

<code style="white-space:nowrap">math.log10( x )</code>

 

Returns the base-10 logarithm of <code>x</code>.

 

 

<code style="white-space:nowrap">math.max( x, ... )</code>

 

Returns the maximum value among its arguments.

 

Behavior with NaNs is not specified. With the current implementation, NaN will be returned if <code>x</code> is NaN, but any other NaNs will be ignored.

 

 

<code style="white-space:nowrap">math.min( x, ... )</code>

 

Returns the minimum value among its arguments.

 

Behavior with NaNs is not specified. With the current implementation, NaN will be returned if <code>x</code> is NaN, but any other NaNs will be ignored.

 

 

<code style="white-space:nowrap">math.modf( x )</code>

 

Returns two numbers, the integral part of <code>x</code> and the fractional part of <code>x</code>.

 

 

The value of <math>\pi</math>.

 

 

<code style="white-space:nowrap">math.pow( x, y )</code>

 

Equivalent to <code>x^y</code>.

 

 

<code style="white-space:nowrap">math.rad( x )</code>

 

Returns the angle <code>x</code> (given in degrees) in radians.

 

 

<code style="white-space:nowrap">math.random( m, n )</code>

 

Returns a pseudo-random number.

 

The arguments <code>m</code> and <code>n</code> may be omitted, but if specified must be convertible to integers.

* With no arguments, returns a real number in the range <math>[0,1)</math>

* With two arguments, returns an integer in the range <math>[m,n]</math>

 

 

<code style="white-space:nowrap">math.randomseed( x )</code>

 

Sets <code>x</code> as the [[:en:Random seed|seed]] for the pseudo-random generator.

 

Note that using the same seed will cause <code>math.random</code> to output the same sequence of numbers.

 

 

<code style="white-space:nowrap">math.sin( x )</code>

 

Returns the sine of <code>x</code> (given in radians).

 

 

<code style="white-space:nowrap">math.sinh( x )</code>

 

Returns the hyperbolic sine of <code>x</code>.

 

 

<code style="white-space:nowrap">math.sqrt( x )</code>

 

Returns the square root of <code>x</code>. Equivalent to <code>x^0.5</code>.

 

 

<code style="white-space:nowrap">math.tan( x )</code>

 

Returns the tangent of <code>x</code> (given in radians).

 

 

<code style="white-space:nowrap">math.tanh( x )</code>

 

Returns the hyperbolic tangent of <code>x</code>.

 

 

 

<code>os.clock()</code>

 

Returns an approximation of the amount in seconds of CPU time used by the program.

 

 

<code style="white-space:nowrap">os.date( format, time )</code>

 

: ''[[#mw.language:formatDate|Language library's formatDate]] may be used for more comprehensive date formatting''

 

Returns a string or a table containing date and time, formatted according to <code>format</code>. If the format is omitted or nil, "%c" is used.

 

If <code>time</code> is given, it is the time to be formatted (see <code>[[#os.time|os.time()]]</code>). Otherwise the current time is used.

 

If <code>format</code> starts with '!', then the date is formatted in UTC rather than the server's local time. After this optional character, if format is the string "*t", then date returns a table with the following fields:

* year (full)

* isdst (daylight saving flag, a boolean; may be absent if the information is not available)

 

If format is not "*t", then date returns the date as a string, formatted according to the same rules as the C function [http://man7.org/linux/man-pages/man3/strftime.3.html strftime].

 

 

<code style="white-space:nowrap">os.difftime( t2, t1 )</code>

 

Returns the number of seconds from <code>t1</code> to <code>t2</code>.

 

 

<code style="white-space:nowrap">os.time( table )</code>

 

Returns a number representing the current time.

 

When called without arguments, returns the current time. If passed a table, the time encoded in the table will be parsed. The table must have the fields "year", "month", and "day", and may also include "hour" (default 12), "min" (default 0), "sec" (default 0), and "isdst".

 

 

 

<code style="white-space:nowrap">require( modulename )</code>

 

Loads the specified module.

 

First, it looks in <code>package.loaded[modulename]</code> to see if the module is already loaded. If so, returns <code>package.loaded[modulename]</code>.

 

Otherwise, it calls each loader in the <code>package.loaders</code> sequence to attempt to find a loader for the module. If a loader is found, that loader is called. The value returned by the loader is stored into <code>package.loaded[modulename]</code> and is returned.

 

See the documentation for [[#package.loaders|<code>package.loaders</code>]] for information on the loaders available.

 

Note that every required module is loaded in its own sandboxed environment, so it cannot export global variables as is sometimes done in Lua 5.1. Instead, everything that the module wishes to export should be included in the table returned by the module.

 

 

For example, if you have a module "Module:Giving" containing the following:

 

<syntaxhighlight lang="lua">

local p = {}

 

p.someDataValue = 'Hello!'

 

return p

</syntaxhighlight>

 

You can load this in another module with code such as this:

 

<syntaxhighlight lang="lua">

local giving = require( "Module:Giving" )

 

local value = giving.someDataValue -- value is now 'Hello!'

</syntaxhighlight>

 

 

This table holds the loaded modules. The keys are the module names, and the values are the values returned when the module was loaded.

 

 

This table holds the sequence of searcher functions to use when loading modules. Each searcher function is called with a single argument, the name of the module to load. If the module is found, the searcher must return a function that will actually load the module and return the value to be returned by [[#require|require]]. Otherwise, it must return nil.

 

Scribunto provides two searchers:

# Look in <code>package.preload[modulename]</code> for the loader function

# Look in the [[#Loadable libraries|modules provided with Scribunto]] for the module name, and if that fails look in the Module: namespace. The "Module:" prefix must be provided.

 

Note that the standard Lua loaders are '''not''' included.

 

 

This table holds loader functions, used by the first searcher Scribunto includes in [[#package.loaders|package.loaders]].

 

 

<code style="white-space:nowrap">package.seeall( table )</code>

 

Sets the __index [[#Metatables|metamethod]] for <code>table</code> to [[#_G|_G]].

 

 

In all string functions, the first character is at position&nbsp;1, not position&nbsp;0 as in C, PHP, and JavaScript. Indexes may be negative, in which case they count from the end of the string: position&nbsp;-1 is the last character in the string, -2 is the second-last, and so on.

 

{{red|Warning:}} The string library assumes one-byte character encodings. '''It cannot handle Unicode characters'''. To operate on Unicode strings, use the corresponding methods in the [[#Ustring library|Scribunto Ustring library]].

 

 

<code style="white-space:nowrap">string.byte( s, i, j )</code>

 

If the string is considered as an array of bytes, returns the byte values for <code>s[i]</code>, <code>s[i+1]</code>, ···, <code>s[j]</code>.

The default value for <code>i</code> is&nbsp;1;

Identical to [[#mw.ustring.byte|mw.ustring.byte()]].

 

 

<code style="white-space:nowrap">string.char( ... )</code>

 

Receives zero or more integers. Returns a string with length equal to the number of arguments, in which each character has the byte value equal to its corresponding argument. See [[#mw.ustring.char|mw.ustring.char()]] for a similar function that uses Unicode codepoints rather than byte values.

 

 

<code style="white-space:nowrap">string.find( s, pattern, init, plain )</code>

 

Looks for the first match of [[#Patterns|<code>pattern</code>]] in the string <code>s</code>. If it finds a match, then <code>find</code> returns the offsets in&nbsp;<code>s</code> where this occurrence starts and ends; otherwise, it returns nil. If the pattern has captures, then in a successful match the captured values are also returned after the two indices.

 

A third, optional numerical argument <code>init</code> specifies where to start the search; its default value is&nbsp;1 and can be negative. A value of true as a fourth, optional argument <code>plain</code> turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in <code>pattern</code> being considered "magic".

 

Note that if <code>plain</code> is given, then <code>init</code> must be given as well.

 

See [[#mw.ustring.find|mw.ustring.find()]] for a similar function extended as described in [[#Ustring patterns|Ustring patterns]] and where the <code>init</code> offset is in characters rather than bytes.

 

 

<code style="white-space:nowrap">string.format( formatstring, ... )</code>

 

Returns a formatted version of its variable number of arguments following the description given in its first argument (which must be a string).

 

The format string uses a limited subset of the [http://pubs.opengroup.org/onlinepubs/9699919799/functions/printf.html <code>printf</code> format specifiers]:

* Recognized flags are '-', '+', ' ', '#', and '0'.

* Positional specifiers (e.g. "%2$s") are not supported.

 

The conversion specifier 'q' is like 's', but formats the string in a form suitable to be safely read back by the Lua interpreter: the string is written between double quotes, and all double quotes, newlines, embedded zeros, and backslashes in the string are correctly escaped when written.

 

Conversion between strings and numbers is performed as specified in [[#Data types|Data types]]; other types are not automatically converted to strings. Strings containing NUL characters (byte value 0) are not properly handled.

 

Identical to [[#mw.ustring.format|mw.ustring.format()]].

 

 

<code style="white-space:nowrap">string.gmatch( s, pattern )</code>

 

Returns an iterator function that, each time it is called, returns the next captures from [[#Patterns|<code>pattern</code>]] over string <code>s</code>. If <code>pattern</code> specifies no captures, then the whole match is produced in each call.

 

For this function, a '<code>^</code>' at the start of a pattern is not magic, as this would prevent the iteration. It is treated as a literal character.

 

See [[#mw.ustring.gmatch|mw.ustring.gmatch()]] for a similar function for which the pattern is extended as described in [[#Ustring patterns|Ustring patterns]].

 

 

<code style="white-space:nowrap">string.gsub( s, pattern, repl, n )</code>

 

Returns a copy of <code>s</code> in which all (or the first <code>n</code>, if given) occurrences of the [[#Patterns|<code>pattern</code>]] have been replaced by a replacement string specified by <code>repl</code>, which can be a string, a table, or a function. <code>gsub</code> also returns, as its second value, the total number of matches that occurred.

 

If <code>repl</code> is a string, then its value is used for replacement. The character&nbsp;<code>%</code> works as an escape character: any sequence in <code>repl</code> of the form <code>%''n''</code>,

with ''n'' between 1 and 9, stands for the value of the ''n''-th captured substring. The sequence <code>%0</code> stands for the whole match, and the sequence <code>%%</code> stands for a single&nbsp;<code>%</code>.

 

If <code>repl</code> is a table, then the table is queried for every match, using the first capture as the key; if the pattern specifies no captures, then the whole match is used as the key.

 

If <code>repl</code> is a function, then this function is called every time a match occurs, with all captured substrings passed as arguments, in order; if the pattern specifies no captures, then the whole match is passed as a sole argument.

 

If the value returned by the table query or by the function call is a string or a number, then it is used as the replacement string; otherwise, if it is false or nil, then there is no replacement (that is, the original match is kept in the string).

 

See [[#mw.ustring.gsub|mw.ustring.gsub()]] for a similar function in which the pattern is extended as described in [[#Ustring patterns|Ustring patterns]].

 

 

<code style="white-space:nowrap">string.len( s )</code>

 

Returns the length of the string, in bytes. Is not confused by ASCII NUL characters. Equivalent to <code style="white-space:nowrap">[[#Length operator|#]]s</code>.

 

See [[#mw.ustring.len|mw.ustring.len()]] for a similar function using Unicode codepoints rather than bytes.

 

 

<code style="white-space:nowrap">string.lower( s )</code>

 

Returns a copy of this string with all ASCII uppercase letters changed to lowercase. All other characters are left unchanged.

 

See [[#mw.ustring.lower|mw.ustring.lower()]] for a similar function in which all characters with uppercase to lowercase definitions in Unicode are converted.

 

 

<code style="white-space:nowrap">string.match( s, pattern, init )</code>

 

Looks for the first match of [[#Patterns|<code>pattern</code>]] in the string. If it finds one, then <code>match</code> returns the captures from the pattern; otherwise it returns nil. If <code>pattern</code> specifies no captures, then the whole match is returned.

 

A third, optional numerical argument <code>init</code> specifies where to start the search; its default value is&nbsp;1 and can be negative.

 

See [[#mw.ustring.match|mw.ustring.match()]] for a similar function in which the pattern is extended as described in [[#Ustring patterns|Ustring patterns]] and the <code>init</code> offset is in characters rather than bytes.

 

 

<code style="white-space:nowrap">string.rep( s, n )</code>

 

Returns a string that is the concatenation of <code>n</code> copies of the string <code>s</code>. Identical to [[#mw.ustring.rep|mw.ustring.rep()]].

 

 

<code style="white-space:nowrap">string.reverse( s )</code>

 

Returns a string that is the string <code>s</code> reversed (bytewise).

 

 

<code style="white-space:nowrap">string.sub( s, i, j )</code>

 

Returns the substring of <code>s</code> that starts at <code>i</code> and continues until <code>j</code>; <code>i</code> and <code>j</code> can be negative. If <code>j</code> is nil or omitted, -1 is used.

 

In particular, the call <code>string.sub(s,1,j)</code> returns a prefix of <code>s</code> with length <code>j</code>, and <code style="white-space:nowrap">string.sub(s, -i)</code> returns a suffix of <code>s</code> with length <code>i</code>.

 

See [[#mw.ustring.sub|mw.ustring.sub()]] for a similar function in which the offsets are characters rather than bytes.

 

 

<code style="white-space:nowrap">string.upper( s )</code>

 

Returns a copy of this string with all ASCII lowercase letters changed to uppercase. All other characters are left unchanged.

 

See [[#mw.ustring.upper|mw.ustring.upper()]] for a similar function in which all characters with lowercase to uppercase definitions in Unicode are converted.

 

 

Note that Lua's patterns are similar to [[:en:regular expression|regular expressions]], but are not identical. In particular, note the following differences from regular expressions and [[:en:PCRE|PCRE]]:

* The quoting character is percent (<code>%</code>), not backslash (<code>\</code>).

** For example, in PCRE the regexp <code>\x65</code> (from a string literal such as <code>"\\x65"</code>) will match the string "hello", because the PCRE engine interprets escaped characters. But in Lua the equivalent pattern <code>\101</code> (from a string literal such as <code>"\\101"</code>) will not match "hello". -->

 

Also note that a pattern cannot contain embedded zero bytes (ASCII NUL, <code>"\0"</code>). Use <code>%z</code> instead.

 

Also see [[#Ustring patterns|Ustring patterns]] for a similar pattern-matching scheme using Unicode characters.

 

 

A ''character class'' is used to represent a set of characters. The following combinations are allowed in describing a character class:

 

* '''''x''''': (where ''x'' is not one of the magic characters <code>^$()%.[]*+-?</code>) represents the character ''x'' itself.

* '''<code>.</code>''': (a dot) represents all characters.

* '''<code>[^''set'']</code>''': represents the complement of ''set'', where ''set'' is interpreted as above.

 

 

A ''pattern item'' can be

 

* a single character class, which matches any single character in the class;

* a single character class followed by '<code>*</code>', which matches 0 or more repetitions of characters in the class. These repetition items will always match the longest possible sequence;

* <code>%f[''set'']</code>, a ''frontier pattern''; such item matches an empty string at any position such that the next character belongs to ''set'' and the previous character does not belong to ''set''. The set ''set'' is interpreted as previously described. The beginning and the end of the subject are handled as if they were the character&nbsp;'\0'.<br><small>Note that frontier patterns were present but undocumented in Lua&nbsp;5.1, and officially added to Lua in 5.2. The implementation in Lua&nbsp;5.2.1 is unchanged from that in 5.1.0.</small>

 

 

A ''pattern'' is a sequence of pattern items.

 

A '<code>^</code>' at the beginning of a pattern anchors the match at the

beginning of the subject string. A '<code>$</code>' at the end of a pattern anchors the match at the

end of the subject string. At other positions, '<code>^</code>' and '<code>$</code>' have no special meaning and represent themselves.

 

 

A pattern can contain sub-patterns enclosed in parentheses; they describe ''captures''. When a match succeeds, the substrings of the subject string that match captures are stored ("captured") for future use. Captures are numbered according to their left parentheses. For instance, in the pattern <code>(a*(.)%w(%s*))</code>, the part of the string matching <code>a*(.)%w(%s*)</code> is stored as the first capture (and therefore has number&nbsp;1); the character matching <code>.</code> is captured with number&nbsp;2, and the part matching <code>%s*</code> has number&nbsp;3.

 

Capture references can appear in the pattern string itself, and refer back to text that was captured earlier in the match. For example, <code>([a-z])%1</code> will match any pair of identical lowercase letters, while <code>([a-z])([a-z])([a-z])[a-z]%3%2%1</code> will match any 7-letter [[w:Palindrome|palindrome]].

 

As a special case, the empty capture <code>()</code> captures the current string position (a number). For instance, if we apply the pattern <code>"()aa()"</code> on the string <code>"flaaap"</code>, there will be two captures: 3&nbsp;and&nbsp;5.

 

 

Most functions in the table library assume that the table represents a [[#sequence|sequence]].

 

The functions <code>table.foreach()</code>, <code>table.foreachi()</code>, and <code>table.getn()</code> may be available but are deprecated. Use a for loop with [[#pairs|pairs()]], a for loop with [[#ipairs|ipairs()]], and the length operator instead.

 

 

<code style="white-space:nowrap">table.concat( table, sep, i, j )</code>

 

Given an array where all elements are strings or numbers, returns <code style="white-space:nowrap">table[i] .. sep .. table[i+1] ··· sep .. table[j]</code>.

 

The default value for <code>sep</code> is the empty string, the default for <code>i</code> is 1, and the default for <code>j</code> is the length of the table. If <code>i</code> is greater than <code>j</code>, returns the empty string.

 

 

<code style="white-space:nowrap">table.insert( table, value )</code><br>

<code style="white-space:nowrap">table.insert( table, pos, value )</code>

 

Inserts element <code>value</code> at position <code>pos</code> in <code>table</code>, shifting up other elements to open space, if necessary. The default value for <code>pos</code> is the length of the table plus 1, so that a call <code style="white-space:nowrap">table.insert(t, x)</code> inserts <code>x</code> at the end of table <code>t</code>.

 

Elements up to <code>#table</code> are shifted; see [[#Length operator|Length operator]] for caveats if the table is not a [[#sequence|sequence]].

 

 

<code style="white-space:nowrap">table.maxn( table )</code>

 

Returns the largest positive numerical index of the given table, or zero if the table has no positive numerical indices.

 

To do this, it iterates over the whole table. This is roughly equivalent to

 

<syntaxhighlight lang="lua">

function table.maxn( table )

</syntaxhighlight>

 

 

<code style="white-space:nowrap">table.remove( table, pos )</code>

 

Removes from <code>table</code> the element at position <code>pos</code>,

shifting down other elements to close the space, if necessary. Returns the value of the removed element. The default value for <code>pos</code> is the length of the table, so that a call <code style="white-space:nowrap">table.remove( t )</code> removes the last element of table <code>t</code>.

 

Elements up to <code>#table</code> are shifted; see [[#Length operator|Length operator]] for caveats if the table is not a [[#sequence|sequence]].

 

 

<code style="white-space:nowrap">table.sort( table, comp )</code>

 

Sorts table elements in a given order, ''in-place'', from <code>table[1]</code> to <code>table[#table]</code>. If <code>comp</code> is given, then it must be a function that receives two table elements, and returns true when the first is less than the second (so that <code style="white-space:nowrap">not comp(a[i+1],a[i])</code> will be true after the sort). If <code>comp</code> is not given, then the standard Lua operator <code>&lt;</code> is used instead.

 

The sort algorithm is not stable; that is, elements considered equal by the given order may have their relative positions changed by the sort.

 

 

All Scribunto libraries are located in the table <code>mw</code>.

 

 

 

<code style="white-space:nowrap">mw.allToString( ... )</code>

 

Calls [[#tostring|tostring()]] on all arguments, then concatenates them with tabs as separators.

 

 

<code style="white-space:nowrap">mw.clone( value )</code>

 

Creates a deep copy of a value. All tables (and their metatables) are reconstructed from scratch. Functions are still shared, however.

 

 

<code>mw.getCurrentFrame()</code>

 

Returns the current [[#Frame object|frame object]].

 

 

<code>mw.incrementExpensiveFunctionCount()</code>

 

Adds one to the "expensive parser function" count, and throws an exception if it exceeds the limit (see [[Manual:$wgExpensiveParserFunctionLimit|$wgExpensiveParserFunctionLimit]]).

 

 

<code>mw.isSubsting()</code>

 

Returns true if the current <code>#invoke</code> is being [[Manual:Substitution|substed]], false otherwise. See [[#Returning text|Returning text]] above for discussion on differences when substing versus not substing.

 

 

<code style="white-space:nowrap">mw.loadData( module )</code>

 

Sometimes a module needs large tables of data; for example, a general-purpose module to convert units of measure might need a large table of recognized units and their conversion factors. And sometimes these modules will be used many times in one page. Parsing the large data table for every <code><nowiki>{{#invoke:}}</nowiki></code> can use a significant amount of time. To avoid this issue, <code>mw.loadData()</code> is provided.

 

<code>mw.loadData</code> works like <code>[[#require|require()]]</code>, with the following differences:

* The loaded module is evaluated only once per page, rather than once per <code><nowiki>{{#invoke:}}</nowiki></code> call.

* The table actually returned by <code>mw.loadData()</code> has metamethods that provide read-only access to the table returned by the module. Since it does not contain the data directly, <code>[[#pairs|pairs()]]</code> and <code>[[#ipairs|ipairs()]]</code> will work but other methods, including <code>[[#Length operator|#value]]</code>, <code style="white-space:nowrap">[[#next|next()]]</code>, and the functions in the [[#Table library|Table library]], will not work correctly.

 

The hypothetical unit-conversion module mentioned above might store its code in "Module:Convert" and its data in "Module:Convert/data", and "Module:Convert" would use <code style="white-space:nowrap">local data = mw.loadData( 'Module:Convert/data' )</code> to efficiently load the data.

 

 

<code style="white-space:nowrap">mw.dumpObject( object )</code>

 

Serializes <code>object</code> to a human-readable representation, then returns the resulting string.

 

 

{{Anchor|print}}

<code style="white-space:nowrap">mw.log( ... )</code>

 

Passes the arguments to [[#mw.allToString|mw.allToString()]], then appends the resulting string to the log buffer.

 

In the debug console, the function <code>print()</code> is an alias for this function.

 

 

<code style="white-space:nowrap">mw.logObject( object )</code><br>

<code style="white-space:nowrap">mw.logObject( object, prefix )</code>

 

Calls [[#mw.dumpObject|mw.dumpObject()]] and appends the resulting string to the log buffer. If <code>prefix</code> is given, it will be added to the log buffer followed by an equals sign before the serialized string is appended (i.e. the logged text will be "prefix = object-string").

 

 

The frame object is the interface to the parameters passed to <code><nowiki>{{#invoke:}}</nowiki></code>, and to the parser.

 

 

A table for accessing the arguments passed to the frame. For example, if a module is called from wikitext with

 

 

then <code>frame.args[1]</code> will return "arg1", <code>frame.args[2]</code> will return "arg2", and <code>frame.args['name']</code> (or <code>frame.args.name</code>) will return "arg3". It is also possible to iterate over arguments using <code style="white-space:nowrap">pairs( frame.args )</code> or <code style="white-space:nowrap">ipairs( frame.args )</code>.

 

Note that values in this table are always strings; <code>[[#tonumber|tonumber()]]</code> may be used to convert them to numbers, if necessary. Keys, however, are numbers even if explicitly supplied in the invocation: <nowiki>{{#invoke:module|function|1|2=2}}</nowiki> gives string values "1" and "2" indexed by numeric keys 1 and 2.

 

As in MediaWiki template invocations, named arguments will have leading and trailing whitespace removed from both the name and the value before they are passed to Lua, whereas unnamed arguments will not have whitespace stripped.

 

For performance reasons, frame.args uses a metatable, rather than directly containing the arguments. Argument values are requested from MediaWiki on demand. This means that most other table methods will not work correctly, including <code>[[#Length operator|#frame.args]]</code>, <code style="white-space:nowrap">[[#next|next]]( frame.args )</code>, and the functions in the [[#Table library|Table library]].

 

If preprocessor syntax such as template invocations and triple-brace arguments are included within an argument to #invoke, they will be expanded before being passed to Lua. If certain special tags written in XML notation, such as <code>&lt;pre&gt;</code>, <code>&lt;nowiki&gt;</code>, <code>&lt;gallery&gt;</code> and <code>&lt;ref&gt;</code>, are included as arguments to #invoke, then these tags will be converted to "[[strip marker]]s" — special strings which begin with a delete character (ASCII 127), to be replaced with HTML after they are returned from #invoke.

 

 

<code style="white-space:nowrap">frame:callParserFunction( name, args )</code><br>

<code style="white-space:nowrap">frame:callParserFunction( name, ... )</code><br>

<code style="white-space:nowrap">frame:callParserFunction{ name = string, args = table }</code>

 

: ''Note the use of [[#named arguments|named arguments]].''

 

Call a [[Help:Magic words#Parser functions|parser function]], returning an appropriate string. Whenever possible, native Lua functions or Scribunto library functions should be preferred to this interface.

 

The following calls are approximately equivalent to the indicated wikitext:

 

<syntaxhighlight lang="lua">

-- {{ns:0}}

frame:callParserFunction{ name = 'ns', args = 0 }

 

-- {{#tag:nowiki|some text}}

frame:callParserFunction{ name = '#tag', args = { 'nowiki', 'some text' } }

frame:callParserFunction( '#tag:nowiki', 'some text' )

 

-- {{#tag:ref|some text|name=foo|group=bar}}

frame:callParserFunction{ name = '#tag:ref', args = {

</syntaxhighlight>

 

Note that, as with [[#frame:expandTemplate|frame:expandTemplate()]], the function name and arguments are not preprocessed before being passed to the parser function.

 

 

<code style="white-space:nowrap">frame:expandTemplate{ title = title, args = table }</code>

 

: ''Note the use of [[#named arguments|named arguments]].''

 

This is transclusion. The call

 

 

does roughly the same thing from Lua that <code><nowiki>{{template|arg1|arg2|name=arg3}}</nowiki></code> does in wikitext. As in transclusion, if the passed title does not contain a namespace prefix it will be assumed to be in the Template: namespace.

 

Note that the title and arguments are not preprocessed before being passed into the template:

 

<syntaxhighlight lang="lua">

-- This is roughly equivalent to wikitext like

frame:expandTemplate{ title = 'template', args = { '|' } }

 

-- This is roughly equivalent to wikitext like

-- {{template|{{((}}!{{))}}}}

</syntaxhighlight>

 

 

<code style="white-space:nowrap">frame:extensionTag( name, content, args )</code><br>

<code style="white-space:nowrap">frame:extensionTag{ name = string, content = string, args = table_or_string }</code>

 

This is equivalent to a call to [[#frame:callParserFunction|frame:callParserFunction()]] with function name <code style="white-space:nowrap">'#tag:' .. name</code> and with <code>content</code> prepended to <code>args</code>.

 

<syntaxhighlight lang="lua">

-- These are equivalent

frame:extensionTag( 'ref', 'some text', { name = 'foo', group = 'bar' } )

 

frame:callParserFunction{ name = '#tag:ref', args = {

'some text', name = 'foo', group = 'bar'

} }

 

-- These are equivalent

frame:extensionTag{ name = 'ref', content = 'some text', args = 'some other text' }

 

 

 

<code>frame:getParent()</code>

 

Called on the frame created by <code><nowiki>{{#invoke:}}</nowiki></code>, returns the frame for the page that called <code><nowiki>{{#invoke:}}</nowiki></code>. Called on that frame, returns nil.

 

 

<code>frame:getTitle()</code>

 

Returns the title associated with the frame as a string. For the frame created by <code><nowiki>{{#invoke:}}</nowiki></code>, this is the title of the module invoked.

 

 

<code style="white-space:nowrap">frame:newChild{ title = title, args = table }</code>

 

: ''Note the use of [[#named arguments|named arguments]].''

 

Create a new [[#Frame object|Frame object]] that is a child of the current frame, with optional arguments and title.

 

This is mainly intended for use in the debug console for testing functions that would normally be called by <code><nowiki>{{#invoke:}}</nowiki></code>. The number of frames that may be created at any one time is limited.

 

 

<code style="white-space:nowrap">frame:preprocess( string )</code><br>

<code style="white-space:nowrap">frame:preprocess{ text = string }</code>

 

This expands wikitext in the context of the frame, i.e. templates, parser functions, and parameters such as <code><nowiki>{{{1}}}</nowiki></code> are expanded. Certain special tags written in XML-style notation, such as <code>&lt;pre&gt;</code>, <code>&lt;nowiki&gt;</code>, <code>&lt;gallery&gt;</code> and <code>&lt;ref&gt;</code>, will be replaced with "[[strip marker]]s" &mdash; special strings which begin with a delete character (ASCII 127), to be replaced with HTML after they are returned from <code>#invoke</code>.

 

If you are expanding a single template, use [[#frame:expandTemplate|<code>frame:expandTemplate</code>]] instead of trying to construct a wikitext string to pass to this method. It's faster and less prone to error if the arguments contain pipe characters or other wikimarkup.

 

 

<code style="white-space:nowrap">frame:getArgument( arg )</code><br>

<code style="white-space:nowrap">frame:getArgument{ name = arg }</code>

 

Gets an object for the specified argument, or nil if the argument is not provided.

 

The returned object has one method, <code>object:expand()</code>, that returns the expanded wikitext for the argument.

 

 

<code style="white-space:nowrap">frame:newParserValue( text )</code><br>

<code style="white-space:nowrap">frame:newParserValue{ text = text }</code>

 

Returns an object with one method, <code>object:expand()</code>, that returns the result of <code style="white-space:nowrap">[[#frame:preprocess|frame:preprocess]]( text )</code>.

 

 

<code style="white-space:nowrap">frame:newTemplateParserValue{ title = title, args = table }</code>

 

: ''Note the use of [[#named arguments|named arguments]].''

 

Returns an object with one method, <code>object:expand()</code>, that returns the result of <code>[[#frame:expandTemplate|frame:expandTemplate]]</code> called with the given arguments.

 

 

<code>frame:argumentPairs()</code>

 

Same as <code style="white-space:nowrap">pairs( frame.args )</code>. Included for backwards compatibility.

 

 

<code>mw.html</code> is a fluent interface for building complex HTML from Lua. A mw.html object can be created using [[#mw.html.create|<code>mw.html.create</code>]].

 

Functions documented as <code>mw.html.name</code> are available on the global <code>mw.html</code> table; functions documented as <code>mw.html:name</code> are methods of an mw.html object (see [[#mw.html.create|<code>mw.html.create</code>]]).

 

A basic example could look like this:

<source lang="lua">

</source>

 

<code style="white-space:nowrap">mw.html.create( tagName, args )</code><br>

 

Creates a new mw.html object containing a <code>tagName</code> html element. You can also pass an empty string or nil as <code>tagName</code> in order to create an empty mw.html object.

 

<code>args</code> can be a table with the following keys:

* <code>args.selfClosing</code>: Force the current tag to be self-closing, even if mw.html doesn't recognize it as self-closing

* <code>args.parent</code>: Parent of the current mw.html instance (intended for internal usage)

 

<code style="white-space:nowrap">html:node( builder )</code><br>

 

Appends a child mw.html (<code>builder</code>) node to the current mw.html instance. If a nil parameter is passed, this is a no-op.

 

<code style="white-space:nowrap">html:wikitext( ... )</code><br>

 

Appends an undetermined number of wikitext strings to the mw.html object.

 

Note that this stops at the first ''nil'' item.

 

<code style="white-space:nowrap">html:newline()</code><br>

 

Appends a newline to the mw.html object.

 

<code style="white-space:nowrap">html:tag( tagName, args )</code><br>

 

Appends a new child node with the given <code>tagName</code> to the builder, and returns a mw.html instance representing that new node. The <code>args</code> parameter is identical to that of [[#mw.html.create|<code>mw.html.create</code>]]

 

<code style="white-space:nowrap">html:attr( name, value )</code><br>

<code style="white-space:nowrap">html:attr( table )</code>

 

Set an HTML attribute with the given <code>name</code> and <code>value</code> on the node. Alternatively a table holding name->value pairs of attributes to set can be passed. In the first form, a value of nil causes any attribute with the given name to be unset if it was previously set.

 

<code style="white-space:nowrap">html:getAttr( name )</code><br>

 

Get the value of a html attribute previously set using [[#mw.html:attr|<code>html:attr()</code>]] with the given <code>name</code>.

 

<code style="white-space:nowrap">html:addClass( class )</code><br>

 

Adds a class name to the node's class attribute. If a nil parameter is passed, this is a no-op.

 

<code style="white-space:nowrap">html:css( name, value )</code><br>

<code style="white-space:nowrap">html:css( table )</code>

 

Set a CSS property with the given <code>name</code> and <code>value</code> on the node. Alternatively a table holding name->value pairs of properties to set can be passed. In the first form, a value of nil causes any property with the given name to be unset if it was previously set.

 

<code style="white-space:nowrap">html:cssText( css )</code><br>

 

Add some raw <code>css</code> to the node's style attribute. If a nil parameter is passed, this is a no-op.

 

<code style="white-space:nowrap">html:done()</code><br>

 

Returns the parent node under which the current node was created. Like jQuery.end, this is a convenience function to allow the construction of several child nodes to be chained together into a single statement.

 

<code style="white-space:nowrap">html:allDone()</code><br>

 

Like [[#mw.html:done|<code>html:done()</code>]], but traverses all the way to the root node of the tree and returns it.

 

 

Language codes are described at [[Language code]]. Many of MediaWiki's language codes are similar to [[:en:IETF language tag|IETF language tags]], but not all MediaWiki language codes are valid IETF tags or vice versa.

 

Functions documented as <code>mw.language.<var>name</var></code> are available on the global <code>mw.language</code> table; functions documented as <code>mw.language:<var>name</var></code> are methods of a language object (see [[#mw.language.new|<code>mw.language.new</code>]]).

 

 

<code style="white-space:nowrap">mw.language.fetchLanguageName( code, inLanguage )</code>

 

The full name of the language for the given language code: native name (language autonym) by default, name translated in target language if a value is given for <code>inLanguage</code>.

 

 

<code style="white-space:nowrap">mw.language.fetchLanguageNames()</code><br>

<code style="white-space:nowrap">mw.language.fetchLanguageNames( inLanguage )</code><br>

<code style="white-space:nowrap">mw.language.fetchLanguageNames( inLanguage, include )</code><br>

 

Fetch the list of languages known to MediaWiki, returning a table mapping language code to language name.

 

By default the name returned is the language autonym; passing a language code for <code>inLanguage</code> returns all names in that language.

 

By default, only language names known to MediaWiki are returned; passing <code>'all'</code> for <code>include</code> will return all available languages (e.g. from [[Extension:CLDR]]), while passing <code>'mwfile'</code> will include only languages having customized messages included with MediaWiki core or enabled extensions. To explicitly select the default, <code>'mw'</code> may be passed.

 

 

<code>mw.language.getContentLanguage()</code><br>

<code>mw.getContentLanguage()</code>

 

Returns a new language object for the wiki's default content language.

 

 

<code style="white-space:nowrap">mw.language.getFallbacksFor( code )</code>

 

Returns a list of MediaWiki's fallback language codes for the specified code.

 

 

<code style="white-space:nowrap">mw.language.isKnownLanguageTag( code )</code>

 

Returns true if a language code is known to MediaWiki.

 

A language code is "known" if it is a "valid built-in code" (i.e. it returns true for [[#mw.language.isValidBuiltInCode|<code>mw.language.isValidBuiltInCode</code>]]) and returns a non-empty string for [[#mw.language.fetchLanguageName|<code>mw.language.fetchLanguageName</code>]].

 

 

<code style="white-space:nowrap">mw.language.isSupportedLanguage( code )</code>

 

Checks whether any localisation is available for that language code in MediaWiki.

 

A language code is "supported" if it is a "valid" code (returns true for [[#mw.language.isValidCode|<code>mw.language.isValidCode</code>]]), contains no uppercase letters, and has a message file in the currently-running version of MediaWiki.

 

It is possible for a language code to be "supported" but not "known" (i.e. returning true for [[#mw.language.isKnownLanguageTag|<code>mw.language.isKnownLanguageTag</code>]]). Also note that certain codes are "supported" despite [[#mw.language.isValidBuiltInCode|<code>mw.language.isValidBuiltInCode</code>]] returning false.

 

 

<code style="white-space:nowrap">mw.language.isValidBuiltInCode( code )</code>

 

Returns true if a language code is of a valid form for the purposes of internal customisation of MediaWiki.

 

The code may not actually correspond to any known language.

 

A language code is a "valid built-in code" if it is a "valid" code (i.e. it returns true for [[#mw.language.isValidCode|<code>mw.language.isValidCode</code>]]); consists of only ASCII letters, numbers, and hyphens; and is at least two characters long.

 

Note that some codes are "supported" (i.e. returning true from [[#mw.language.isSupportedLanguage|<code>mw.language.isSupportedLanguage</code>]]) even though this function returns false.

 

 

<code style="white-space:nowrap">mw.language.isValidCode( code )</code>

 

Returns true if a language code string is of a valid form, whether or not it exists. This includes codes which are used solely for customisation via the MediaWiki namespace.

 

The code may not actually correspond to any known language.

 

A language code is valid if it does not contain certain unsafe characters (colons, single- or double-quotes, slashs, backslashs, angle brackets, ampersands, or ASCII NULs) and is otherwise allowed in a page title.

 

 

<code style="white-space:nowrap">mw.language.new( code )</code><br>

<code style="white-space:nowrap">mw.getLanguage( code )</code>

 

Creates a new language object. Language objects do not have any publicly accessible properties, but they do have several methods, which are documented below.

 

There is a limit on the number of distinct language codes that may be used on a page. Exceeding this limit will result in errors.

 

 

<code style="white-space:nowrap">lang:getCode()</code>

 

Returns the language code for this language object.

 

 

<code style="white-space:nowrap">lang:getFallbackLanguages()</code>

 

Returns a list of MediaWiki's fallback language codes for this language object. Equivalent to <code style="white-space:nowrap">mw.language.getFallbacksFor( lang:getCode() )</code>.

 

 

<code style="white-space:nowrap">lang:isRTL()</code>

 

Returns true if the language is written right-to-left, false if it is written left-to-right.

 

 

<code style="white-space:nowrap">lang:lc( s )</code>

 

Converts the string to lowercase, honoring any special rules for the given language.

 

When the [[#Ustring library|Ustring library]] is loaded, the [[#mw.ustring.lower|mw.ustring.lower()]] function is implemented as a call to <code style="white-space:nowrap">mw.language.getContentLanguage():lc( s )</code>.

 

 

<code style="white-space:nowrap">lang:lcfirst( s )</code>

 

Converts the first character of the string to lowercase, as with [[#mw.language:lc|lang:lc()]].

 

 

<code style="white-space:nowrap">lang:uc( s )</code>

 

Converts the string to uppercase, honoring any special rules for the given language.

 

When the [[#Ustring library|Ustring library]] is loaded, the [[#mw.ustring.upper|mw.ustring.upper()]] function is implemented as a call to <code style="white-space:nowrap">mw.language.getContentLanguage():uc( s )</code>.

 

 

<code style="white-space:nowrap">lang:ucfirst( s )</code>

 

Converts the first character of the string to uppercase, as with [[#mw.language:uc|lang:uc()]].

 

 

<code style="white-space:nowrap">lang:caseFold( s )</code>

 

Converts the string to a representation appropriate for case-insensitive comparison. Note that the result may not make any sense when displayed.

 

 

<code style="white-space:nowrap">lang:formatNum( n )</code>

 

Formats a number with grouping and decimal separators appropriate for the given language. Given 123456.78, this may produce "123,456.78", "123.456,78", or even something like "١٢٣٬٤٥٦٫٧٨" depending on the language and wiki configuration.

 

 

<code style="white-space:nowrap">lang:formatDate( format, timestamp, local )</code>

 

Formats a date according to the given format string. If <code>timestamp</code> is omitted, the default is the current time. The value for <code>local</code> must be a boolean or nil; if true, the time is formatted in the [[Manual:$wgLocaltimezone|wiki's local time]] rather than in UTC.

 

The format string and supported values for <code>timestamp</code> are identical to those for the [[Help:Extension:ParserFunctions#.23time|#time parser function]] from [[Extension:ParserFunctions]]. Note that backslashes may need to be doubled in the Lua string where they wouldn't in wikitext:

 

lang:formatDate( '\n' )

lang:formatDate( '\\\\n' )

 

 

<code style="white-space:nowrap">lang:formatDuration( seconds )</code><br>

<code style="white-space:nowrap">lang:formatDuration( seconds, allowedIntervals )</code>

 

Breaks a duration in seconds into more human-readable units, e.g. 12345 to 3 hours, 25 minutes and 45 seconds, returning the result as a string.

 

<code>allowedIntervals</code>, if given, is a table with values naming the interval units to use in the response. These include 'millennia', 'centuries', 'decades', 'years', 'weeks', 'days', 'hours', 'minutes', and 'seconds'.

 

 

<code style="white-space:nowrap">lang:parseFormattedNumber( s )</code>

 

This takes a number as formatted by [[#mw.language:formatNum|lang:formatNum()]] and returns the actual number. In other words, this is basically a language-aware version of [[#tonumber|<code>tonumber()</code>]].

 

 

{{Anchor|mw.language:plural}}

<code style="white-space:nowrap">lang:convertPlural( n, ... )</code><br>

<code style="white-space:nowrap">lang:plural( n, forms )</code>

 

This chooses the appropriate grammatical form from <code>forms</code> (which must be a [[#sequence|sequence]] table) or <code>...</code> based on the number <code>n</code>. For example, in English you might use <code style="white-space:nowrap">n .. ' ' .. lang:plural( n, 'sock', 'socks' )</code> or <code style="white-space:nowrap">n .. ' ' .. lang:plural( n, { 'sock', 'socks' } )</code> to generate grammatically-correct text whether there is only 1 sock or 200 socks.

 

The necessary values for the sequence are language-dependent, see [[Help:Magic words#Localization]] and [[translatewiki:FAQ#PLURAL]] for some details.

 

 

{{Anchor|mw.language:grammar}}

<code style="white-space:nowrap">lang:convertGrammar( word, case )</code><br>

<code style="white-space:nowrap">lang:grammar( case, word )</code>

 

: ''Note the different parameter order between the two aliases. <code>convertGrammar</code> matches the order of the method of the same name on MediaWiki's Language object, while <code>grammar</code> matches the order of the parser function of the same name, documented at [[Help:Magic words#Localisation]].''

 

This chooses the appropriate inflected form of <code>word</code> for the given inflection code <code>case</code>.

 

The possible values for <code>word</code> and <code>case</code> are language-dependent, see [[Help:Magic words#Language-dependent word conversions]] and [[translatewiki:Grammar]] for some details.

 

 

<code style="white-space:nowrap">lang:gender( what, masculine, feminine, neutral )</code><br>

<code style="white-space:nowrap">lang:gender( what, { masculine, feminine, neutral } )</code>

 

Chooses the string corresponding to the gender of <code>what</code>, which may be "male", "female", or a registered user name.

 

 

<code style="white-space:nowrap">lang:getArrow( direction )</code>

 

Returns a Unicode arrow character corresponding to <code>direction</code>:

* '''forwards''': Either "→" or "←" depending on the directionality of the language.

* '''down''': "↓"

 

 

<code style="white-space:nowrap">lang:getDir()</code>

 

Returns "ltr" or "rtl", depending on the directionality of the language.

 

 

<code style="white-space:nowrap">lang:getDirMark( opposite )</code>

 

Returns a string containing either U+200E (the left-to-right mark) or U+200F (the right-to-left mark), depending on the directionality of the language and whether <code>opposite</code> is a true or false value.

 

 

<code style="white-space:nowrap">lang:getDirMarkEntity( opposite )</code>

 

Returns "&amp;lrm;" or "&amp;rlm;", depending on the directionality of the language and whether <code>opposite</code> is a true or false value.

 

 

<code style="white-space:nowrap">lang:getDurationIntervals( seconds )</code><br>

<code style="white-space:nowrap">lang:getDurationIntervals( seconds, allowedIntervals )</code>

 

Breaks a duration in seconds into more human-readable units, e.g. 12345 to 3 hours, 25 minutes and 45 seconds, returning the result as a table mapping unit names to numbers.

 

<code>allowedIntervals</code>, if given, is a table with values naming the interval units to use in the response. These include 'millennia', 'centuries', 'decades', 'years', 'days', 'hours', 'minutes', and 'seconds'.

 

 

This library is an interface to the localisation messages and the MediaWiki: namespace.

 

Functions documented as <code>mw.message.name</code> are available on the global <code>mw.message</code> table; functions documented as <code>mw.message:name</code> are methods of a message object (see [[#mw.message.new|<code>mw.message.new</code>]]).

 

 

<code style="white-space:nowrap">mw.message.new( key, ... )</code>

 

Creates a new message object for the given message <code>key</code>.

 

The message object has no properties, but has several methods documented below.

 

 

<code style="white-space:nowrap">mw.message.newFallbackSequence( ... )</code>

 

Creates a new message object for the given messages (the first one that exists will be used).

 

The message object has no properties, but has several methods documented below.

 

 

<code style="white-space:nowrap">mw.message.newRawMessage( msg, ... )</code>

 

Creates a new message object, using the given text directly rather than looking up an internationalized message. The remaining parameters are passed to the new object's <code>[[#mw.message:params|params()]]</code> method.

 

The message object has no properties, but has several methods documented below.

 

 

<code style="white-space:nowrap">mw.message.rawParam( value )</code>

 

Wraps the value so that it will not be parsed as wikitext by <code>[[#mw.message:parse|msg:parse()]]</code>.

 

 

<code style="white-space:nowrap">mw.message.numParam( value )</code>

 

Wraps the value so that it will automatically be formatted as by <code>[[#mw.language:formatNum|lang:formatNum()]]</code>. Note this does not depend on the [[#Language library|Language library]] actually being available.

 

 

<code style="white-space:nowrap">mw.message.getDefaultLanguage()</code>

 

Returns a Language object for the default language.

 

 

<code style="white-space:nowrap">msg:params( ... )</code><br>

<code style="white-space:nowrap">msg:params( params )</code>

 

Add parameters to the message, which may be passed as individual arguments or as a [[#sequence|sequence]] table. Parameters must be numbers, strings, or the special values returned by [[#mw.message.numParam|mw.message.numParam()]] or [[#mw.message.rawParam|mw.message.rawParam()]]. If a sequence table is used, parameters must be directly present in the table; references using the [[#Metatables|__index metamethod]] will not work.

 

Returns the <code>msg</code> object, to allow for call chaining.

 

 

<code style="white-space:nowrap">msg:rawParams( ... )</code><br>

<code style="white-space:nowrap">msg:rawParams( params )</code>

 

Like [[#mw.message:params|:params()]], but has the effect of passing all the parameters through [[#mw.message.rawParam|mw.message.rawParam()]] first.

 

Returns the <code>msg</code> object, to allow for call chaining.

 

 

<code style="white-space:nowrap">msg:numParams( ... )</code><br>

<code style="white-space:nowrap">msg:numParams( params )</code>

 

Like [[#mw.message:params|:params()]], but has the effect of passing all the parameters through [[#mw.message.numParam|mw.message.numParam()]] first.

 

Returns the <code>msg</code> object, to allow for call chaining.

 

 

<code style="white-space:nowrap">msg:inLanguage( lang )</code>

 

Specifies the language to use when processing the message. <code>lang</code> may be a string or a table with a <code>getCode()</code> method (i.e. a [[#Language library|Language object]]).

 

The default language is the one returned by <code>[[#mw.message.getDefaultLanguage|mw.message.getDefaultLanguage()]]</code>.

 

Returns the <code>msg</code> object, to allow for call chaining.

 

 

<code style="white-space:nowrap">msg:useDatabase( bool )</code>

 

Specifies whether to look up messages in the MediaWiki: namespace (i.e. look in the database), or just use the default messages distributed with MediaWiki.

 

The default is true.

 

Returns the <code>msg</code> object, to allow for call chaining.

 

 

<code style="white-space:nowrap">msg:plain()</code>

 

Substitutes the parameters and returns the message wikitext as-is. Template calls and parser functions are intact.

 

 

<code style="white-space:nowrap">msg:exists()</code>

 

Returns a boolean indicating whether the message key exists.

 

 

<code style="white-space:nowrap">msg:isBlank()</code>

 

Returns a boolean indicating whether the message key has content. Returns true if the message key does not exist or the message is the empty string.

 

 

<code style="white-space:nowrap">msg:isDisabled()</code>

 

Returns a boolean indicating whether the message key is disabled. Returns true if the message key does not exist or if the message is the empty string or the string "-".

 

 

 

A string holding the current version of MediaWiki.

 

 

The value of [[Manual:$wgScriptPath|$wgScriptPath]].

 

 

The value of [[Manual:$wgServer|$wgServer]].

 

 

The value of [[Manual:$wgSitename|$wgSitename]].

 

 

The value of [[Manual:$wgStylePath|$wgStylePath]].

 

 

Table holding data for all namespaces, indexed by number.

 

The data available is:

* '''id''': Namespace number.

* '''associated''': Reference to the associated namespace's data.

 

A metatable is also set that allows for looking up namespaces by name (localized or canonical). For example, both <code>mw.site.namespaces[4]</code> and <code>mw.site.namespaces.Project</code> will return information about the Project namespace.

 

 

Table holding just the content namespaces, indexed by number. See [[#mw.site.namespaces|mw.site.namespaces]] for details.

 

 

Table holding just the subject namespaces, indexed by number. See [[#mw.site.namespaces|mw.site.namespaces]] for details.

 

 

Table holding just the talk namespaces, indexed by number. See [[#mw.site.namespaces|mw.site.namespaces]] for details.

 

 

Table holding site statistics. Available statistics are:

 

* '''pages''': Number of pages in the wiki.

* '''articles''': Number of articles in the wiki.

* '''admins''': Number of users in group 'sysop' in the wiki.

 

 

<code style="white-space:nowrap">mw.site.stats.pagesInCategory( category, which )</code>

 

: {{red|This function is [[Manual:$wgExpensiveParserFunctionLimit|expensive]]}}

 

Gets statistics about the category. If <code>which</code> is unspecified, nil, or "*", returns a table with the following properties:

* '''all''': Total pages, files, and subcategories.

* '''pages''': Number of pages.

 

If <code>which</code> is one of the above keys, just the corresponding value is returned instead.

 

Each new category queried will increment the expensive function count.

 

 

<code style="white-space:nowrap">mw.site.stats.pagesInNamespace( ns )</code>

 

Returns the number of pages in the given namespace (specify by number).

 

 

<code style="white-space:nowrap">mw.site.stats.usersInGroup( group )</code>

 

Returns the number of users in the given group.

 

 

<code style="white-space:nowrap">mw.site.interwikiMap( filter )</code>

 

Returns a table holding data about available [[Manual:Interwiki|interwiki]] prefixes. If <code>filter</code> is the string "local", then only data for local interwiki prefixes is returned. If <code>filter</code> is the string "!local", then only data for non-local prefixes is returned. If no filter is specified, data for all prefixes is returned. A "local" prefix in this context is one that is for the same project. For example, on the English Wikipedia, other-language Wikipedias are considered local, while Wiktionary and such are not.

 

Keys in the table returned by this function are interwiki prefixes, and the values are subtables with the following properties:

* '''prefix''' - the interwiki prefix.

* '''tooltip''' - for links listed in $wgExtraInterlanguageLinkPrefixes, this is the tooltip text shown when users hover over the interlanguage link. Nil if not specified.

 

 

The text library provides some common text processing functions missing from the [[#String library|String library]] and the [[#Ustring library|Ustring library]]. These functions are safe for use with UTF-8 strings.

 

 

<code style="white-space:nowrap">mw.text.decode( s )</code><br>

<code style="white-space:nowrap">mw.text.decode( s, decodeNamedEntities )</code>

 

Replaces [[:en:HTML entities|HTML entities]] in the string with the corresponding characters.

 

If <code>decodeNamedEntities</code> is omitted or false, the only named entities recognized are '&amp;lt;', '&amp;gt;', '&amp;amp;', '&amp;quot;', and '&amp;nbsp;'. Otherwise, the list of HTML5 named entities to recognize is loaded from PHP's [http://www.php.net/get_html_translation_table <code>get_html_translation_table</code>] function.

 

 

<code style="white-space:nowrap">mw.text.encode( s )</code><br>

<code style="white-space:nowrap">mw.text.encode( s, charset )</code>

 

Replaces characters in a string with [[:en:HTML entities|HTML entities]]. Characters '<', '>', '&', '"', and the non-breaking space are replaced with the appropriate named entities; all others are replaced with numeric entities.

 

If <code>charset</code> is supplied, it should be a string as appropriate to go inside brackets in a [[#Ustring patterns|Ustring pattern]], i.e. the "set" in <code>[set]</code>. The default charset is <code>'<>&"\'&nbsp;'</code> (the space at the end is the non-breaking space, U+00A0).

 

 

<code style="white-space:nowrap">mw.text.jsonDecode( s )</code><br>

<code style="white-space:nowrap">mw.text.jsonDecode( s, flags )</code>

 

Decodes a JSON string. <code>flags</code> is 0 or a combination (use <code>+</code>) of the flags <code>mw.text.JSON_PRESERVE_KEYS</code> and <code>mw.text.JSON_TRY_FIXING</code>.

 

Normally JSON's zero-based arrays are renumbered to Lua one-based sequence tables; to prevent this, pass <code>mw.text.JSON_PRESERVE_KEYS</code>.

 

To relax certain requirements in JSON, such as no terminal comma in arrays or objects, pass <code>mw.text.JSON_TRY_FIXING</code>. This is not recommended.

 

Limitations:

* Decoded JSON arrays may not be Lua sequences if the array contains null values.

* A JSON object having sequential integer keys beginning with 1 will decode to the same table structure as a JSON array with the same values, despite these not being at all equivalent, unless <code>mw.text.JSON_PRESERVE_KEYS</code> is used.

 

 

<code style="white-space:nowrap">mw.text.jsonEncode( value )</code><br>

<code style="white-space:nowrap">mw.text.jsonEncode( value, flags )</code>

 

Encode a JSON string. Errors are raised if the passed value cannot be encoded in JSON. <code>flags</code> is 0 or a combination (use <code>+</code>) of the flags <code>mw.text.JSON_PRESERVE_KEYS</code> and <code>mw.text.JSON_PRETTY</code>.

 

Normally Lua one-based sequence tables are encoded as JSON zero-based arrays; when <code>mw.text.JSON_PRESERVE_KEYS</code> is set in <code>flags</code>, zero-based sequence tables are encoded as JSON arrays.

 

Limitations:

* Empty tables are always encoded as empty arrays (<code>[]</code>), not empty objects (<code>{}</code>).

* When both a number and the string representation of that number are used as keys in the same table, behavior is unspecified.

 

 

<code style="white-space:nowrap">mw.text.killMarkers( s )</code>

 

Removes all MediaWiki [[strip marker]]s from a string.

 

 

<code style="white-space:nowrap">mw.text.listToText( list )</code><br>

<code style="white-space:nowrap">mw.text.listToText( list, separator, conjunction )</code>

 

Join a list, prose-style. In other words, it's like <code>[[#table.concat|table.concat()]]</code> but with a different separator before the final item.

 

The default separator is taken from [[MediaWiki:comma-separator]] in the wiki's content language, and the default conjuction is [[MediaWiki:and]] concatenated with [[MediaWiki:word-separator]].

 

Examples, using the default values for the messages:

 

mw.text.listToText( {} )

mw.text.listToText( { 1, 2, 3, 4, 5 }, '; ', ' or ' )

 

 

<code style="white-space:nowrap">mw.text.nowiki( s )</code>

 

Replaces various characters in the string with [[:en:HTML entities|HTML entities]] to prevent their interpretation as wikitext. This includes:

* The following characters: '"', '&', "'", '<', '=', '>', '[', ']', '{', '|', '}'

* A whitespace character following "ISBN", "RFC", or "PMID" will be escaped

 

 

<code style="white-space:nowrap">mw.text.split( s, pattern, plain )</code>

 

Splits the string into substrings at boundaries matching the [[#Ustring patterns|Ustring pattern]] <code>pattern</code>. If <code>plain</code> is specified and true, <code>pattern</code> will be interpreted as a literal string rather than as a Lua pattern (just as with the parameter of the same name for <code>[[#mw.ustring.find|mw.ustring.find()]]</code>). Returns a table containing the substrings.

 

For example, <code style="white-space:nowrap">mw.text.split( 'a b\tc\nd', '%s' )</code> would return a table <code style="white-space:nowrap">{ 'a', 'b', 'c', 'd' }</code>.

 

If <code>pattern</code> matches the empty string, <code>s</code> will be split into individual characters.

 

 

<code style="white-space:nowrap">mw.text.gsplit( s, pattern, plain )</code>

 

Returns an [[#iterators|iterator function]] that will iterate over the substrings that would be returned by the equivalent call to <code>[[#mw.text.split|mw.text.split()]]</code>.

 

 

<code style="white-space:nowrap">mw.text.tag( name, attrs, content )</code><br>

<code style="white-space:nowrap">mw.text.tag{ name = string, attrs = table, content = string|false }</code>

 

: ''Note the use of [[#named arguments|named arguments]].''

 

Generates an HTML-style tag for <code>name</code>.

 

If <code>attrs</code> is given, it must be a table with string keys. String and number values are used as the value of the attribute; boolean true results in the key being output as an HTML5 valueless parameter; boolean false skips the key entirely; and anything else is an error.

 

If <code>content</code> is not given (or is nil), only the opening tag is returned. If <code>content</code> is boolean false, a self-closed tag is returned. Otherwise it must be a string or number, in which case that content is enclosed in the constructed opening and closing tag. Note the content is not automatically HTML-encoded; use [[#mw.text.encode|mw.text.encode()]] if needed.

 

For properly returning extension tags such as <code><nowiki><ref></nowiki></code>, use [[#frame:extensionTag|frame:extensionTag()]] instead.

 

 

<code style="white-space:nowrap">mw.text.trim( s )</code><br>

<code style="white-space:nowrap">mw.text.trim( s, charset )</code>

 

Remove whitespace or other characters from the beginning and end of a string.

 

If <code>charset</code> is supplied, it should be a string as appropriate to go inside brackets in a [[#Ustring patterns|Ustring pattern]], i.e. the "set" in <code>[set]</code>. The default charset is ASCII whitespace, <code style="white-space:nowrap">"%t%r%n%f "</code>.

 

 

<code style="white-space:nowrap">mw.text.truncate( text, length )</code><br>

<code style="white-space:nowrap">mw.text.truncate( text, length, ellipsis )</code><br>

<code style="white-space:nowrap">mw.text.truncate( text, length, ellipsis, adjustLength )</code>

 

Truncates <code>text</code> to the specified length, adding <code>ellipsis</code> if truncation was performed. If length is positive, the end of the string will be truncated; if negative, the beginning will be removed. If <code>adjustLength</code> is given and true, the resulting string including ellipsis will not be longer than the specified length.

 

The default value for <code>ellipsis</code> is taken from [[MediaWiki:ellipsis]] in the wiki's content language.

 

Examples, using the default "..." ellipsis:

 

mw.text.truncate( "foobarbaz", 9 )

mw.text.truncate( "foobarbaz", 8 )

 

 

<code style="white-space:nowrap">mw.text.unstripNoWiki( s )</code>

 

Replaces MediaWiki &lt;nowiki&gt; [[strip marker]]s with the corresponding text. Other types of strip markers are not changed.

 

 

<code style="white-space:nowrap">mw.text.unstrip( s )</code>

 

Equivalent to <code style="white-space:nowrap">mw.text.killMarkers( mw.text.unstripNoWiki( s ) )</code>.

 

This no longer reveals the HTML behind special page transclusion, &lt;ref&gt; tags, and so on as it did in earlier versions of Scribunto.

 

 

 

<code style="white-space:nowrap">mw.title.equals( a, b )</code>

 

Test for whether two titles are equal. Note that fragments are ignored in the comparison.

 

 

<code style="white-space:nowrap">mw.title.compare( a, b )</code>

 

Returns -1, 0, or 1 to indicate whether the title <code>a</code> is less than, equal to, or greater than title <code>b</code>

 

 

<code style="white-space:nowrap">mw.title.getCurrentTitle()</code>

 

Returns the title object for the current page.

 

 

<code style="white-space:nowrap">mw.title.new( text, namespace )</code><br>

<code style="white-space:nowrap">mw.title.new( id )</code>

 

: {{red|This function is [[Manual:$wgExpensiveParserFunctionLimit|expensive]] when called with an ID}}

 

Creates a new title object.

 

If a number <code>id</code> is given, an object is created for the title with that page_id. The title referenced will be counted as linked from the current page. If the page_id does not exist, returns nil. The expensive function count will be incremented if the title object created is not for a title that has already been loaded.

 

If a string <code>text</code> is given instead, an object is created for that title (even if the page does not exist). If the text string does not specify a namespace, <code>namespace</code> (which may be any key found in <code>[[#mw.site.namespaces|mw.site.namespaces]]</code>) will be used. If the text is not a valid title, nil is returned.

 

 

<code style="white-space:nowrap">mw.title.makeTitle( namespace, title, fragment, interwiki )</code>

 

Creates a title object with title <code>title</code> in namespace <code>namespace</code>, optionally with the specified <code>fragment</code> and <code>interwiki</code> prefix. <code>namespace</code> may be any key found in <code>[[#mw.site.namespaces|mw.site.namespaces]]</code>. If the resulting title is not valid, returns nil.

 

Note that <code style="white-space:nowrap">mw.title.new( 'Module:Foo', 'Template' )</code> will create an object for the page Module:Foo, while <code style="white-space:nowrap">mw.title.makeTitle( 'Template', 'Module:Foo' )</code> will create an object for the page Template:Module:Foo.

 

 

A title object has a number of properties and methods. Most of the properties are read-only.

 

Note that fields ending with <code>text</code> return titles as string values whereas the fields ending with <code>title</code> return title objects.

 

* '''id''': The page_id. 0 if the page does not exist. {{red|This [[#Expensive properties|may be expensive]]}}, and the page will be recorded as a link.

* '''interwiki''': The interwiki prefix, or the empty string if none.

* '''getContent()''': Returns the (unparsed) content of the page, or nil if there is no page. The page will be recorded as a transclusion.

 

Title objects may be compared using [[#Relational operators|Relational operators]]. <code style="white-space:nowrap">[[#tostring|tostring]]( title )</code> will return <code>title.prefixedText</code>.

 

Title objects representing a page in the File or Media namespace will have a property called <code>file</code>. {{red|This is [[Manual:$wgExpensiveParserFunctionLimit|expensive]].}} This is a table, structured as follows:

* '''exists''': Whether the file exists. It will be recorded as an image usage. The <code>fileExists</code> property on a Title object exists for backwards compatibility reasons and is an alias for this property. If this is false, all other file properties will be nil.

* '''mimeType''': The [[:en:MIME type|MIME type]] of the file.

 

 

The properties id, isRedirect, exists, and contentModel require fetching data about the title from the database. For this reason, the [[Manual:$wgExpensiveParserFunctionLimit|expensive function count]] is incremented the first time one of them is accessed for a page other than the current page. Subsequent accesses of any of these properties for that page will not increment the expensive function count again.

 

Other properties marked as expensive will always increment the expensive function count the first time they are accessed for a page other than the current page.

 

 

 

<code style="white-space:nowrap">mw.uri.encode( s, enctype )</code>

 

[[:en:Percent-encoding|Percent-encodes]] the string. The default type, "QUERY", encodes spaces using '+' for use in query strings; "PATH" encodes spaces as %20; and "WIKI" encodes spaces as '_'.

 

Note that the "WIKI" format is not entirely reversible, as both spaces and underscores are encoded as '_'.

 

 

<code style="white-space:nowrap">mw.uri.decode( s, enctype )</code>

 

[[:en:Percent-encoding|Percent-decodes]] the string. The default type, "QUERY", decodes '+' to space; "PATH" does not perform any extra decoding; and "WIKI" decodes '_' to space.

 

 

<code style="white-space:nowrap">mw.uri.anchorEncode( s )</code>

 

Encodes a string for use in a MediaWiki URI fragment.

 

 

<code style="white-space:nowrap">mw.uri.buildQueryString( table )</code>

 

Encodes a table as a URI query string. Keys should be strings; values may be strings or numbers, sequence tables, or boolean false.

 

 

<code style="white-space:nowrap">mw.uri.parseQueryString( s, i, j )</code>

 

Decodes the query string <code>s</code> to a table. Keys in the string without values will have a value of false; keys repeated multiple times will have sequence tables as values; and others will have strings as values.

 

The optional numerical arguments <code>i</code> and <code>j</code> can be used to specify a substring of <code>s</code> to be parsed, rather than the entire string. <code>i</code> is the position of the first character of the substring, and defaults to 1. <code>j</code> is the position of the last character of the substring, and defaults to the length of the string. Both <code>i</code> and <code>j</code> can be negative, as in [[#string.sub|string.sub]].

 

 

<code style="white-space:nowrap">mw.uri.canonicalUrl( page, query )</code>

 

Returns a [[#URI object|URI object]] for the canonical URL for a page, with optional query string/table.

 

 

<code style="white-space:nowrap">mw.uri.fullUrl( page, query )</code>

 

Returns a [[#URI object|URI object]] for the full URL for a page, with optional query string/table.

 

 

<code style="white-space:nowrap">mw.uri.localUrl( page, query )</code>

 

Returns a [[#URI object|URI object]] for the local URL for a page, with optional query string/table.

 

 

<code style="white-space:nowrap">mw.uri.new( s )</code>

 

Constructs a new [[#URI object|URI object]] for the passed string or table. See the description of URI objects for the possible fields for the table.

 

 

<code style="white-space:nowrap">mw.uri.validate( table )</code>

 

Validates the passed table (or URI object). Returns a boolean indicating whether the table was valid, and on failure a string explaining what problems were found.

 

 

The URI object has the following fields, some or all of which may be nil:

 

* '''protocol''': String protocol/scheme

* '''user''': String user

* '''fragment''': String fragment.

 

The following properties are also available:

* '''userInfo''': String user and password

* '''relativePath''': String path, query string, and fragment

 

[[#tostring|<code>tostring()</code>]] will give the URI string.

 

Methods of the URI object are:

 

 

<code style="white-space:nowrap">uri:parse( s )</code>

 

Parses a string into the current URI object. Any fields specified in the string will be replaced in the current object; fields not specified will keep their old values.

 

 

<code>uri:clone()</code>

 

Makes a copy of the URI object.

 

 

<code style="white-space:nowrap">uri:extend( parameters )</code>

 

Merges the parameters table into the object's query table.

 

 

The ustring library is intended to be a direct reimplementation of the standard [[#String library|String library]], except that the methods operate on characters in UTF-8 encoded strings rather than bytes.

 

Most functions will raise an error if the string is not valid UTF-8; exceptions are noted.

 

 

The maximum allowed length of a pattern, in bytes.

 

 

The maximum allowed length of a string, in bytes.

 

 

<code style="white-space:nowrap">mw.ustring.byte( s, i, j )</code>

 

Returns individual bytes; identical to [[#string.byte|string.byte()]].

 

 

<code style="white-space:nowrap">mw.ustring.byteoffset( s, l, i )</code>

 

Returns the byte offset of a character in the string. The default for both <code>l</code> and <code>i</code> is 1. <code>i</code> may be negative, in which case it counts from the end of the string.

 

The character at <code>l</code> == 1 is the first character starting at or after byte <code>i</code>; the character at <code>l</code> == 0 is the first character starting at or before byte <code>i</code>. Note this may be the same character. Greater or lesser values of <code>l</code> are calculated relative to these.

 

 

<code style="white-space:nowrap">mw.ustring.char( ... )</code>

 

Much like [[#string.char|string.char()]], except that the integers are Unicode codepoints rather than byte values.

 

 

<code style="white-space:nowrap">mw.ustring.codepoint( s, i, j )</code>

 

Much like [[#string.byte|string.byte()]], except that the return values are codepoints and the offsets are characters rather than bytes.

 

 

<code style="white-space:nowrap">mw.ustring.find( s, pattern, init, plain )</code>

 

Much like [[#string.find|string.find()]], except that the pattern is extended as described in [[#Ustring patterns|Ustring patterns]] and the <code>init</code> offset is in characters rather than bytes.

 

 

<code style="white-space:nowrap">mw.ustring.format( format, ... )</code>

 

Identical to [[#string.format|string.format()]]. Widths and precisions for strings are expressed in bytes, not codepoints.

 

 

<code style="white-space:nowrap">mw.ustring.gcodepoint( s, i, j )</code>

 

Returns three values for iterating over the codepoints in the string. <code>i</code> defaults to 1, and <code>j</code> to -1. This is intended for use in the [[#iterators|iterator form of <code>for</code>]]:

 

<source lang="lua">

for codepoint in mw.ustring.gcodepoint( s ) do

</source>

 

 

<code style="white-space:nowrap">mw.ustring.gmatch( s, pattern )</code>

 

Much like [[#string.gmatch|string.gmatch()]], except that the pattern is extended as described in [[#Ustring patterns|Ustring patterns]].

 

 

<code style="white-space:nowrap">mw.ustring.gsub( s, pattern, repl, n )</code>

 

Much like [[#string.gsub|string.gsub()]], except that the pattern is extended as described in [[#Ustring patterns|Ustring patterns]].

 

 

<code style="white-space:nowrap">mw.ustring.isutf8( s )</code>

 

Returns true if the string is valid UTF-8, false if not.

 

 

<code style="white-space:nowrap">mw.ustring.len( s )</code>

 

Returns the length of the string in codepoints, or nil if the string is not valid UTF-8.

 

See [[#string.len|string.len()]] for a similar function that uses byte length rather than codepoints.

 

 

<code style="white-space:nowrap">mw.ustring.lower( s )</code>

 

Much like [[#string.lower|string.lower()]], except that all characters with lowercase to uppercase definitions in Unicode are converted.

 

If the [[#Language library|Language library]] is also loaded, this will instead call [[#mw.language:lc|lc()]] on the default language object.

 

 

<code style="white-space:nowrap">mw.ustring.match( s, pattern, init )</code>

 

Much like [[#string.match|string.match()]], except that the pattern is extended as described in [[#Ustring patterns|Ustring patterns]] and the <code>init</code> offset is in characters rather than bytes.

 

 

<code style="white-space:nowrap">mw.ustring.rep( s, n )</code>

 

Identical to [[#string.rep|string.rep()]].

 

 

<code style="white-space:nowrap">mw.ustring.sub( s, i, j )</code>

 

Much like [[#string.sub|string.sub()]], except that the offsets are characters rather than bytes.

 

 

<code style="white-space:nowrap">mw.ustring.toNFC( s )</code>

 

Converts the string to [[:en:Normalization Form C|Normalization Form C]]. Returns nil if the string is not valid UTF-8.

 

 

<code style="white-space:nowrap">mw.ustring.toNFD( s )</code>

 

Converts the string to [[:en:Normalization Form D|Normalization Form D]]. Returns nil if the string is not valid UTF-8.

 

 

<code style="white-space:nowrap">mw.ustring.upper( s )</code>

 

Much like [[#string.upper|string.upper()]], except that all characters with uppercase to lowercase definitions in Unicode are converted.

 

If the [[#Language library|Language library]] is also loaded, this will instead call [[#mw.language:uc|uc()]] on the default language object.

 

 

Patterns in the ustring functions use the same syntax as the [[#Patterns|String library patterns]]. The major difference is that the character classes are redefined in terms of [[:en:Unicode character property|Unicode character properties]]:

* '''<code>%a</code>''': represents all characters with General Category "Letter".

* '''<code>%x</code>''': adds fullwidth character versions of the hex digits.

 

In all cases, characters are interpreted as Unicode characters instead of bytes, so ranges such as <code>[０-９]</code>, patterns such as <code>%b«»</code>, and quantifiers applied to multibyte characters will work correctly. Empty captures will capture the position in code points rather than bytes.

 

 

These libraries are not included by default, but if needed may be loaded using <code>[[#require|require()]]</code>.

 

 

This emulation of the Lua 5.2 <code>bit32</code> library may be loaded using

 

 

The bit32 library provides [[:en:Bitwise operation|bitwise operations]] on unsigned 32-bit integers. Input numbers are truncated to integers (in an unspecified manner) and reduced modulo 2³² so the value is in the range 0 to 2³²−1; return values are also in this range.

 

When bits are numbered (as in [[#bit32.extract|bit32.extract()]]), 0 is the least-significant bit (the one with value 2⁰) and 31 is the most-significant (the one with value 2³¹).

 

 

<code style="white-space:nowrap">bit32.band( ... )</code>

 

Returns the [[:en:Bitwise operation#AND|bitwise AND]] of its arguments: the result has a bit set only if that bit is set in all of the arguments.

 

If given zero arguments, the result has all bits set.

 

 

<code style="white-space:nowrap">bit32.bnot( x )</code>

 

Returns the [[:en:Bitwise operation#NOT|bitwise complement]] of <code>x</code>.

 

 

<code style="white-space:nowrap">bit32.bor( ... )</code>

 

Returns the [[:en:Bitwise operation#OR|bitwise OR]] of its arguments: the result has a bit set if that bit is set in any of the arguments.

 

If given zero arguments, the result has all bits clear.

 

 

<code style="white-space:nowrap">bit32.btest( ... )</code>

 

Equivalent to <code style="white-space:nowrap">bit32.band( ... ) ~= 0</code>

 

 

<code style="white-space:nowrap">bit32.bxor( ... )</code>

 

Returns the [[:en:Bitwise operation#XOR|bitwise XOR]] of its arguments: the result has a bit set if that bit is set in an odd number of the arguments.

 

If given zero arguments, the result has all bits clear.

 

 

<code style="white-space:nowrap">bit32.extract( n, field, width )</code>

 

Extracts <code>width</code> bits from <code>n</code>, starting with bit <code>field</code>. Accessing bits outside of the range 0 to 31 is an error.

 

If not specified, the default for <code>width</code> is 1.

 

 

<code style="white-space:nowrap">bit32.replace( n, v, field, width )</code>

 

Replaces <code>width</code> bits in <code>n</code>, starting with bit <code>field</code>, with the low <code>width</code> bits from <code>v</code>. Accessing bits outside of the range 0 to 31 is an error.

 

If not specified, the default for <code>width</code> is 1.

 

 

<code style="white-space:nowrap">bit32.lshift( n, disp )</code>

 

Returns the number <code>n</code> [[:en:Bitwise operation#Bit shifts|shifted]] <code>disp</code> bits to the left. This is a [[:en:Logical shift|logical shift]]: inserted bits are 0. This is generally equivalent to multiplying by 2^{<code>disp</code>}.

 

Note that a displacement over 31 will result in 0.

 

 

<code style="white-space:nowrap">bit32.rshift( n, disp )</code>

 

Returns the number <code>n</code> [[:en:Bitwise operation#Bit shifts|shifted]] <code>disp</code> bits to the right. This is a [[:en:Logical shift|logical shift]]: inserted bits are 0. This is generally equivalent to dividing by 2^{<code>disp</code>}.

 

Note that a displacement over 31 will result in 0.

 

 

<code style="white-space:nowrap">bit32.arshift( n, disp )</code>

 

Returns the number <code>n</code> shifted <code>disp</code> bits to the right. This is an [[:en:Arithmetic shift|arithmetic shift]]: if <code>disp</code> is positive, the inserted bits will be the same as bit 31 in the original number.

 

Note that a displacement over 31 will result in 0 or 4294967295.

 

 

<code style="white-space:nowrap">bit32.lrotate( n, disp )</code>

 

Returns the number <code>n</code> [[:en:Bitwise operation#Rotate no carry|rotated]] <code>disp</code> bits to the left.

 

Note that rotations are equivalent modulo 32: a rotation of 32 is the same as a rotation of 0, 33 is the same as 1, and so on.

 

 

<code style="white-space:nowrap">bit32.rrotate( n, disp )</code>

 

Returns the number <code>n</code> [[:en:Bitwise operation#Rotate no carry|rotated]] <code>disp</code> bits to the right.

 

Note that rotations are equivalent modulo 32: a rotation of 32 is the same as a rotation of 0, 33 is the same as 1, and so on.

 

 

This library contains methods useful when implementing Scribunto libraries. It may be loaded using

 

 

 

<code style="white-space:nowrap">libraryUtil.checkType( name, argIdx, arg, expectType, nilOk )</code>

 

Raises an error if <code style="white-space:nowrap">[[#type|type]]( arg )</code> does not match <code>expectType</code>. In addition, no error will be raised if <code>arg</code> is nil and <code>nilOk</code> is true.

 

<code>name</code> is the name of the calling function, and <code>argIdx</code> is the position of the argument in the argument list. These are used in formatting the error message.

 

 

<code style="white-space:nowrap">libraryUtil.checkTypeMulti( name, argIdx, arg, expectTypes )</code>

 

Raises an error if <code style="white-space:nowrap">[[#type|type]]( arg )</code> does not match any of the strings in the array <code>expectTypes</code>.

 

This is for arguments that have more than one valid type.

 

 

<code style="white-space:nowrap">libraryUtil.checkTypeForIndex( index, value, expectType )</code>

 

Raises an error if <code style="white-space:nowrap">[[#type|type]]( value )</code> does not match <code>expectType</code>.

 

This is intended for use in implementing a <code>__newindex</code> [[#Metatables|metamethod]].

 

 

<code style="white-space:nowrap">libraryUtil.checkTypeForNamedArg( name, argName, arg, expectType, nilOk )</code>

 

Raises an error if <code style="white-space:nowrap">[[#type|type]]( arg )</code> does not match <code>expectType</code>. In addition, no error will be raised if <code>arg</code> is nil and <code>nilOk</code> is true.

 

This is intended to be used as an equivalent to <code>[[#libraryUtil.checkType|libraryUtil.checkType()]]</code> in methods called using Lua's "named argument" syntax, <code style="white-space:nowrap">func{ name = value }</code>.

 

 

<code style="white-space:nowrap">libraryUtil.makeCheckSelfFunction( libraryName, varName, selfObj, selfObjDesc )</code>

 

This is intended for use in implementing "methods" on object tables that are intended to be called with the <code>obj:method()</code> syntax. It returns a function that should be called at the top of these methods with the <code>self</code> argument and the method name, which will raise an error if that <code>self</code> object is not <code>selfObj</code>.

 

This function will generally be used in a library's constructor function, something like this:

 

local obj = {}

local checkSelf = libraryUtil.makeCheckSelfFunction( 'myLibrary', 'obj', obj, 'myLibrary object' )

end

 

 

The [http://luaforge.net/projects/bit/ luabit] library modules "bit" and "hex" may be loaded using

 

hex = require( 'luabit.hex' )

 

Note that the [[#bit32|bit32 library]] contains the same operations as "luabit.bit", and the operations in "luabit.hex" may be performed using <code>[[#string.format|string.format()]]</code> and <code>[[#tonumber|tonumber()]]</code>.

 

The luabit module "noki" is not available, as it is entirely useless in Scribunto. The luabit module "utf8" is also not available, as it was considered redundant to the [[#Ustring library|Ustring library]].

 

 

The pure-Lua backend to the [[#Ustring library|Ustring library]] may be loaded using

 

 

In all cases the Ustring library (<code>mw.ustring</code>) should be used instead, as that replaces many of the slower and more memory-intensive operations with callbacks into PHP code.

 

 

The following MediaWiki extensions provide additional Scribunto libraries:

 

*[[Extension:Wikibase Client|Wikibase Client]]&nbsp;– provides access to [[:d:Wikidata:Main Page|Wikidata]]. See [[Extension:WikibaseClient/Lua]].

 

See also the lists of extensions using the [[:Category:ScribuntoExternalLibraries extensions|ScribuntoExternalLibraries]] and [[:Category:ScribuntoExternalLibraryPaths extensions|ScribuntoExternalLibraryPaths]] hooks.

 

 

These libraries are planned, or are in Gerrit pending review.

 

: ''(none at this time)''

 

 

The following functions have been '''modified''':

; [http://www.lua.org/manual/5.1/manual.html#pdf-setfenv setfenv()]

; [http://www.lua.org/manual/5.1/manual.html#pdf-require require()]: Can fetch certain built-in modules distributed with Scribunto, as well as modules present in the Module namespace of the wiki. To fetch wiki modules, use the full page name including the namespace. Cannot otherwise access the local filesystem.

 

The following packages are '''mostly removed'''. Only those functions listed are available:

; [http://www.lua.org/manual/5.1/manual.html#5.3 package.*]: Filesystem and C library access has been removed. Available functions and tables are:

 

 

The following functions and packages are '''not''' available:

; [http://www.lua.org/manual/5.1/manual.html#pdf-collectgarbage collectgarbage()]

; [http://www.lua.org/manual/5.1/manual.html#pdf-string.dump string.dump()]: May expose private data from parent environments.

 

; Referential data structures: Circular data structures and data structures where the same node may be reached by more than one path cannot be correctly sent to PHP. Attempting to do so will cause undefined behavior. This includes (but is not limited to) returning such data structures from the module called by <code><nowiki>{{#invoke:}}</nowiki></code> and passing such data structures as parameters to Scribunto library functions that are implemented as callbacks into PHP.<p>Such data structures may be used freely within Lua, including as the return values of modules loaded with <code>[[#mw.loadData|mw.loadData()]]</code>.

 

 

This information is useful to developers writing additional Scribunto libraries, whether for inclusion in Scribunto itself or for providing an interface for their own extensions.

 

A Scribunto library will generally consist of five parts:

* The PHP portion of the library.

* The documentation.

 

Existing libraries serve as a good example.

 

 

The PHP portion of the library is a class that must extend <code>Scribunto_LuaLibraryBase</code>. See the documentation for that class for implementation details. In the Scribunto extension, this file should be placed in <code>engines/LuaCommon/''Name''Library.php</code>, and a mapping added to <code>Scribunto_LuaEngine::$libraryClasses</code>. Other extensions should use the <code>ScribuntoExternalLibraries</code> hook. In either case, the key should match the Lua module name ("mw.''name''" for libraries in Scribunto, or "mw.ext.''name''" for extension libraries).

 

The Lua portion of the library sets up the table containing the functions that can be called from Lua modules. In the Scribunto extension, the file should be placed in <code>engines/LuaCommon/lualib/mw.''name''.lua</code>. This file should generally include boilerplate something like this:

 

<syntaxhighlight lang=lua>

local object = {}

local php

 

function object.setupInterface( options )

-- Remove setup function

object.setupInterface = nil

 

php = mw_interface

mw_interface = nil

 

 

mw = mw or {}

mw.ext = mw.ext or {}

mw.ext.NAME = object

 

package.loaded['mw.ext.NAME'] = object

end

 

return object

</syntaxhighlight>

 

The module in <code>engines/LuaCommon/lualib/libraryUtil.lua</code> (load this with <code>local util = require 'libraryUtil'</code>) contains some functions that may be helpful.

 

Be sure to run the Scribunto test cases with your library loaded, even if your library doesn't itself provide any test cases. The standard test cases include tests for things like libraries adding unexpected global variables. Also, if the library is loaded with PHP, any upvalues that its Lua functions have will not be reset between #invoke's. Care must be taken to ensure that modules can't abuse this to transfer information between #invoke's.

 

 

The Scribunto extension includes a base class for test cases, <code>Scribunto_LuaEngineTestBase</code>, which will run the tests against both the LuaSandbox and LuaStandalone engines. The library's test case should extend this class, and should not override <code>static function suite()</code>. In the Scribunto extension, the test case should be in <code>tests/engines/LuaCommon/''Name''LibraryTest.php</code> and added to the array in <code>ScribuntoHooks::unitTestsList()</code> (in <code>common/Hooks.php</code>); extensions should add the test case in their own [[Manual:Hooks/UnitTestsList|<code>UnitTestsList</code> hook]] function, probably conditional on whether <code>$wgAutoloadClasses['Scribunto_LuaEngineTestBase']</code> is set.

 

Most of the time, all that is needed to make the test case is this:

 

protected static $moduleName = '<i>ClassName</i>Test';

}

 

This will load the file <code>''ClassName''Tests.lua</code> as if it were the page "Module:''ClassName''Tests", expecting it to return an object with the following properties:

* '''count''': Integer, number of tests

* '''run( n )''': Function that runs test <code>n</code> and returns one string.

 

If <code>getTestModules()</code> is declared as shown, "Module:TestFramework" is available which provides many useful helper methods. If this is used, <code>''ClassName''Tests.lua</code> would look something like this:

 

return testframework.getTestProvider( {

} )

 

Each test is itself a table, with the following properties:

* '''name''': The name of the test.

* '''type''': Optional "type" of the test, default is "Normal".

 

The type controls the format of <code>expect</code> and how <code>func</code> is called. Included types are:

* '''Normal''': <code>expect</code> is a table of return values, or a string if the test should raise an error. <code>func</code> is simply called.

* '''ToString''': Like "Normal", except each return value is passed through <code>[[#tostring|tostring()]]</code>.

 

 

There are (at least) two ways to run PHPUnit tests:

# Run phpunit against core, allowing the tests/phpunit/suites/ExtensionsTestSuite.php to find the extension's tests using the [[Manual:Hooks/UnitTestsList|UnitTestsList hook]]. If your extension's test class names all contain a unique component (e.g. the extension's name), the <code>--filter</code> option may be used to run only your extension's tests.

# Run phpunit against the extension directory, where it will pick up any file ending in "Test.php".

 

Either of these will work fine if Scribunto is loaded in LocalSettings.php. And it is easy for method #1 to work if Scribunto is not loaded, as the UnitTestsList hook can easily be written to avoid returning the Scribunto test when <code>$wgAutoloadClasses['Scribunto_LuaEngineTestBase']</code> is not set.

 

But [[Jenkins]] uses method #2. For Jenkins to properly run the tests, you will need to add Scribunto as a dependency for your extension. See {{gerrit|56570}} for an example of how this is done.

 

If for some reason you need the tests to be able to run using method #2 without Scribunto loaded, one workaround is to add this check to the top of your unit test file:

 

return;

}

 

 

Modules included in Scribunto should include documentation in the [[#Scribunto libraries|Scribunto libraries]] section above. Extension libraries should include documentation in a subpage of their own Extension page, and link to that documentation from [[#Extension libraries (mw.ext)]].

 

*[[w:Lua (programming language)]]

 

 

This manual is derived from the [http://www.lua.org/manual/5.1/index.html Lua 5.1 reference manual], which is available under the [http://www.lua.org/license.html MIT license].

 

{{mbox

| type = license

Copyright © 1994–2012 Lua.org, PUC-Rio.

 

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

 

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

 

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

}}

 

This derivative manual may also be copied under the terms of the same license.

</translate>