Module:Arguments/doc: Difference between revisions
m 1 revision imported |
m 1 revision imported |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Used in system}} | {{Used in system}} | ||
{{Module rating|p}} | {{Module rating|p}} | ||
{{cascade-protected template|page=module}} | |||
This module provides easy processing of arguments passed from <code>#invoke</code>. It is a meta-module, meant for use by other modules, and should not be called from <code>#invoke</code> directly. Its features include: | This module provides easy processing of arguments passed from <code>#invoke</code>. It is a meta-module, meant for use by other modules, and should not be called from <code>#invoke</code> directly (for a module directly invocable by templates you might want to have a look at {{ml|params|}}). Its features include: | ||
* Easy trimming of arguments and removal of blank arguments. | * 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 by both the current frame and by the parent frame at the same time. (More details below.) | ||
| Line 31: | Line 32: | ||
=== Recommended practice === | === Recommended practice === | ||
However, the recommended practice is to use a function just for processing arguments | However, the recommended practice is to use a separate function as the entry point from <code>#invoke</code> just for processing the arguments. This allows other Lua modules to call your core logic directly, improving performance by avoiding the overhead of interacting with the <code>frame</code> object. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| Line 81: | Line 82: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== Options == | |||
The following options are available. They are explained in the sections below. | The following options are available. They are explained in the sections below. | ||
| Line 92: | Line 93: | ||
-- Code for processing one argument | -- Code for processing one argument | ||
end, | end, | ||
frameOnly = true, | frameOnly = true, | ||
parentOnly = true, | parentOnly = true, | ||
parentFirst = true, | parentFirst = true, | ||
wrappers = { | wrappers = { | ||
'Template:A wrapper template', | 'Template:A wrapper template', | ||
'Template:Another wrapper template' | 'Template:Another wrapper template' | ||
}, | }, | ||
readOnly = true, | readOnly = true, | ||
noOverwrite = true | noOverwrite = true | ||
| Line 104: | Line 108: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== Trimming | === Trimming whitespace === | ||
MediaWiki trims whitespace for named arguments coming from #invoke or a template call, but preserves whitespace for positional arguments. By default, this module helps trim whitespace also for position arguments. To preserve whitespace for positional arguments, set the <code>trim</code> option to <code>false</code>. | |||
<syntaxhighlight lang="lua"> | |||
local args = getArgs(frame, { | |||
trim = false | |||
}) | |||
</syntaxhighlight> | |||
When the <code>valueFunc</code> option is given, the <code>valueFunc</code> function will be responsible for trimming whitespace, and the <code>trim</code> option will have no effect. | |||
=== Removing blank arguments === | |||
"Blank arguments" are arguments from #invoke or template that are blank strings or consist of only whitespace. By default, this module removes all blank arguments. To preserve the blank arguments, set the <code>removeBlanks</code> option to <code>false</code>. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local args = getArgs(frame, { | local args = getArgs(frame, { | ||
removeBlanks = false | removeBlanks = false | ||
}) | }) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
This might be necessary for some templates' operation. | |||
Note: When converting MediaWiki templates to Lua, keep in mind that in Lua, blank strings and strings consisting only of whitespace are considered true. If you don't pay attention to such blank arguments when you write your Lua modules, you might treat something as true that should actually be treated as false. | |||
When the <code>valueFunc</code> option is given, the <code>valueFunc</code> function will be responsible for handling blank arguments, and the <code>removeBlanks</code> option will have no effect. | |||
=== Custom formatting of arguments === | === Custom formatting of arguments === | ||
| Line 123: | Line 140: | ||
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. | 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. | Example 1: this function preserves whitespace for the first positional argument's value, but trims all other arguments' value and removes all other blank arguments. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local args = getArgs(frame, { | local args = getArgs(frame, { | ||
| Line 140: | Line 157: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Example 2: this function removes blank arguments and converts all | Example 2: this function removes blank arguments and converts all argument values to lower case, but doesn't trim whitespace from positional parameters. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
local args = getArgs(frame, { | local args = getArgs(frame, { | ||
| Line 224: | Line 241: | ||
{{cob}} | {{cob}} | ||
<code>Template:ExampleArgs</code> contains the code <code><nowiki>{{#invoke:ExampleArgs|main|''firstInvokeArg''}}</nowiki></code>. | |||
Now if we were to call <code>Template:ExampleArgs</code>, the following would happen: | Now if we were to call <code>Template:ExampleArgs</code>, the following would happen: | ||
| Line 232: | Line 249: | ||
! style="width: 60%;" | Code | ! style="width: 60%;" | Code | ||
! style="width: 40%;" | Result | ! style="width: 40%;" | Result | ||
|- | |||
| <pre>{{#invoke:ExampleArgs|main|''firstInvokeArg''}} | |||
(call #invoke directly without template)</pre> | |||
| ''firstInvokeArg'' | |||
(call #invoke directly without template) | |||
|- | |- | ||
| <code><nowiki>{{ExampleArgs}}</nowiki></code> | | <code><nowiki>{{ExampleArgs}}</nowiki></code> | ||
| firstInvokeArg | | ''firstInvokeArg'' | ||
|- | |- | ||
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code> | | <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code> | ||
| firstInvokeArg | | ''firstInvokeArg'' | ||
|- | |- | ||
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code> | | <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code> | ||
| firstInvokeArg secondTemplateArg | | ''firstInvokeArg'' secondTemplateArg | ||
|} | |} | ||
| Line 252: | Line 276: | ||
|- | |- | ||
| <code><nowiki>{{ExampleArgs}}</nowiki></code> | | <code><nowiki>{{ExampleArgs}}</nowiki></code> | ||
| firstInvokeArg | | ''firstInvokeArg'' | ||
|- | |- | ||
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code> | | <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code> | ||
| firstInvokeArg | | ''firstInvokeArg'' | ||
|- | |- | ||
| <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code> | | <code><nowiki>{{ExampleArgs|firstTemplateArg|secondTemplateArg}}</nowiki></code> | ||
| firstInvokeArg | | ''firstInvokeArg'' | ||
|} | |} | ||
| Line 284: | Line 308: | ||
|- | |- | ||
| <code><nowiki>{{ExampleArgs}}</nowiki></code> | | <code><nowiki>{{ExampleArgs}}</nowiki></code> | ||
| firstInvokeArg | | ''firstInvokeArg'' | ||
|- | |- | ||
| <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code> | | <code><nowiki>{{ExampleArgs|firstTemplateArg}}</nowiki></code> | ||
| Line 321: | Line 345: | ||
}) | }) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
The <code>wrappers</code> option changes the default behaviors of the <code>frameOnly</code> and <code>parentOnly</code> options. | |||
{{collapse top|title=Behaviors of ''frameOnly'' and ''parentOnly'' in relations with wrapper templates}} | |||
; If <code>Template:ExampleArgs</code> is specified as a wrapper template: | |||
; <code>parentOnly</code> is true or not set | |||
The frame arguments will not be used at all. | |||
{| 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 | |||
|} | |||
; <code>parentOnly</code> is false, <code>parentFirst</code> is false or not set | |||
{| 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 | |||
|} | |||
; <code>parentOnly</code> is false, <code>parentFirst</code> is true | |||
{| 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 | |||
|} | |||
; If <code>wrappers</code> is set but <code>Template:ExampleArgs</code> is not in the <code>wrappers</code> list: | |||
; <code>frameOnly</code> is true or not set | |||
{| 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'' | |||
|} | |||
; <code>frameOnly</code> is false, <code>parentFirst</code> is false or not set | |||
{| 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 | |||
|} | |||
; <code>frameOnly</code> is false, <code>parentFirst</code> is true | |||
{| 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 | |||
|} | |||
{{collapse bottom}} | |||
Notes: | Notes: | ||
# The module will automatically detect if it is being called from a wrapper template's /sandbox subpage, so there is no need to specify sandbox pages explicitly. | # The module will automatically detect if it is being called from a wrapper template's /sandbox subpage, so there is no need to specify sandbox pages explicitly. | ||
# If the ''wrappers'' option is set and no parent frame is available, the module will always get the arguments from the frame passed to <code>getArgs</code>. | # If the ''wrappers'' option is set and no parent frame is available, the module will always get the arguments from the frame passed to <code>getArgs</code>. | ||
| Line 336: | Line 469: | ||
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. | ||
== Notes == | |||
=== Ref tags === | === Ref tags === | ||
| Line 350: | Line 485: | ||
[[Category:Lua metamodules]] | [[Category:Lua metamodules]] | ||
}}</includeonly> | }}</includeonly> | ||
== See also == | |||
* [[Module:Params]] | |||
* {{tl|Template parameter value}} | |||
<includeonly>{{Sandbox other|| | |||
<!-- Categories below this line; interwikis at Wikidata --> | |||
[[Category:Wikipedia utility modules]] | |||
}}</includeonly> | |||
<noinclude> | |||
[[Category:Module documentation pages]] | |||
</noinclude> | |||