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