Module:Arguments/doc: Difference between revisions
From Mariopedia, a wiki on Mario, Yoshi, Wario, Donkey Kong, Super Smash Bros., and more!
Jump to navigationJump to search
Content deleted Content added
This doesn't count as a feature of the module, given that the naive "just ready arguments from the frame directly" supports it too |
m change source to syntaxhighlight |
||
Line 13: | Line 13: | ||
First, you need to load the module. It contains one function, named <code>getArgs</code>. |
First, you need to load the module. It contains one function, named <code>getArgs</code>. |
||
< |
<syntaxhighlight lang="lua"> |
||
local getArgs = require('Module:Arguments').getArgs |
local getArgs = require('Module:Arguments').getArgs |
||
</syntaxhighlight> |
|||
</source> |
|||
In the most basic scenario, you can use getArgs inside your main function. The variable <code>args</code> is a table containing the arguments from #invoke. (See below for details.) |
In the most basic scenario, you can use getArgs inside your main function. The variable <code>args</code> is a table containing the arguments from #invoke. (See below for details.) |
||
< |
<syntaxhighlight lang="lua"> |
||
local getArgs = require('Module:Arguments').getArgs |
local getArgs = require('Module:Arguments').getArgs |
||
local p = {} |
local p = {} |
||
Line 29: | Line 29: | ||
return p |
return p |
||
</syntaxhighlight> |
|||
</source> |
|||
However, the recommended practice is to use a function just for processing arguments from #invoke. 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. |
However, the recommended practice is to use a function just for processing arguments from #invoke. 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 getArgs = require('Module:Arguments').getArgs |
||
local p = {} |
local p = {} |
||
Line 47: | Line 47: | ||
return p |
return p |
||
</syntaxhighlight> |
|||
</source> |
|||
If you want multiple functions to use the arguments, and you also want them to be accessible from #invoke, you can use a wrapper function. |
If you want multiple functions to use the arguments, and you also want them to be accessible from #invoke, you can use a wrapper function. |
||
< |
<syntaxhighlight lang="lua"> |
||
local getArgs = require('Module:Arguments').getArgs |
local getArgs = require('Module:Arguments').getArgs |
||
Line 76: | Line 76: | ||
return p |
return p |
||
</syntaxhighlight> |
|||
</source> |
|||
=== Options === |
=== Options === |
||
Line 82: | Line 82: | ||
The following options are available. They are explained in the sections below. |
The following options are available. They are explained in the sections below. |
||
< |
<syntaxhighlight lang="lua"> |
||
local args = getArgs(frame, { |
local args = getArgs(frame, { |
||
trim = false, |
trim = false, |
||
Line 99: | Line 99: | ||
noOverwrite = true |
noOverwrite = true |
||
}) |
}) |
||
</syntaxhighlight> |
|||
</source> |
|||
=== Trimming and removing blanks === |
=== Trimming and removing blanks === |
||
Line 109: | Line 109: | ||
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>. |
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, { |
local args = getArgs(frame, { |
||
trim = false, |
trim = false, |
||
removeBlanks = false |
removeBlanks = false |
||
}) |
}) |
||
</syntaxhighlight> |
|||
</source> |
|||
=== Custom formatting of arguments === |
=== Custom formatting of arguments === |
||
Line 121: | Line 121: | ||
Example 1: this function preserves whitespace for the first positional argument, but trims all other arguments and removes all other blank arguments. |
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, { |
local args = getArgs(frame, { |
||
valueFunc = function (key, value) |
valueFunc = function (key, value) |
||
Line 135: | Line 135: | ||
end |
end |
||
}) |
}) |
||
</syntaxhighlight> |
|||
</source> |
|||
Example 2: this function removes blank arguments and converts all arguments to lower case, but doesn't trim whitespace from positional parameters. |
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, { |
local args = getArgs(frame, { |
||
valueFunc = function (key, value) |
valueFunc = function (key, value) |
||
Line 151: | Line 151: | ||
end |
end |
||
}) |
}) |
||
</syntaxhighlight> |
|||
</source> |
|||
Note: 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 #invoke (i.e. you have <code>p.main</code> and <code>p._main</code> functions, or something similar). |
Note: 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 #invoke (i.e. you have <code>p.main</code> and <code>p._main</code> functions, or something similar). |
||
Line 157: | Line 157: | ||
{{cot|Examples 1 and 2 with type checking}} |
{{cot|Examples 1 and 2 with type checking}} |
||
Example 1: |
Example 1: |
||
< |
<syntaxhighlight lang="lua"> |
||
local args = getArgs(frame, { |
local args = getArgs(frame, { |
||
valueFunc = function (key, value) |
valueFunc = function (key, value) |
||
Line 174: | Line 174: | ||
end |
end |
||
}) |
}) |
||
</syntaxhighlight> |
|||
</source> |
|||
Example 2: |
Example 2: |
||
< |
<syntaxhighlight lang="lua"> |
||
local args = getArgs(frame, { |
local args = getArgs(frame, { |
||
valueFunc = function (key, value) |
valueFunc = function (key, value) |
||
Line 192: | Line 192: | ||
end |
end |
||
}) |
}) |
||
</syntaxhighlight> |
|||
</source> |
|||
{{cob}} |
{{cob}} |
||
Line 202: | Line 202: | ||
{{cot|Module:ExampleArgs code}} |
{{cot|Module:ExampleArgs code}} |
||
< |
<syntaxhighlight lang="lua"> |
||
local getArgs = require('Module:Arguments').getArgs |
local getArgs = require('Module:Arguments').getArgs |
||
local p = {} |
local p = {} |
||
Line 218: | Line 218: | ||
return p |
return p |
||
</syntaxhighlight> |
|||
</source> |
|||
{{cob}} |
{{cob}} |
||
Line 302: | Line 302: | ||
Wrappers can be specified either as a string, or as an array of strings. |
Wrappers can be specified either as a string, or as an array of strings. |
||
< |
<syntaxhighlight lang="lua"> |
||
local args = getArgs(frame, { |
local args = getArgs(frame, { |
||
wrappers = 'Template:Wrapper template' |
wrappers = 'Template:Wrapper template' |
||
}) |
}) |
||
</syntaxhighlight> |
|||
</source> |
|||
< |
<syntaxhighlight lang="lua"> |
||
local args = getArgs(frame, { |
local args = getArgs(frame, { |
||
wrappers = { |
wrappers = { |
||
Line 317: | Line 317: | ||
} |
} |
||
}) |
}) |
||
</syntaxhighlight> |
|||
</source> |
|||
Notes: |
Notes: |
||
Line 328: | Line 328: | ||
Sometimes it can be useful to write new values to the args 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 args table as needed.) |
Sometimes it can be useful to write new values to the args 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 args table as needed.) |
||
< |
<syntaxhighlight lang="lua"> |
||
args.foo = 'some value' |
args.foo = 'some value' |
||
</syntaxhighlight> |
|||
</source> |
|||
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 args 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 #invoke. |
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 args 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 #invoke. |