Википедия

Модуль:Arguments/doc: Версиязда гьоркьор батӀалъиял

Интерактивная навигация по истории
Хадусеб хисизаби →
Контент гилдана Контент жубана
ВизуальныйВики-текст
документация
 
гI.-м. Bot: Replace deprecated <source> tag and "enclose" parameter; косметические изменения
Мухъ 13:
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 = {}
Мухъ 29:
 
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.
 
<sourcesyntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}
Мухъ 47:
 
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.
 
<sourcesyntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
 
Мухъ 76:
 
return p
</syntaxhighlight>
</source>
 
=== Options ===
Мухъ 82:
The following options are available. They are explained in the sections below.
 
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
trim = false,
Мухъ 99:
noOverwrite = true
})
</syntaxhighlight>
</source>
 
=== Trimming and removing blanks ===
Мухъ 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>.
 
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
trim = false,
removeBlanks = false
})
</syntaxhighlight>
</source>
 
=== Custom formatting of arguments ===
Мухъ 121:
 
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)
Мухъ 135:
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)
Мухъ 151:
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).
Мухъ 157:
{{Начало скрытого блока|Рамка = |Фон_заголовка =|Examples 1 and 2 with type checking}}
Example 1:
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
Мухъ 174:
end
})
</syntaxhighlight>
</source>
 
Example 2:
<sourcesyntaxhighlight lang="lua">
local args = getArgs(frame, {
valueFunc = function (key, value)
Мухъ 192:
end
})
</syntaxhighlight>
</source>
{{конец скрытого блока}}
 
Мухъ 202:
 
{{Начало скрытого блока|Рамка = |Фон_заголовка =|Module:ExampleArgs code}}
<sourcesyntaxhighlight lang="lua">
local getArgs = require('Module:Arguments').getArgs
local p = {}
Мухъ 218:
 
return p
</syntaxhighlight>
</source>
{{конец скрытого блока}}
 
Мухъ 298:
The ''wrappers'' 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 getArgs. This allows modules to be called by either #invoke 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 [[TemplateШаблон:Side box]] (excluding content in {{tag|noinclude}} tags) is <code><nowiki>{{#invoke:Side box|main}}</nowiki></code>. There is no point in checking the arguments passed directly to the #invoke statement for this template, as no arguments will ever be specified there. We can avoid checking arguments passed to #invoke by using the ''parentOnly'' option, but if we do this then #invoke will not work from other pages either. If this were the case, the {{para|text|Some text}} in the code <code><nowiki>{{#invoke:Side box|main|text=Some text}}</nowiki></code> would be ignored completely, no matter what page it was used from. By using the <code>wrappers</code> option to specify 'Template:Side box' as a wrapper, we can make <code><nowiki>{{#invoke:Side box|main|text=Some text}}</nowiki></code> work from most pages, while still not requiring that the module check for arguments on the [[TemplateШаблон:Side box]] page itself.
 
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 = {
Мухъ 317:
}
})
</syntaxhighlight>
</source>
 
Notes:
Мухъ 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.)
 
<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.
Босараб бакӀ — «https://av.wikipedia.org/wiki/Модуль:Arguments/doc»