پودمان:Unsubst/توضیحات

این صفحهٔ توضیحات پودمان:Unsubst است

این زیرصفحهٔ مستندات پودمان:Unsubst است.
این شامل اطلاعات استفاده، الگوها و سایر اطلاعات است که در اصل پودمان صفحه قرار نمی‌گیرد.

این پودمان حفاظت‌شده ارزیابی شده‌است. این پودمان یکی از ویکی‌پدیا:الگوهای حساس است و در صفحات بسیار زیادی استفاده می‌شود. محافظت این پودمان در برابر ویرایش، به‌دلیل بار قابل توجهی است که خرابکاری‌ها، خطاها یا ویرایش‌های جزئی می‌توانند به دوش سرورها بگذارند.

پودمان کمکی برای آسان‌سازی تبدیل یک الگوی جایگزین‌شده به یک انتقال الگو.

الگوهای نگهداری، مانند {{مدرک}} یا {{بهبود منبع}} هرگز نباید جایگزین شوند. راه دورزدن این کار، استفاده از شکل منتقل‌شده یک الگوی جایگزین است.

مانند هر الگوی دیگر با پارامترهای فهرست‌شده در گروه قالب پیشفرض، جعبه اطلاعات باید از پودمان:Unsubst-infobox استفاده کند.

استفاده

برای تبدیل یک الگو به الگوی خودجایگزین، کد الگو را در دستور زیر بکار ببرید:

{{SAFESUBST:<noinclude />#invoke:Unsubst||$B=

 [ ... کد الگو در اینجا ... ]

}}

هنگامیکه wikitext to display وجود ندارد باید به صورت "$B" نشان داده شود. همه دیگر پارامترها که به #invoke فرستاده می‌شوند به عنوان مقادیر پیش‌فرض در فراخوان الگوی ساخته‌شده، کپی می‌شوند. اگر مقدار هریک از این پیش‌فرض‌ها __DATE__ باشد آن مقدار، در فراخوان الگوی ساخته‌شده، برابر ماه و سال جاری خواهد بود.

برخی الگوها یک <noinclude> دارند اما در انتهای الگو با </noinclude> سازگار نیستند. در این موارد، </noinclude> از دست رفته باید پیش از }} آورده شوند.

پیشرفته

{{SAFESUBST:<noinclude />#invoke:Unsubst||$params=[ parameters ]|$aliases=[ aliases ]|$flags=[ flags ]|$B=

 [ ... کد الگو در اینجا ... ]

}}

به خاطر محدودیت‌های لوآ، هنگامی که الگو جایگزین شد پارامترها معمولا به صورت تصادفی، مرتب می‌شوند. از |$params= می‌توان در #invoke:Unsubst استفاده کرد تا پارامترهای الگو را به صورت منظم و جداشده با ویرگول "،" فهرست کرد (نمونه egg,bacon,sausage,cheese,spam). در این فهرست، پارامترهای عددی باید پیش از دیگر پارامترها آورده شوند. هر پارامتر باقیمانده‌ای به انتهای فراخوان ایجادشده فرستاده می‌شود.

نام‌های فرضی یا مستعار پارامترها می‌توانند در |$aliases= فهرست شده (نباید در |$params= فهرست شوند) و به صورت خودکار، جایگزین شوند. هر نام فرضی یا مستعار و جایگزین آن باید به صورت alias>replacement نوشته شود و هریک از جفت‌ها باید با ویرگول "،" از یکدیگر جدا شوند (مانند œuf>egg,melt>cheese). توجه کنید که این پارامترها می‌توانند با یا بدون |$params= نیز کار کنند.

می‌توان از |$flags= برای دستکاری دیگر بخش‌های رفتار پودمان استفاده کرد. مقادیر ورودی با ویرگول "،" از یکدیگر جدا شده‌اند. flagsهای درست override (به پارامترهای #invoke: اجازه می‌دهد که بر پارامترهای اصلی فراخوان الگو، اولویت پیدا کنند); keep-whitespace (از حذف فضای سفید از پارامترهای بی‌نام، جلوگیری می‌کند); and remove-empty (همه پارامترها را حذف می‌کند).

از این پارامترها می‌توان در دستورهای تجزیه‌کننده استفاده کرد تا گزینه‌های پیشرفته‌تری بدست آورد. توجه کنید که در پارامترها در هر دستور تجزیه‌کننده با الگو، یا پودمان فراخوان، باید از SAFESUBST:<noinclude /> استفاده کنید.

نمونه

{{SAFESUBST:<noinclude />#invoke:Unsubst||foo=bar |date=__DATE__ |$B=

 [ ... کد الگو در اینجا ... ]

}}

Original	Result
`{{جا:نمونه}}`	`{{نمونه\|date=نوامبر ۲۰۲۴}}`
`{{جا:نمونه\|foo=X}}`	`{{Example\|foo=X\|date=نوامبر ۲۰۲۴}}`
`{{جا:نمونه\|baz=X}}`	`{{Example\|baz=X\|date=نوامبر ۲۰۲۴}}`
`{{جا:نمونه\|تاریخ=ژانویه ۲۰۰۱}}`	`{{نمونه\|foo=bar\|تاریخ=ژانویه ۲۰۰۱}}`

Original	Result
`{{جا:نمونه}}`	`{{نمونه\|date=نوامبر ۲۰۲۴}}`
`{{جا:نمونه\|foo=X}}`	`{{Example\|foo=X\|date=نوامبر ۲۰۲۴}}`
`{{جا:نمونه\|baz=X}}`	`{{Example\|baz=X\|date=نوامبر ۲۰۲۴}}`
`{{جا:نمونه\|تاریخ=ژانویه ۲۰۰۱}}`	`{{نمونه\|foo=bar\|تاریخ=ژانویه ۲۰۰۱}}`