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
No edit summary |
removed two unneeded tags |
||
(21 intermediate revisions by 17 users not shown) | |||
Line 1: | Line 1: | ||
{{High-risk|19,241,210 pages, which is {{#expr:(1924121000/{{NUMBEROFPAGES:R}}) round 0}}% of all}} |
|||
{{Used in system}} |
{{Used in system}} |
||
{{Module rating|p}} |
|||
This module provides easy processing of arguments passed from #invoke. It is a meta-module, meant for use by other modules, and should not be called from #invoke directly. Its features include: |
This module provides easy processing of arguments passed from #invoke. It is a meta-module, meant for use by other modules, and should not be called from #invoke directly. Its features include: |
||
Line 7: | Line 5: | ||
* 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 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 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 {{tag|ref}} tags. |
|||
* Most features can be customized. |
* Most features can be customized. |
||
Line 14: | Line 11: | ||
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 30: | Line 27: | ||
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 48: | Line 45: | ||
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 |
||
⚫ | |||
local function makeInvokeFunc(funcName) |
local function makeInvokeFunc(funcName) |
||
Line 61: | Line 60: | ||
end |
end |
||
end |
end |
||
⚫ | |||
p.func1 = makeInvokeFunc('_func1') |
p.func1 = makeInvokeFunc('_func1') |
||
Line 77: | Line 74: | ||
return p |
return p |
||
</syntaxhighlight> |
|||
</source> |
|||
=== Options === |
=== Options === |
||
Line 83: | Line 80: | ||
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 100: | Line 97: | ||
noOverwrite = true |
noOverwrite = true |
||
}) |
}) |
||
</syntaxhighlight> |
|||
</source> |
|||
=== Trimming and removing blanks === |
=== Trimming and removing blanks === |
||
Line 110: | Line 107: | ||
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 122: | Line 119: | ||
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 136: | Line 133: | ||
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 152: | Line 149: | ||
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 158: | Line 155: | ||
{{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 175: | Line 172: | ||
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 193: | Line 190: | ||
end |
end |
||
}) |
}) |
||
</syntaxhighlight> |
|||
</source> |
|||
|} |
|||
{{cob}} |
|||
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. |
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. |
||
Line 203: | Line 200: | ||
{{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 219: | Line 216: | ||
return p |
return p |
||
</syntaxhighlight> |
|||
</source> |
|||
|} |
|||
{{cob}} |
|||
<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". |
<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". |
||
Line 303: | Line 300: | ||
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 318: | Line 315: | ||
} |
} |
||
}) |
}) |
||
</syntaxhighlight> |
|||
</source> |
|||
Notes: |
Notes: |
||
Line 329: | Line 326: | ||
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. |
||
=== Ref tags === |
=== Ref tags === |
||
This module uses [[mw:Extension:Scribunto/Lua reference manual#Metatables|metatables]] to fetch arguments from #invoke. 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 {{tag|ref}} tags as input. |
This module uses [[mw:Extension:Scribunto/Lua reference manual#Metatables|metatables]] to fetch arguments from #invoke. 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 {{tag|ref}} tags as input. |
||
As soon as {{tag|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 |
As soon as {{tag|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 without any number linking 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. |
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. |
||
Line 347: | Line 343: | ||
The use of metatables also has its downsides. Most of the normal Lua table tools won't work properly on the args table, including the <code>#</code> operator, the <code>next()</code> function, and the functions in the table library. If using these is important for your module, you should use your own argument processing function instead of this module.<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| |
The use of metatables also has its downsides. Most of the normal Lua table tools won't work properly on the args table, including the <code>#</code> operator, the <code>next()</code> function, and the functions in the table library. If using these is important for your module, you should use your own argument processing function instead of this module.<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| |
||
[[Category:Lua metamodules]] |
[[Category:Lua metamodules]] |
||
}}</includeonly> |
}}</includeonly> |