الگو:پیوند پودمان

توضیحات الگو[نمایش] [ویرایش] [تاریخچه] [پاکسازی]

{{پیوند پودمان}} برای نمایش نام یک پودمان در قالب یک پیوند احاطه‌شده با آکولادهای فراخوانی به‌همراه تابع تجزیه‌گر {{#درخواست}} ({{#invoke}}) کاربرد دارد تا به‌جای فراخوانی پودمان، صرفاً نام آن در قالب کد نمایش داده شود. کاربرد اصلی این الگو در راهنماها و صفحه‌های مستندات، و به‌منظور ارجاع به یک پودمان به‌واسطهٔ نام آن و بدون فراخواندن آن است. این الگو از توصیف یک تابع و پارامترهای آن نیز پشتیبانی می‌کند.

نمونه‌ها

دستور	نتیجه	نکات
{{پپ|نمونه}}	{{#درخواست:نمونه|تابع}}	کاربرد بدون نام تابع. دستور تولیدشده برای فراخوانی پودمان قابل استفاده نیست.
{{پپ|نمونه|درود}}	{{#درخواست:نمونه|درود}}	کاربرد به‌همراه نام تابع.
{{پپ|نمونه|count_fruit|4=bananas=10|5=kiwis=5}}	{{#درخواست:نمونه|شمارش میوه‌ها|موز=10|کیوی=5}}	کاربرد به‌همراه نام تابع و پارامترهای آن.
{{پپ|نمونه|شمارش میوه‌ها|کوروش|موز{{=}}10|سیب{{=}}5}}	{{#درخواست:نمونه|شمارش میوه‌ها|کوروش|موز=10|سیب=5}}	کاربرد به‌همراه نام تابع و پارامترهای آن، با استفاده از {{=}}.
{{پپ|نمونه|}}	{{#درخواست:نمونه}}	نام تابع را خالی می‌گذارد

الگوداده

این، توضیحاتِ الگوداده است که توسط TemplateWizard، ویرایشگر دیداری و دیگر ابزارها استفاده می‌شود. گزارش خطای ماهیانه برای این الگو را ببینید.

الگوداده پیوند پودمان

برای نمایش نام یک پودمان در قالب یک پیوند احاطه‌شده با آکولادهای فراخوانی به‌همراه تابع تجزیه‌گر {{#درخواست}} ({{#invoke}}) کاربرد دارد تا به‌جای فراخوانی پودمان، صرفاً نام آن در قالب کد نمایش داده شود. کاربرد اصلی این الگو در راهنماها و صفحه‌های مستندات است.

پارامترهای الگو[ویرایش داده‌های الگو]

استفاده از قالب‌بندی درون‌خطی برای پارامترهای این الگو ارجح است.

پارامتر		توضیحات	نوع	وضعیت
نام پودمان	1	نام پودمان بدون پیشوند فضای نام «پودمان:» که به‌طور خودکار اضافه می‌شود	رشته	ضروری
نام تابع	2	نام تابع درون کدهای پودمان	رشته	اختیاری
پارامتر اول	3	نام (و مقدار) پارامتر اول، برای افزون علامت مساوی از {{=}} استفاده کنید	رشته	اختیاری
پارامتر دوم	4	نام (و مقدار) پارامتر دوم، برای افزون علامت مساوی از {{=}} استفاده کنید	رشته	اختیاری
پارامتر سوم	5	نام (و مقدار) پارامتر سوم، برای افزون علامت مساوی از {{=}} استفاده کنید	رشته	اختیاری
بخش	بخش section	بدون توصیف	ناشناخته	اختیاری

الگوهای وابسته

• {{پتپ}} - کارکرد مشابه، اما به‌همراه تولید پیوند به بند مربوط به تابع در مستندات.
• {{پپگ}} - کارکرد مشابه، اما احاطه‌شده در برچسب‌های <code>...</code>.
• {{الگو}} - نسخه‌ای از همین الگو، اما برای پیونددهی به الگوها به‌جای پودمان‌ها.

قالب‌بندی به‌کارگیری عمومی

مقایسهٔ الگوهای پیونددهی به الگو مطابق با سبک متن و پیوند تولیدشده

سبک متن ↓	گزینه‌های {{الگوع}} برای دستیابی به سبک متن	سبک پیوند
		با پیوند	بدون پیوند	با پیوند و جانشانی	با پیوند شامل براکت‌ها	با پیوند و متن جایگزین
گزینه‌های {{الگوع}} برای دستیابی به سبک پیوند	—	پیش‌فرض	nolink=yes	subst=yes	braceinside=yes	alttext=فلان 2=فلان
معمولی	پیش‌فرض	{{الگوع}} {{الگو}} {{الگوپ|۱|۲|...}} {{الگو:الگوف}}	{{الگوخ}} <پیوند الگو>	{{جا:الگوج}} {{جا:الگو:الگوفج}}	{{الگون}}	{{الگوم}}
کد	code=yes	{{الگو۲}} {{الگوب}} {{الگو:الگوفگ}}۳	{{الگوک}} <پیوند الگو> {{الگوخالی}} <پیوند الگو>	{{جا:الگوگج}}	—
تک‌فاصله	plaincode=yes	—		{{جا:الگوعج}}
kbd	kbd=yes
پررنگ	bold=yes	{{الگوپر}}	—
پررنگ+کد	bold=yes|code=yes	{{الگوگپ}}
کج+کد	italic=yes|code=yes	{{الگوگک}}

سایر الگوهای قالب‌بندی

الگوهای تولیدکنندهٔ اثرهای قالب‌بندی اختصاصی برای الگوها، پودمان یا پارامترهای مشخص‌شده

نمونه کد	اثر	توضیح
{{الگو۲|Hatnote|lang=fr}}	{{Hatnote}}	از پیوند به پروژه‌های خواهد پشتیبانی می‌کند (مثلاً fr:Hatnote)
{{الگوف|کاربر:Jeeputer/شمار ویرایش‌ها}}	{{کاربر:Jeeputer/شمار ویرایش‌ها}}	از پیونددهی به هر فضای نامی پشتیبانی می‌کند
{{دمو|<nowiki>{{سرنویس|lang=fa|کمی متن}}</nowiki>}}	{{سرنویس|lang=fa|کمی متن}} کمی متن	کد و نمونه‌اش را نمایش می‌دهد
{{دمگ|سرنویس|کمی متن برای سرنویس}}	"{{سرنویس|کمی متن برای سرنویس}}" می‌دهد " کمی متن برای سرنویس "	کد، نمونه و پیوندی برای بسط کد الگو را نمایش می‌دهد
{{tln|Hatnote}}	Template:Hatnote	Produces a normal link to the template
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}}	[[Template:Hatnote]] [[Template:Hatnote|Hatnote]]	Formats wikilink, with optional piped link text and blended suffix
{{ml|Example|hello}}	{{#درخواست:Example|hello}}	Counterpart to {{tl}} for linking to Lua modules
{{mlx|Example|hello}}	{{#invoke:Example|hello}}	Counterpart to {{tlx}} for linking to Lua modules
{{para|title|<var>book title</var>}}	|title=book title	Formats template parameters for display, with or without values
{{sclx|LASTING}}	[[WP:LASTING]]	Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
{{tag|ref}} {{xtag|templatedata}}	<ref>...</ref> <templatedata>	Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}}	الگو:Dtl	Wikidata counterpart to {{tl}}
{{pf|if}} {{pf|if|{{{1}}}|true|false}}	{{#if}} {{#if:{{{1}}}|true|false}}	Parser function equivalent to {{tl}}
{{magic word|uc:}}	الگو:Magic word	Magic word links

With utility links

Templates producing utility links for a given template (Hatnote used here as example)

Code example	Effect
{{lt|Hatnote}}	الگو:Hatnote (ویرایش | بحث | تاریخچه | پیوندها | پیگیری | سیاهه‌ها)
{{lts|Hatnote}}	الگو:Hatnote(ویرایش بحث پیوندها تاریخچه)
{{t links|Hatnote}}	Hatnote (edit · talk · history · links · /subpages · /doc · /doc edit · /sbox · /sbox diff · /test · Module:hatnote)
{{tfd links|Hatnote}}	الگو:Hatnote (بحث · تاریخچه · تراگنجانش‌ها (شمار) · سیاهه‌ها · زیرصفحه‌ها)
{{tetl|Hatnote}}	{{ Hatnote }} links talk view
{{tsetl|Hatnote}}	{{ subst:Hatnote }}  links talk view
{{ti|Hatnote}}	الگو:Hatnote (بحث، پیوندها، ویرایش)
{{tic|Hatnote}}	Template:Hatnote (talk, links, edit)
{{tim|Hatnote}}	m:Template:Hatnote (talk, backlinks, edit)
{{tiw|Hatnote}}	الگو:Hatnote (پیوندهای به این صفحه، ویرایش)
{{tlt|Hatnote}}	{{Hatnote}} (بحث)
{{ttl|Hatnote}}	{{Hatnote}} (t/l)
{{twlh|Hatnote}}	الگو:Hatnote (پیوندها، بحث)

توضیحات بالا تراگنجانده‌شده از الگو:پیوند پودمان/توضیحات است. (ویرایش | تاریخچه)
ویرایشگران می‌توانند در صفحات تمرین (ایجاد | آینه) و آزمایشی (ایجاد) این الگو را آزمایش کنند.
لطفاً رده‌ها را به زیرصفحهٔ /توضیحات بیفزایید. زیرصفحه‌های این الگو.