Module:Arguments/dok

Peringatan:

Jangan disunting. Halaman ini dikelola dengan perkakas otomatis. Semua suntingan harus dilakukan di mediawiki.org. (bantu terjemahkan peringatan ini) Anda bisa membantu menerjemahkan halaman ini.

Modul ini menyediakan pengolahan mudah untuk argumen yang diteruskan dari Template:Magic word. Ini adalah meta-modul, yang dimaksudkan untuk digunakan oleh modul lain, dan tidak boleh dipanggil langsung dari {{#invoke:...}}. Fitur-fiturnya termasuk:

• Pemangkasan argumen yang mudah dan pencopotan argumen kosong.
• Argumen dapat diteruskan baik oleh bingkai saat ini maupun oleh bingkai induk secara bersamaan. (Rincian lebih di bawah.)
• Argumen dapat diteruskan langsung dari modul Lua lain atau dari konsol debug.
• Argumen diambil sesuai kebutuhan, yang dapat membantu menghindari (beberapa) masalah dengan tag Template:Xtag.
• Sebagian besar dapat disesuaikan.

Penggunaan dasar

Pertama, Anda perlu memuat modulnya. Ia berisi satu fungsi, bernama getArgs.

local getArgs = require('Module:Arguments').getArgs

Dalam skenario paling dasar, Anda dapat menggunakan getArgs di dalam fungsi utama Anda. Variabel args adalah tabel yang berisi argumen dari {{#invoke:...}}. (Lihat di bawah untuk rincian.)

local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	-- Kode modul utama ada di sini.
end

return p

Namun, praktik yang disarankan adalah menggunakan fungsi hanya untuk mengolah argumen dari {{#invoke:...}}. Ini berarti bahwa jika seseorang memanggil modul Anda dari modul Lua lain, Anda tidak perlu menyediakan objek bingkai, sehingga meningkatkan kinerja.

local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args)
end

function p._main(args)
	-- Kode modul utama ada di sini.
end

return p

Jika Anda ingin rangkap fungsi menggunakan argumen yang sama, dan Anda juga ingin fungsi-fungsi tersebut dapat diakses dari {{#invoke:...}}, Anda dapat menggunakan fungsi pembungkus.

local getArgs = require('Module:Arguments').getArgs

local p = {}

local function makeInvokeFunc(funcName)
	return function (frame)
		local args = getArgs(frame)
		return p[funcName](args)
	end
end

p.func1 = makeInvokeFunc('_func1')

function p._func1(args)
	-- Kode untuk fungsi pertama ada di sini.
end

p.func2 = makeInvokeFunc('_func2')

function p._func2(args)
	-- Kode untuk fungsi kedua ada di sini.
end

return p

Pilihan

Pilihan-pilihan berikut tersedia. Penjelasannya terdapat pada bagian-bagian di bawah ini.

local args = getArgs(frame, {
	trim = false,
	removeBlanks = false,
	valueFunc = function (key, value)
		-- Kode untuk mengolah satu argumen
	end,
	frameOnly = true,
	parentOnly = true,
	parentFirst = true,
	wrappers = {
		'Template:A wrapper template',
		'Template:Another wrapper template'
	},
	readOnly = true,
	noOverwrite = true
})

Memangkas dan mencopot bagian kosong

Argumen kosong seringkali membingungkan para pemrogram yang baru pertama kali mengonversi templat MediaWiki ke Lua. Dalam sintaks templat, untaian kosong dan untaian yang hanya terdiri dari spasi dianggap sebagai false. Namun, dalam Lua, untaian kosong dan untaian yang terdiri dari spasi dianggap sebagai true. Artinya, jika Anda tidak memperhatikan argumen demikian saat menulis modul Lua Anda, Anda mungkin memperlakukan sesuatu sebagai true padahal seharusnya diperlakukan sebagai false. Untuk menghindari hal ini, secara bawaan modul ini menghapus semua argumen kosong.

Demikian pula, spasi dapat menyebabkan masalah saat berurusan dengan argumen posisional. Meskipun spasi dipangkas untuk argumen bernama yang berasal dari {{#invoke:...}}, spasi tersebut dipertahankan untuk argumen posisional. Sebagian besar waktu, spasi tambahan ini tidak diinginkan, jadi modul ini akan memangkasnya secara bawaan.

Namun, terkadang Anda ingin menggunakan argumen kosong sebagai masukan, dan terkadang Anda ingin mempertahankan spasi tambahan. Ini mungkin diperlukan untuk mengonversi beberapa templat persis seperti yang ditulis sebelumnya. Jika Anda ingin melakukan ini, Anda dapat mengatur argumen trim dan removeBlanks menjadi false.

local args = getArgs(frame, {
	trim = false,
	removeBlanks = false
})

Pemformatan argumen kustom

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 valueFunc option. The input to this option must be a function that takes two parameters, key and value, and returns a single value. This value is what you will get when you access the field key in the args table.

Example 1: This function preserves whitespace for the first positional argument, but trims all other arguments and removes all other blank arguments.

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if key == 1 then
			return value
		elseif value then
			value = mw.text.trim(value)
			if value ~= '' then
				return value
			end
		end
		return nil
	end
})

Example 2: This function removes blank arguments and converts all arguments to lower case, but doesn't trim whitespace from positional parameters.

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if not value then
			return nil
		end
		value = mw.ustring.lower(value)
		if mw.ustring.find(value, '%S') then
			return value
		end
		return nil
	end
})

Examples 1 and 2 with type checking

Example 1:

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if key == 1 then
			return value
		elseif type(value) == 'string' then
			value = mw.text.trim(value)
			if value ~= '' then
				return value
			else
				return nil
			end
		else
			return value
		end
	end
})

Example 2:

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if type(value) == 'string' then
			value = mw.ustring.lower(value)
			if mw.ustring.find(value, '%S') then
				return value
			else
				return nil
			end
		else
			return value
		end
	end
})

Also, please note that the valueFunc function is called more or less every time an argument is requested from the args table, so if you care about performance you should make sure you aren't doing anything inefficient with your code.

Arguments in the args table can be passed from the current frame or from its parent frame at the same time. To understand what this means, it is easiest to give an example. Let's say that we have a module called Module:ExampleArgs. This module prints the first two positional arguments that it is passed.

Module:ExampleArgs code

local getArgs = require('Module:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args)
end

function p._main(args)
	local first = args[1] or ''
	local second = args[2] or ''
	return first .. ' ' .. second
end

return p

Module:ExampleArgs is then called by Template:ExampleArgs, which contains the code {{#invoke:ExampleArgs|main|firstInvokeArg}}. This produces the result "firstInvokeArg".

Now if we were to call Template:ExampleArgs, the following would happen:

Template:(! class="wikitable" style="width: 50em; max-width: 100%;" |- ! style="width: 60%;" | Code ! style="width: 40%;" | Result |- | {{ExampleArgs}} | firstInvokeArg |- | {{ExampleArgs|firstTemplateArg}} | firstInvokeArg |- | {{ExampleArgs|firstTemplateArg|secondTemplateArg}} | firstInvokeArg secondTemplateArg Template:!)

There are three options you can set to change this behaviour: frameOnly, parentOnly and parentFirst. If you set frameOnly then only arguments passed from the current frame will be accepted; if you set parentOnly then only arguments passed from the parent frame will be accepted; and if you set parentFirst then arguments will be passed from both the current and parent frames, but the parent frame will have priority over the current frame. Here are the results in terms of Template:ExampleArgs:

frameOnly

Template:(! class="wikitable" style="width: 50em; max-width: 100%;" |- ! style="width: 60%;" | Code ! style="width: 40%;" | Result |- | {{ExampleArgs}} | firstInvokeArg |- | {{ExampleArgs|firstTemplateArg}} | firstInvokeArg |- | {{ExampleArgs|firstTemplateArg|secondTemplateArg}} | firstInvokeArg Template:!)

parentOnly

Template:(! class="wikitable" style="width: 50em; max-width: 100%;" |- ! style="width: 60%;" | Code ! style="width: 40%;" | Result |- | {{ExampleArgs}} | |- | {{ExampleArgs|firstTemplateArg}} | firstTemplateArg |- | {{ExampleArgs|firstTemplateArg|secondTemplateArg}} | firstTemplateArg secondTemplateArg Template:!)

parentFirst

Template:(! class="wikitable" style="width: 50em; max-width: 100%;" |- ! style="width: 60%;" | Code ! style="width: 40%;" | Result |- | {{ExampleArgs}} | firstInvokeArg |- | {{ExampleArgs|firstTemplateArg}} | firstTemplateArg |- | {{ExampleArgs|firstTemplateArg|secondTemplateArg}} | firstTemplateArg secondTemplateArg Template:!)

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 {{Navbox}} (excluding content in <noinclude>...</noinclude> tags) is {{#invoke:Navbox|navbox}}. 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, then Template:Tmpl in the code Template:Tmpl would be ignored completely, no matter what page it was used from. By using the wrappers option to specify Template:Navbox as a wrapper, we can make Template:Tmpl work from most pages, while still not requiring that the module check for arguments on the Template:Navbox page itself.

Wrappers can be specified either as a string, or as an array of strings.

local args = getArgs(frame, {
	wrappers = 'Template:Wrapper template'
})

local args = getArgs(frame, {
	wrappers = {
		'Template:Wrapper 1',
		'Template:Wrapper 2',
		-- Any number of wrapper templates can be added here.
	}
})

Writing to the args table

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.)

args.foo = 'some value'

It is possible to alter this behaviour with the readOnly and noOverwrite options. If readOnly is set then it is not possible to write any values to the args table at all. If noOverwrite 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:...}}.

This module uses metatables to fetch arguments from {{#invoke:...}}. This allows access to both the frame arguments and the parent frame arguments without using the pairs() function. This can help if your module might be passed Template:Xtag tags as input.

As soon as Template:Xtag 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 no number that links to it. This has been a problem with modules that use pairs() 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 pairs(args) elsewhere in your module, however.

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 # operator, the next() 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.

Template:ModuleQuality