راهنما:الگو: تفاوت میان نسخه‌ها
محتوای حذف‌شده محتوای افزوده‌شده
جزبدون خلاصۀ ویرایش |
|||
خط ۳۱۹:
* در الگویی که قرار است در فضای نام مقاله از آن استفاده شود، از نشانهٔ ویکی <code>=</code> برای ایجاد عنوان بخش استفاده نکنید؛ استفاده از این نویسه یک پیوند <code>[ویرایش]</code> تولید می‌کند که در صورت تراگنجانش، به‌طور گیج‌کننده‌ای صفحهٔ الگو را برای ویرایش باز خواهد کرد.
** می‌توانید با گنجاندن عبارت <code><nowiki><includeonly>__بی‌بخش__</includeonly></nowiki></code> (یا <code><nowiki><includeonly>__NOEDITSECTION__</includeonly></nowiki></code>) از ایجاد پیوندهای <code>[ویرایش]</code> به مقصد صفحهٔ الگو جلوگیری کنید.
=== مستندسازی ===
{{بیشتر|ویکی‌پدیا:مستندسازی الگوها}}
رده‌بندی الگو و مستندسازی نحوهٔ صحیح استفاده از آن می‌تواند به سایر ویرایشگران در یافتن و استفاده از الگوی شما کمک کند.
مستندسازی برای کاربران، در کنار رده‌بندی الگو معمولاً پس از کد اصلی الگو و در میان برچسب‌های {{برچسب|noinclude}} قرار می‌گیرد. معمولاً لازم است که برچسب گشایندهٔ {{برچسب|noinclude|open}} را بلافاصله پس از پایان کد الگو قرار دهید و برای اجتناب از تراگنجانش فاصله‌های خالی ناخواسته، هیچ فاصله یا سطر جدیدی نیز پیش از این برچسب درج نکنید.
در الگوهای پیچیده، مستندات به‌همراه رده‌ها معمولاً در یک [[ویکی‌پدیا:زیرصفحه|زیرصفحهٔ]] جداگانه از صفحهٔ الگو (با عنوان «الگو:{{متغیر|فلان}}/توضیحات») نگهداری می‌شوند. این قاعده بر بسیاری از الگوهای [[وپ:حفاظت|حفاظت‌شده]] نیز اعمال می‌شود و امکان ویرایش اطلاعات آن‌ها را برای کاربران غیرمدیر نیز فراهم می‌کند. این زیرصفحه را می‌توان با قرار دادن الگوی {{الگوب|توضیحات}} پس از کد اصلی الگو و درون برچسب‌های {{برچسب|noinclude}} در صفحهٔ اصلی الگو فراخوانی کرد. اگر زیرصفحهٔ «/توضیحات» موجود نباشد، پیوندی برای ایجاد آن در جعبهٔ مستندات الگو نمایش خواهد یافت.
== پانویس ==
| |||