امامت‌پدیا:مستندسازی الگوها
 | این صفحه جزئی از رهنمودهای امامت‌پدیا است. استانداردهای رفتاری مطرح‌شده در این صفحه تایید بسیاری از ویرایشگران امامت‌پدیا را همراه خود دارد. با وجود اینکه پیروی از مفاد این صفحه توصیه می‌شود ولی این مفاد جزو سیاست‌ها نیست. در ویرایش و به‌روزرسانی این صفحه جسور باشید، ولی لطفاً پیش از انجام تغییرات عمده از صفحهٔ بحث برای مطرح کردن تغییرات و نظرخواهی استفاده کنید. |
الگوها یکی از قابلیت‌های قدرتمند مدیاویکی هستند، ولی می‌توانند کاربران تازه‌کار را گمراه و حتی برای کاربران با تجربه نیز دردسر ایجاد کند. به همین خاطر وجود مستندات در الگو، می‌تواند کارایی الگو را افزایش دهد.
مستندات در الگو باید در رابطه با نحوه عملکرد و به کارگیری الگو توضیح دهد و باید به حدی ساده باشد که کاربری که توانایی کار با دستورهای مربوط به الگو را ندارد — که شامل بسیاری از همکاران با تجربه که تمرکزشان را در جای دیگری قرار داده‌اند می‌شود — بتوانند از آن به درستی استفاده کنند.
آن چه که باید شامل باشد
توضیحات الگو باید شامل این موارد را پوشش دهد:
- هدف اساسی از ساخت الگو
- پارامترهای‌های الگو
- نمونهٔ به کارگیری
- الگوهای مرتبط
- رده‌ها و پیوندهای میان‌ویکی: که باید در قالب
<includeonly>…</includeonly>قرارگیرند.
توضیحات الگو اغلب در زیرصفحهٔ خود الگو نگه‌داری می‌شوند که در انتهای صفحهٔ الگو فراخوانی می‌شوند. جداسازی کد الگو از مستندات، ویرایش مستندات را ساده‌تر می‌کند. همچنین اجازه می‌دهد که الگوها در صورت نیاز محافظت شوند، در حالی به هر کس اجازهٔ ویرایش در مستندات داده می‌شود.
چگونه زیر صفحه ساخته شود
رده‌ها و پیوندهای میان‌ویکی
- برای قراردادن خود الگو در رده، کد
[[رده:الگوهای امامت‌پدیا]] [[رده:توضیحات الگو]] [[رده:نام رده]]درون یک<includeonly>...</includeonly>قسمت از زیر صفحه توضیحات اضافه کنید. - برای قراردادن یک پیوند میان‌ویکی در خود الگو، کد
[[کدزبان:نام الگو]]را درون یک قسمت<includeonly>...</includeonly>در زیرصفحهٔ توضیحات اضافه کنید. - برای قراردادن زیرصفحهٔ توضیحات درون یک رده، کد
[[رده:نام رده]]را درون یک قسمت<noinclude>...</noinclude>در صفحهٔ توضیحات اضافه کنید. - برای قراردادن مقالات استفاده کننده از الگو در یک رده، کد
[[رده:نام رده]]درون یک قسمت<includeonly>...</includeonly>در صفحه الگو اضافه کنید.
نمونه
الگویی که در امامت‌پدیای فارسی به صورت سنگینی استفاده شده الگو:پانویس را ببینید، در حالی که خود آن به صورت کامل قفل است، اما زیر صفحه مستندات آن، الگو:پانویس/توضیحات به صورت کامل باز است و هر کسی می‌تواند آن را ویرایش کند.