پودمان:Set local argument names/توضیحات

این پودمان برای استفاده در پودمان‌های دیگر طراحی شده است و کاربرد آن برای تنظیم معادل فارسی (بومی) برای پارامترهای خود پودمان یا الگویی است که پودمان مورد بحث، آن را پیاده‌سازی می‌کند. برای مثال، در پودمانی که پارامتر |image= دارد، می‌توان با استفاده از این پودمان معادل |تصویر= را نیز افزود.

در گذشته برای تنظیم پارامترهای بومی از دستور زیر استفاده می‌شد (در تمام مثال‌های این مستندات، جدول فرضی args حاوی آرگومان‌های پودمان است):

if args["آرگومان"] then args["argument"] = args["آرگومان"] end

این روش، باعث شلوغ شدن کدهای پودمان‌ها می‌شد؛ پودمان Set local argument names برای ساده‌سازی روند تعریف آرگومان‌های بومی ساخته شده است.

استفاده

-- در سطور ابتدایی پودمان قرار گیرد
local setFarsiArguments = require('Module:Set Farsi argument names')

-- در ابتدای تابع اصلی پودمان (معمولاً با نام main) و پس از تعریف جدول آرگومان‌ها قرار گیرد
setFarsiArguments(
	args,
	{
		['arg1']		= 'آرگومان۱',	['arg2']	= 'آرگومان۲',
		['arg3']		= 'آرگومان۳',	['arg4']	= 'آرگومان۴',
	}
)