विकिपिडिया

"मोड्युल:Arguments/कागजात" का संशोधनहरू बिचको अन्तर

अन्तरक्रियात्मक रूपमा इतिहास हेर्नुहोस्
पछिल्लो भिन्नता →
Content deleted Content added
दृश्यात्मकविकिपाठ
नयाँ पृष्ठ: {{High-risk|9,300,000+}} This module provides easy processing of arguments passed from #invoke. It is a meta-module, meant for use by other modules, and should not...
 
कुनै सम्पादन सारांश छैन
पङ्क्ति १:
{{Used in system}}
{{High-risk|9,300,000+}}
{{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:
Line ५ ⟶ ६:
* 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 {{tag|ref}} tags.
* Most features can be customized.
 
पङ्क्ति १२:
First, you need to load the module. It contains one function, named <code>getArgs</code>.
 
<sourcesyntaxhighlight lang="lua">
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.)
 
<sourcesyntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}
पङ्क्ति २८:
 
return p
</syntaxhighlight>
</source>
 
=== Recommended practice ===
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.
 
<sourcesyntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}
Line ४६ ⟶ ४७:
 
return p
</syntaxhighlight>
</source>
 
The way this is called from a template is <code><nowiki>{{#invoke:Example|main}}</nowiki></code> (optionally with some parameters like <code><nowiki>{{#invoke:Example|main|arg1=value1|arg2=value2}}</nowiki></code>), and the way this is called from a module is <syntaxhighlight lang=lua inline>require('Module:Example')._main({arg1 = 'value1', arg2 = value2, 'spaced arg3' = 'value3'})</syntaxhighlight>. What this second one does is construct a table with the arguments in it, then gives that table to the p._main(args) function, which uses it natively.
 
=== Multiple functions ===
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.
 
<sourcesyntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
 
local p = {}▼
 
local function makeInvokeFunc(funcName)
Line ५९ ⟶ ६५:
end
end
 
▲local p = {}
 
p.func1 = makeInvokeFunc('_func1')
Line ७५ ⟶ ७९:
 
return p
</syntaxhighlight>
</source>
 
=== Options ===
Line ८१ ⟶ ८५:
The following options are available. They are explained in the sections below.
 
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
trim = false,
Line ९८ ⟶ १०२:
noOverwrite = true
})
</syntaxhighlight>
</source>
 
=== Trimming and removing blanks ===
Line १०८ ⟶ ११२:
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>.
 
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
trim = false,
removeBlanks = false
})
</syntaxhighlight>
</source>
 
=== Custom formatting of arguments ===
Line १२० ⟶ १२४:
 
Example 1: this function preserves whitespace for the first positional argument, but trims all other arguments and removes all other blank arguments.
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
Line १३४ ⟶ १३८:
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.
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
Line १५० ⟶ १५४:
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).
Line १५६ ⟶ १६०:
{{cot|Examples 1 and 2 with type checking}}
Example 1:
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
Line १७३ ⟶ १७७:
end
})
</syntaxhighlight>
</source>
 
Example 2:
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
Line १९१ ⟶ १९५:
end
})
</syntaxhighlight>
</source>
{{cob}}
 
Line २०१ ⟶ २०५:
 
{{cot|Module:ExampleArgs code}}
<sourcesyntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}
Line २१७ ⟶ २२१:
 
return p
</syntaxhighlight>
</source>
{{cob}}
 
Line ३०१ ⟶ ३०५:
Wrappers can be specified either as a string, or as an array of strings.
 
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
wrappers = 'Template:Wrapper template'
})
</syntaxhighlight>
</source>
 
 
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
wrappers = {
Line ३१६ ⟶ ३२०:
}
})
</syntaxhighlight>
</source>
 
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 ''wrappers'' option overrideseffectively changes the default of the ''frameOnly'', and ''parentOnly'' andoptions. If, for example, ''parentFirstparentOnly'' options.were Ifexplicitly theset to 0 with ''wrappers'' optionset, iscalls setvia wrapper templates would result in both frame and parent arguments being loaded, nonethough ofcalls not via wrapper templates would result in themonly willframe havearguments anybeing effectloaded.
# 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 ३२७ ⟶ ३३१:
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.)
 
<sourcesyntaxhighlight lang="lua">
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.
Line ३३७ ⟶ ३४१:
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 -– a reference that appears in the reference list, but nowithout any number that linkslinking 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.
"https://ne.wikipedia.org/wiki/मोड्युल:Arguments/कागजात" बाट अनुप्रेषित