View source for Module:Arguments/doc/en

<noinclude><!--
-->{{#ifeq:{{SUBPAGENAME}}|doc||{{Documentation subpage}}}}<!--
--><languages /><!--
--></noinclude>{{#switch:
| =
<includeonly>{{Languages|Module:Arguments/doc}}</includeonly>
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Shared Template Warning|Module:Arguments|Module:Arguments}}
{{Used in system}}
{{Module rating|release}}
{{Module rating|protected}}

This module provides easy processing of arguments passed from {{Magic word|#invoke|...|ext=Scribunto|code=1|nowrap=1}}.
It is a meta-module, meant for use by other modules, and should not be called from {{tlc|<nowiki>#invoke:...</nowiki>}} directly.
Its features include:

* Easy trimming of arguments and removal of blank arguments.
* Arguments can be passed by both the current frame and by the parent frame at the same time. (More details below.)
* Arguments can be passed in directly from another Lua module or from the debug console.
* Arguments are fetched as needed, which can help avoid (some) problems with {{xtag|ref}} tags.
* Most features can be customized.

== Basic use ==
First, you need to load the module.
It contains one function, named <code>getArgs</code>.

<syntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
</syntaxhighlight>

In the most basic scenario, you can use <code>getArgs</code> inside your main function.
The variable <code>args</code> is a table containing the arguments from {{tlc|<nowiki>#invoke:...</nowiki>}}.
(See below for details.)

<syntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	-- Main module code goes here.
end

return p
</syntaxhighlight>

However, the recommended practice is to use a function just for processing arguments from {{tlc|<nowiki>#invoke:...</nowiki>}}.
This means that if someone calls your module from another Lua module you don't have to have a frame object available, which improves performance.

<syntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args)
end

function p._main(args)
	-- Main module code goes here.
end

return p
</syntaxhighlight>

If you want multiple functions to use the arguments, and you also want them to be accessible from {{tlc|<nowiki>#invoke:...</nowiki>}}, you can use a wrapper function.

<syntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs

local p = {}

local function makeInvokeFunc(funcName)
	return function (frame)
		local args = getArgs(frame)
		return p[funcName](args)
	end
end

p.func1 = makeInvokeFunc('_func1')

function p._func1(args)
	-- Code for the first function goes here.
end

p.func2 = makeInvokeFunc('_func2')

function p._func2(args)
	-- Code for the second function goes here.
end

return p
</syntaxhighlight>

=== Options ===
The following options are available.
They are explained in the sections below.

<syntaxhighlight lang="lua">
local args = getArgs(frame, {
	trim = false,
	removeBlanks = false,
	valueFunc = function (key, value)
		-- Code for processing one argument
	end,
	frameOnly = true,
	parentOnly = true,
	parentFirst = true,
	wrappers = {
		'Template:A wrapper template',
		'Template:Another wrapper template'
	},
	readOnly = true,
	noOverwrite = true
})
</syntaxhighlight>

=== Trimming and removing blanks ===
Blank arguments often trip up coders new to converting MediaWiki templates to Lua.
In template syntax, blank strings and strings consisting only of whitespace are considered <code>false</code>.
However, in Lua, blank strings and strings consisting of whitespace are considered <code>true</code>.
This means that if you don't pay attention to such arguments when you write your Lua modules, you might treat something as <code>true</code> that should actually be treated as <code>false</code>.
To avoid this, by default this module removes all blank arguments.

Similarly, whitespace can cause problems when dealing with positional arguments.
Although whitespace is trimmed for named arguments coming from {{tlc|<nowiki>#invoke:...</nowiki>}}, it is preserved for positional arguments.
Most of the time this additional whitespace is not desired, so this module trims it off by default.

However, sometimes you want to use blank arguments as input, and sometimes you want to keep additional whitespace.
This can be necessary to convert some templates exactly as they were written.
If you want to do this, you can set the <code>trim</code> and <code>removeBlanks</code> arguments to <code>false</code>.

<syntaxhighlight lang="lua">
local args = getArgs(frame, {
	trim = false,
	removeBlanks = false
})
</syntaxhighlight>

=== Custom formatting of arguments ===
Sometimes you want to remove some blank arguments but not others, or perhaps you might want to put all of the positional arguments in lower case.
To do things like this you can use the <code>valueFunc</code> option.
The input to this option must be a function that takes two parameters, <code>key</code> and <code>value</code>, and returns a single value.
This value is what you will get when you access the field <code>key</code> in the <code>args</code> table.

'''Example 1:'''
This function preserves whitespace for the first positional argument, but trims all other arguments and removes all other blank arguments.

<syntaxhighlight lang="lua">
local args = getArgs(frame, {
	valueFunc = function (key, value)
		if key == 1 then
			return value
		elseif value then
			value = mw.text.trim(value)
			if value ~= '' then
				return value
			end
		end
		return nil
	end
})
</syntaxhighlight>

'''Example 2:'''
This function removes blank arguments and converts all arguments to lower case, but doesn't trim whitespace from positional parameters.

<syntaxhighlight lang="lua">
local args = getArgs(frame, {
	valueFunc = function (key, value)
		if not value then
			return nil
		end
		value = mw.ustring.lower(value)
		if mw.ustring.find(value, '%S') then
			return value
		end
		return nil
	end
})
</syntaxhighlight>

{{Note|text=
The above functions will fail if passed input that is not of type <code>string</code> or <code>nil</code>.
This might be the case if you use the <code>getArgs</code> function in the main function of your module, and that function is called by another Lua module.
In this case, you will need to check the type of your input.
This is not a problem if you are using a function specially for arguments from {{tlc|<nowiki>#invoke:...</nowiki>}} (i.e. you have <code>p.main</code> and <code>p._main</code> functions, or something similar).
}}

{{Collapse top|1=Examples 1 and 2 with type checking}}
Example 1:
<syntaxhighlight lang="lua">
local args = getArgs(frame, {
	valueFunc = function (key, value)
		if key == 1 then
			return value
		elseif type(value) == 'string' then
			value = mw.text.trim(value)
			if value ~= '' then
				return value
			else
				return nil
			end
		else
			return value
		end
	end
})
</syntaxhighlight>

Example 2:
<syntaxhighlight lang="lua">
local args = getArgs(frame, {
	valueFunc = function (key, value)
		if type(value) == 'string' then
			value = mw.ustring.lower(value)
			if mw.ustring.find(value, '%S') then
				return value
			else
				return nil
			end
		else
			return value
		end
	end
})
</syntaxhighlight>
{{Collapse bottom}}

Also, please note that the <code>valueFunc</code> function is called more or less every time an argument is requested from the <code>args</code> table, so if you care about performance you should make sure you aren't doing anything inefficient with your code.

=== Frames and parent frames ===

Arguments in the <code>args</code> table can be passed from the current frame or from its parent frame at the same time.
To understand what this means, it is easiest to give an example.
Let's say that we have a module called <code>Module:ExampleArgs</code>.
This module prints the first two positional arguments that it is passed.

{{Collapse top|1=Module:ExampleArgs code}}
<syntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args)
end

function p._main(args)
	local first = args[1] or ''
	local second = args[2] or ''
	return first .. ' ' .. second
end

return p
</syntaxhighlight>
{{Collapse bottom}}

<code>Module:ExampleArgs</code> is then called by <code>Template:ExampleArgs</code>, which contains the code <code><nowiki>{{#invoke:ExampleArgs|main|firstInvokeArg}}</nowiki></code>.
This produces the result "firstInvokeArg".

Now if we were to call <code>Template:ExampleArgs</code>, the following would happen:

{{(!}} class="wikitable" style="width: 50em; max-width: 100%;"
{{!}}-
! style="width: 60%;" {{!}} Code
! style="width: 40%;" {{!}} Result
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs}}</nowiki></code>
{{!}} firstInvokeArg
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
{{!}} firstInvokeArg
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
{{!}} firstInvokeArg secondTemplateArg
{{!)}}

There are three options you can set to change this behaviour: <code>frameOnly</code>, <code>parentOnly</code> and <code>parentFirst</code>.
If you set <code>frameOnly</code> then only arguments passed from the current frame will be accepted; if you set <code>parentOnly</code> then only arguments passed from the parent frame will be accepted; and if you set <code>parentFirst</code> then arguments will be passed from both the current and parent frames, but the parent frame will have priority over the current frame.
Here are the results in terms of <code>Template:ExampleArgs</code>:

<dl>
<dt><code>frameOnly</code></dt>
<dd>
{{(!}} class="wikitable" style="width: 50em; max-width: 100%;"
{{!}}-
! style="width: 60%;" {{!}} Code
! style="width: 40%;" {{!}} Result
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs}}</nowiki></code>
{{!}} firstInvokeArg
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
{{!}} firstInvokeArg
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
{{!}} firstInvokeArg
{{!)}}
</dd>

<dt><code>parentOnly</code></dt>
<dd>
{{(!}} class="wikitable" style="width: 50em; max-width: 100%;"
{{!}}-
! style="width: 60%;" {{!}} Code
! style="width: 40%;" {{!}} Result
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs}}</nowiki></code>
{{!}}
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
{{!}} firstTemplateArg
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
{{!}} firstTemplateArg secondTemplateArg
{{!)}}
</dd>

<dt><code>parentFirst</code></dt>
<dd>
{{(!}} class="wikitable" style="width: 50em; max-width: 100%;"
{{!}}-
! style="width: 60%;" {{!}} Code
! style="width: 40%;" {{!}} Result
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs}}</nowiki></code>
{{!}} firstInvokeArg
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code>
{{!}} firstTemplateArg
{{!}}-
{{!}} <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code>
{{!}} firstTemplateArg secondTemplateArg
{{!)}}
</dd>
</dl>

{{Note|text=
{{Ordered list
|1=
If you set both the <code>frameOnly</code> and <code>parentOnly</code> options, the module won't fetch any arguments at all from {{tlc|<nowiki>#invoke:...</nowiki>}}.
This is probably not what you want.
|2=
In some situations a parent frame may not be available, e.g. if <code>getArgs</code> is passed the parent frame rather than the current frame.
In this case, only the frame arguments will be used (unless <code>parentOnly</code> is set, in which case no arguments will be used) and the <code>parentFirst</code> and <code>frameOnly</code> options will have no effect.
}}
}}

=== Wrappers ===

The <code>wrappers</code> option is used to specify a limited number of templates as ''wrapper templates'', that is, templates whose only purpose is to call a module.
If the module detects that it is being called from a wrapper template, it will only check for arguments in the parent frame; otherwise it will only check for arguments in the frame passed to <code>getArgs</code>.
This allows modules to be called by either {{tlc|<nowiki>#invoke:...</nowiki>}} or through a wrapper template without the loss of performance associated with having to check both the frame and the parent frame for each argument lookup.

For example, the only content of {{tlx|Navbox}} (excluding content in {{tag|noinclude}} tags) is <code><nowiki>{{#invoke:Navbox|navbox}}</nowiki></code>.
There is no point in checking the arguments passed directly to the {{tlc|<nowiki>#invoke:...</nowiki>}} statement for this template, as no arguments will ever be specified there.
We can avoid checking arguments passed to {{tlc|<nowiki>#invoke:...</nowiki>}} by using the <code>parentOnly</code> option, but if we do this then {{tlc|<nowiki>#invoke:...</nowiki>}} will not work from other pages either.
If this were the case, then {{tmpl|0={{para|text|$1}}|Some text}} in the code {{tmpl|0={{tlc|<nowiki>#invoke:Navbox</nowiki>|navbox|3=text=$1}}|Some text}} would be ignored completely, no matter what page it was used from.
By using the <code>wrappers</code> option to specify [[Template:Navbox]] as a wrapper, we can make {{tmpl|0={{tlc|<nowiki>#invoke:Navbox</nowiki>|main|3=text=$1}}|Some text}} work from most pages, while still not requiring that the module check for arguments on the [[Template:Navbox]] page itself.

Wrappers can be specified either as a string, or as an array of strings.

<syntaxhighlight lang="lua">
local args = getArgs(frame, {
	wrappers = 'Template:Wrapper template'
})
</syntaxhighlight>

<syntaxhighlight lang="lua">
local args = getArgs(frame, {
	wrappers = {
		'Template:Wrapper 1',
		'Template:Wrapper 2',
		-- Any number of wrapper templates can be added here.
	}
})
</syntaxhighlight>

{{Note|text=
{{Ordered list
|1=
The module will automatically detect if it is being called from a wrapper template's <code>/sandbox</code> subpage, so there is no need to specify sandbox pages explicitly.
|2=
The <code>wrappers</code> option effectively changes the default of the <code>frameOnly</code> and <code>parentOnly</code> options.
If, for example, <code>parentOnly</code> were explicitly set to <code>false</code> with <code>wrappers</code> set, calls via wrapper templates would result in both frame and parent arguments being loaded, though calls not via wrapper templates would result in only frame arguments being loaded.
|3=
If the <code>wrappers</code> option is set and no parent frame is available, the module will always get the arguments from the frame passed to <code>getArgs</code>.
}}
}}

=== Writing to the <code>args</code> table ===
Sometimes it can be useful to write new values to the <code>args</code> table.
This is possible with the default settings of this module.
(However, bear in mind that it is usually better coding style to create a new table with your new values and copy arguments from the <code>args</code> table as needed.)

<syntaxhighlight lang="lua">
args.foo = 'some value'
</syntaxhighlight>

It is possible to alter this behaviour with the <code>readOnly</code> and <code>noOverwrite</code> options.
If <code>readOnly</code> is set then it is not possible to write any values to the <code>args</code> table at all.
If <code>noOverwrite</code> is set, then it is possible to add new values to the table, but it is not possible to add a value if it would overwrite any arguments that are passed from {{tlc|<nowiki>#invoke:...</nowiki>}}.

=== Ref tags ===
This module uses [[mw:Special:MyLanguage/Extension:Scribunto/Lua reference manual#Metatables|metatables]] to fetch arguments from {{tlc|<nowiki>#invoke:...</nowiki>}}.
This allows access to both the frame arguments and the parent frame arguments without using the <code>pairs()</code> function.
This can help if your module might be passed {{xtag|ref}} tags as input.

As soon as {{xtag|ref}} tags are accessed from Lua, they are processed by the MediaWiki software and the reference will appear in the reference list at the bottom of the article.
If your module proceeds to omit the reference tag from the output, you will end up with a phantom reference - a reference that appears in the reference list, but no number that links to it.
This has been a problem with modules that use <code>pairs()</code> to detect whether to use the arguments from the frame or the parent frame, as those modules automatically process every available argument.

This module solves this problem by allowing access to both frame and parent frame arguments, while still only fetching those arguments when it is necessary.
The problem will still occur if you use <code>pairs(args)</code> elsewhere in your module, however.

=== Known limitations ===
The use of metatables also has its downsides.
Most of the normal Lua table tools won't work properly on the <code>args</code> table, including the <code>#</code> operator, the <code>next()</code> function, and the functions in the <code>table</code> library.
If using these is important for your module, you should use your own argument processing function instead of this module.

== Tests ==
{{ModuleQuality}}
<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Lua metamodules{{#translation:}}]]
}}</includeonly><noinclude>
[[Category:Module documentation pages{{#translation:}}]]
</noinclude>
| #default=
  {{#invoke:Template translation|renderTranslatedTemplate|template=Module:Arguments/doc|noshift=1|uselang={{int:lang}}}}
}}