Help:TemplateData/fa

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

تا آوریل ۲۰۱۹، تابع الگوداده بخشی از تجربهٔ کاربری پیش‌فرض برای همهٔ کاربران در همهٔ ویکی‌های ویکی‌مدیا هنگام اضافه کردن الگو، حتی کاربران ثبت‌نام نکرده بوده است. هم ویرایشگر متنی پیش‌فرض و هم ویرایشگر دیداری، همانند بسیاری از اسکریپت‌ها، ابزارها و گجت‌ها، به‌نحوی از آن استفاده می‌کنند. اگر خواهان نصب این تابع در ویکی اختصاصی خود هستید، را نصب کنید.

اضافه کردن الگوداده به یک الگو به‌منظور استفاده توسط این افزونه شامل قرار دادن یک بلوک کوچک از کد جی‌سان (توضیح داده شده در زیر) در صفحهٔ مستندات الگو است. این کار را می‌توانید به‌صورت دستی یا با استفاده از ویرایشگر الگوداده انجام دهید. این ویرایشگر یک رابط کاربری گرافیکی دارد که پس از نصب افزونهٔ الگوداده می‌توانید در صفحه‌های «»/«» الگوها در ویکی‌ها به آن دسترسی داشته باشید. فایل جی‌سان حاوی فهرستی از پارامترهای الگو و اطلاعاتی پیرامون آن پارامترها و کلیت خود الگو است (برای جزئیات بیشتر پایین را ببینید).

اطلاعات الگوهایی که حاوی الگوداده هستند، هنگامی که کاربر الگو را به صفحه اضافه کند، در رابط کاربری به او نمایش داده می‌شوند. در برخی موارد، هنگامی که از ویرایشگر برای ویرایش یا افزودن یک الگوی مشخص استفاده کنید، نحوهٔ رفتار آن تغییر می‌کند و طی کردن مراحل لازم برای افزودن یک الگوی مشخص را برای کاربران آسان‌تر می‌کند.

تاریخچه
الگوداده در ابتدا در اوایل سال ۲۰۱۳ با در نظر داشتن توسعه یافت که در آن زمان در مراحل آزمایشی مدیاویکی قرار داشت. ویرایشگر دیداری رابط اصلی ویرایش بصری برای ویکی‌های ویکی‌مدیا است و الگوداده امکان داشتن رابطی کاربردی‌تر هنگام افزودن الگوها را برای آن فراهم کرده است. ویرایشگر دیداری بلافاصله به‌طور رسمی از این افزونه پشتیبانی کرد. به محض معرفی ویرایشگر دیداری در ویکی‌های بزرگ مختلف ویکی‌مدیا به‌عنوان یک ویژگی پیش‌فرض از سال ۲۰۱۳ تا ۲۰۱۶، الگوداده نیز به بخشی از آن بدل شد.

در دسامبر ۲۰۱۶، رابط کاربری ویرایشگر دیداری به‌عنوان یک ویژگی آزمایشی برای ویرایش کد مبدأ در دسترس قرار گرفت. این ویژگی نام گرفت. این موضوع باعث شد تا برای نخستین بار ویژگی‌های الگوداده به ویرایش مبدأ نیز وارد شوند.

در مارس ۲۰۱۸، سم ویلسون افزونهٔ را توسعه داد که یک افزونهٔ ویرایشگر الگو با رابط کاربری گرافیکی برای ویرایشگر متنی پیش‌فرض ویکی‌مدیا با نام  (شناخته‌شده تحت عنوان ویرایشگر ویکی‌متن ۲۰۱۷) بود و برای تسهیل فرایند افزودن الگوها به‌واسطهٔ استفاده از اطلاعات الگوداده طراحی شده بود. در آوریل ۲۰۱۹، جادوگر الگو در تمام ویکی‌های ویکی‌مدیا به بخشی پیش‌فرض از ویرایشگر ویکی‌متن ۲۰۱۰ تبدیل شد. به این معنی که الگوداده اکنون بخشی پیش‌فرض از هر دو ویرایشگر دیداری و متنی در ویکی‌های ویکی‌مدیا بود.



افزودن یا ویرایش الگوداده
برای افزودن یا ویرایش الگوداده، ابتدا به صفحهٔ الگو، که در «/الگو:نام الگو» قرار دارد، بروید.



بررسی حالت کنونی
پیش از افزودن یا ویرایش الگوداده، بررسی کنید که الگو دارای یک زیرصفحهٔ توضیحات باشد. سپس بررسی کنید که آیا الگو '''از پیش دارای الگوداده هست» یا خیر؛ و، در صورت وجود الگوداده، بررسی کنید که در صفحهٔ خود الگو قرار دارد یا زیرصفحهٔ توضیحات آن.



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

«/الگو:نام‌الگو/توضیحات». در صفحه‌هایی مانند این، الگوی {{}} تمام محتوای صفحهٔ /توضیحات را در صفحهٔ الگو تراگنجانش می‌کند و باعث می‌شود تا کد مبدأ الگو تمیزتر بماند.
 * اکثریت قریب به اتفاق الگوها یادداشت‌های نحوهٔ استفاده و سایر داده‌هایی که نباید در صفحهٔ اصلی الگو قرار گیرند را در یک زیرصفحهٔ توضیحات ذخیره می‌کنند.:
 * در الگوهای دارای زیرصفحهٔ توضیحات، سرآیند «Test Template Info-Icon - Version (2).svg توضیحات الگو» و سپس پیوندهایی نظیر [نمایش]، [ویرایش]، [تاریخچه] و [پاکسازی] درج می‌شوند.


 * بعضی از صفحه‌های الگو این اطلاعات را در صفحهٔ اصلی الگو نگهداری می‌کنند. این حالت را می‌توانید با جستجو برای وجود عبارت  در میان برچسب‌های  در صفحه‌های مذکور دریابید.

ویکی‌های مختلف ممکن است این‌ها را به‌شکلی متفاوت ارائه دهند. به‌ندرت پیش می‌آید که صفحه‌های اصلی الگوها، با وجود این که همهٔ موارد فوق را بررسی کرده‌اید، همچنان حاوی توضیحات باشند؛ در این صورت، ممکن است کاربری عنوان یک صفحهٔ /توضیحات سفارشی را بین « » و « » افزوده باشد و سپس محتوا را در « » درج کرده باشد.

همچنین می‌توانید به‌دنبال یک اعلان در پایین صفحه بگردید که متن آن چیزی مشابه این متن است: «توضیحات بالا تراگنجانده‌شده از الگو:نام‌الگو/توضیحات است».



الگوهای فاقد زیرصفحهٔ توضیحات
اگر الگو فاقد زیرصفحهٔ توضیحات نیست، آن را ایجاد کنید و مستندات الگو را به آنجا (یا جای مناسبی برای آن) منتقل کنید. سپس می‌توانید الگوداده را به زیرصفحهٔ توضیحات بیافزایید.



ایجاد زیرصفحه و انتقال مستندات
برای ایجاد زیرصفحهٔ توضیحات، روی «»/«» در صفحهٔ اصلی الگو کلیک کنید؛ به‌دنبال برچسب‌های و محتوای میان آن‌ها (معمولاً در پایین صفحه) باشید.

این محتوا باید چیزی مشابه متن زیر باشد:

ممکن است دریابید که الگو از پیش حاوی الگوداده است. در این صورت، متن چیزی مشابه متن زیر خواهد بود:

هرچیزی که پس از « » و پیش از « » آمده را انتخاب کنید و آن را در بریده‌دان خود یا یک سند موقت ذخیره کنید. « » را حذف کنید تا فقط متن زیر باقی بماند:

صفحهٔ الگو را ذخیره کنید.

حالا، برای ایجاد زیرصفحهٔ تازه، به نوار نشانی مرورگر خود بنگرید و /توضیحات را به انتهای نشانی اضافه کنید. Enter را بفشارید و سپس گزینهٔ ایجاد صفحهٔ تازه را انتخاب کنید.

اگر این ویکی دارای یک الگوی اعلان {{}} بود، آن را به بالای صفحهٔ تازه اضافه کنید. ممکن است بخواهید الگوهای دیگری نظیر پیوندی به {{}} یا {{}} (در صورت پشتیبانی توسط ویکی مورد بحث) را نیز اضافه کنید. برای اطلاعات بیشتر m:Help:Template documentation را ببینید.

متنی که از متن قبلی بریده بودید یا ذخیره کرده بودید را در صفحه (زیر الگوی اعلان در صورت وجود) قرار دهید.

رده‌ها را در میان برچسب‌های قرار دهید تا تنها به صفحهٔ اصلی الگو افزوده شوند:

بسیاری از ویکی‌ها دارای یک الگوی  هستند. در صورتی که احتمال این می‌رود که الگویی که دارید ویرایش می‌کنید، در یک نسخهٔ تمرینی نیز موجود باشد (قرار گرفته در «الگو:نام‌الگو/تمرین»)، از این الگو استفاده کنید تا از افزوده شدن رده‌ها به صفحهٔ تمرین الگو جلوگیری شود:

در نهایت، صفحه را منتشر کنید.

اکنون می‌توانید الگوداده را در زیرصفحهٔ توضیحات و با کمک از دستورالعمل‌های مندرج در #روش‌ها اضافه یا ویرایش کنید.



افزودن و ویرایش الگوداده در صفحهٔ اصلی الگو
اگر قادر به ایجاد صفحهٔ /توضیحات نیستید، می‌توانید با دنبال‌کردن دستورالعمل‌های مندرج در #روش‌ها الگوداده را در صفحهٔ اصلی الگو اضافه یا ویرایش کنید.

اگر الگویی دارای زیرصفحهٔ توضیحات بود، وجود یا عدم وجود الگوداده در صفحهٔ اصلی و زیرصفحهٔ توضیحات را بررسی کنید (برچسب و سپس آرایه‌ای در میان دو آکولاد:  ).

افزونهٔ الگوداده نیز می‌تواند به‌عنوان یک جایگزین این کار را برای شما انجام دهد. در هر یک از صفحه‌ها روی «» یا «» کلیک کنید. اگر الگو از پیش در هر یک از صفحه‌ها دارای الگوداده باشد، اعلانی زرد رنگ را در بالای صفحه مشاهده خواهید کرد که یکی از پیام‌های زیر را نمایش می‌دهد:



یا

در صورتی که الگو در زیرصفحهٔ توضیحات خود دارای الگوداده باشد

الگو الگو در زیرصفحهٔ توضیحات خود دارای الگوداده باشد، آن زیرصفحه همان صفحه‌ای است که باید ویرایشش کنید. این کار را می‌توانید با کلیک کردن بر روی «[ویرایش]»، که پس از سرآیند « توضیحات الگو» (یا مشابه آن) قرار گرفته، یا، در صورتی که در صفحهٔ /توضیحات قرار دارید، با کلیک کردن بر روی «» یا «» در بالای صفحه انجام دهید. برای ویرایش یا افزودن الگوداده راهنمایی‌های مندرج در #روش‌ها را دنبال کنید.

در صورتی که الگو در صفحهٔ اصلی خود دارای الگوداده باشد

در صورتی که الگو در صفحهٔ اصلی خود دارای الگوداده باشد، باز هم دو گزینه را پیش روی خود دارید:


 * می‌توانید آن را به زیرصفحهٔ توضیحات منتقل کنید. این گزینه بر دیگری ارجح است.


 * یا این که می‌توانید آن را در صفحهٔ اصلی الگو ویرایش کنید.

انتقال الگوداده به زیرصفحهٔ توضیحات

برای انجام این کار، در صفحهٔ اصلی الگو روی «»/«» کلیک کنید و به‌دنبال برجسب‌های که در میان برچسب‌های  قرار گرفته‌اند، بگردید. این محتوا باید چیزی مشابه متن زیر باشد:

فقط برچسب‌های را از محتوا ببُرید و صفحه را ذخیره کنید.

سپس، زیرصفحهٔ توضیحات را با کلیک بر روی پیوند «[ویرایش]»، که پس از سرآیند « توضیحات الگو» (یا مشابه آن) قرار گرفته، ویرایش کنید.

عنوان یک سرآیند مانند «الگوداده» را تایپ کنید، سپس محتوای الگوداده را زیر آن قرار دهید.

اکنون می‌توانید الگوداده را مطابق با راهنمایی‌های مندرج در #روش‌ها ویرایش کنید.

ویرایش الگوداده در صفحهٔ اصلی الگو
اگر نمی‌خواهید الگوداده را به صفحهٔ /توضیحات منتقل کنید، می‌توانید آن را در صفحهٔ اصلی الگو ویرایش کنید. برای آگاهی از چگونگی ویرایش الگوداده، #روش‌ها را ببینید.

در صورتی که الگو هنوز فاقد الگوداده است، اما زیرصفحهٔ توضیحات را دارد

در صورتی که الگو هنوز فاقد الگوداده است، باید آن را به زیرصفحهٔ توضیحات بیافزایید.

این کار را با کلیک کردن بر روی پیوند «[ویرایش]»، که پس از سرآیند « توضیحات الگو» (یا مشابه آن) قرار گرفته، یا، در صورتی که در صفحهٔ /توضیحات قرار دارید، با کلیک کردن بر روی «» یا «» در بالای صفحه انجام دهید. عنوان یک سرآیند مانند «الگوداده» را تایپ کنید، سپس محتوای الگوداده را زیر آن قرار دهید. نحوهٔ افزودن الگوداده در بخش #روش‌ها توضیح داده شده است.

روش‌ها


روش ویرایشگر الگوداده
این روش، راهی ساده برای افزودن یا ویرایش الگوداده است که استفاده از آن به کاربرانی با تجربهٔ کمتر توصیه می‌شود.

ویرایشگر الگوداده یک رابط کاربری گرافیکی برای افزودن و ویرایش الگوداده است. این ویرایشگر بخشی از افزونهٔ الگوداده است که در تمام صفحه‌های الگوها (یا زیرصحفحه‌های توضیحات آن‌ها) از طریق کلیک کردن بر روی «» یا «» در دسترس است.

پس از کلیک کردن بر روی «» یا «»، دکمه‌ای را در بالای پنجرهٔ ویرایش خواهید دید که عنوان آن «» است.

|453px

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

600px|ابزار ویرایش الگوداده، در صفحه‌های که فاقد الگوداده است.

ویژگی‌های موجود در پنجرهٔ فوق:


 * آیتم موجود در بالای پنجره برای انتخاب زبان متن رابط کاربری به‌کار می‌رود. این آیتم امکان وارد کردن محتوای متنی به زبان‌های مختلف، که بر پایهٔ تنظیمات کاربران در ترجیحات به آن‌ها، و نه بر پایهٔ زبان ویکی حاضر به آن‌ها نمایش داده می‌شود را به شما می‌دهد: ویکی‌های مختلف پایگاه‌های دادهٔ کاملاً متفاوتی برای الگوها دارند. اگر الگودادهٔ زبانی موجود نباشد، رابط کاربری تنها زبان خودِ ویکی را به کاربران پیشنهاد می‌دهد، اما کاربرانی می‌توانند روی «» کلیک کنند و ورودی‌های بیشتری را بیافزایند. شناسهٔ زبان در داخل کروشه و پس از پارامترهایی که به‌ان‌ها قابل اعمال است، مانند توصیف‌ها و برچسب‌ها، نمایش داده می‌شود.
 * آیتم بعدی، توصیف الگو است. این در واقع توصیفی است از کلیت عملکرد و کاربرد الگو که در موقعیت‌های مختلفی در ویرایشگرهای الگو هنگام افزودن الگو به کاربران نشان داده می‌شود. توضیح پیرامون این پارامتر و اثرات آن را می‌توانید در اینجا مطالعه کنید.
 * آیتم سوم قالب‌بندی ویکی‌متن الگو را کنترل می‌کند. این پارامتر چگونگی قرارگیری ویکی‌متن هنگام کلیک بر روی «» توسط کاربر را تعیین می‌کند و دو نوع اصلی آن شامل  (در یک سطر) و   (در سطرهای جداگانه) است. توضیح پیرامون این پارامتر و اثرات آن را می‌توانید در اینجا مطالعه کنید.
 * اگر کاربر «» را انتخاب کند، می‌تواند به‌منظور ایجاد یک قالب‌بندی سفارشی برای الگو هنگام کلیک بر روی «» توسط کاربر، ویکی‌متنی را تحت «» و مطابق با قواعد مستند شده در اینجا وارد کند.


 * آیتم چهارم پارامترهای الگو را پیکربندی می‌کند. اگر پارامترهایی از پیش در الگوداده تعریف شده باشند، در این قسمت در قالب یک فهرست نمایش داده می‌شوند. اگر کد مبدأ الگو پارامترهایی را در خود داشته باشد که برای آن‌ها الگوداده‌ای موجود نباشد، دکمه‌ای را خواهید دید که عنوان آن «» است. ویرایشگر، به‌واسطهٔ جستجو برای  و  ، این پیشنهادها را از کد مبدأ الگو استخراج می‌کند. با کلیک کردن بر روی «»، این پارامترها با استفاده از نام آن‌ها به‌شکلی که در کد مبدأ الگو تعریف شده‌اند، به فهرست افزوده می‌شوند. یک اعلان سبز نیز در بالای صفحه نمایش می‌یابد که متن آن، برای مثال، برابر با «» است.
 * در پایین پنجره یک دکمهٔ «» را مشاهده می‌کنید. این دکمه امکان افزودن پارامتر به‌صورت دستی به‌همراه نام سفارشی را برای شما فراهم می‌کند.

برای ادامه دادن و رفتن به مرحلهٔ بعدی، روی هر یک از پارامترهای موجود در فهرست کلیک کنید. این کار به شما این امکان را می‌دهد تا اطلاعات آن پارامتر را ویرایش کنید.

600px

توضیحات پیرامون تمامی این ویژگی‌ها و تأثیرات آن‌ها را می‌توانید در بخش #درون نام یک پارامتر مطالعه کنید.

در پایان، روی «» کلیک کنید. این کار باعث می‌شود که الگوداده در پایین صفحه و پیش از برچسب قرار گیرد؛ یا، در صورتی که الگوداده از پیش موجود باشد، با اطلاعات جدید و بدون تغییر محل قرارگیری آن، به‌روزرسانی خواهد شد. هرگاه روی «» کلیک کنید، متن الگوداده نیز انتخاب خواهد شد.

ویرایشگر الگوداده یک پارامتر  را نیز در پایین متن الگوداده ایجاد خواهد کرد (یا آن را در صورت موجود بودن از قبل، به‌روز خواهد کرد). حاوی پارامترهای کنونی الگوداده به‌ترتیبی که در ویرایشگر الگوداده نمایش یافته بودند، است. می‌توانید با کشیدن پارامترها به بالا یا پایین با استفاده از سه خط افقی در سمت راست هر پارامتر در رابط ویرایشگر الگوداده،  را تغییر دهید. توضیحات پیرامون  و تأثیرات آن در اینجا موجود است.

پس از این روی «» کلیک کنید تا نسخهٔ خود را در صفحه ذخیره کنید.



روش دستی
می‌توانید الگوداده را به‌صورت دستی نیز اضافه یا ویرایش کنید. الگوداده در قالب جی‌سان نوشته می‌شود، اما برای آموختن چگونگی ایجاد الگوداده، نیازی نیست جی‌سان را یاد بگیرید. الگوداده از چند قانون بسیار ساده پیروی می‌کند و فقط چند پارامتر از پیش تعیین‌شده و مقدارهای ممکن را می‌پذیرد که معمولاً از قالب  پیروی می‌کنند.

افزودن الگوداده به‌صورت دستی

در نظر داشته باشید:


 * اگر در حال افزودن الگوداده به زیرصفحهٔ توضیحات یک الگو هستید (توصیه می‌شود)، می‌توانید آن را به هر جایی از صفحه بیافزایید؛ بررسی کنید که آیا ویکی‌پدیای زبان شما مکانی تعیین‌شده برای آن دارد یا خیر. برای مثال، در ویکی‌پدیای فارسی، الگوداده معمولاً در نزدیکی انتهای صفحهٔ توضیحات افزوده می‌شود؛ اما در ویکی‌پدیای آلمانی، معمولاً در بالای صفحه قرار می‌گیرد.
 * اگر در حال افزودن الگوداده به صفحهٔ اصلی یک الگو هستید (توصیه نمی‌شود؛ #بررسی‌های قبلی را ببینید)، باید اطمینان حاصل کنید که آن را درون برچسب‌های  قرار داده باشید.

در صفحهٔ متعاقب روی «» یا «» کلیک کنید و سپس به موقعیتی از صفحه که قصد قرار دادن الگوداده در آن را دارید بروید و عنوان بخش را تایپ کنید: «الگوداده».

بسیاری از ویکی‌ها دارای یک الگوی TemplateData header هستند که اعلانی کوتاه پیرامون الگوداده را نمایش می‌دهد. اگر ویکی شما این الگو را دارد، آن را زیر عنوان بخش بیافزایید.

برای آغاز فرایند افزودن الگوداده، یک برچسب آغازین و پایانی را به‌همراه یک جفت آکولاد در دو سطر جداگانه تایپ کنید و یک سطر را میان آن‌ها خالی بگذارید:

سپس، یک دندانه در سطر خالی میان دو آکولاد اضافه کنید و شروع به افزودن پارامترها کنید. جزئیات پیرامون پارامترها را می‌توانید در #پارامترهای الگوداده بیابید. بیشتر این پارامترها اختیاری هستند؛ استفاده از برخی از آن‌ها نیز به‌شدن توصیه می‌شود.

ترتیب‌بندی پارامترها می‌تواند به هر شکلی باشد، اما آنچه در ادامه می‌آید، ترتیبی است که بیشتر با مستندات الگوداده مطابقت دارد و استفاده از محتوا را برای ویرایشگران تسهیل می‌کند:

مطمئن شوید که پارامترهایی که برای مثال در شیء  قرار دارند، در داخل همان شیء بمانند؛ در غیر این صورت، هنگام تلاش برای ذخیره‌سازی باعث فعال‌شدن یک خطای «» خواهید شد.

نمونه

در اینجا چند نمونهٔ الگوداده برای یک الگوی تمیزکاری فرضی آورده شده است. این الگو یک اعلان را نمایش می‌دهد و کد منبع آن برای قرار دادن صفحه در یک گروه تاریخ‌دار بر اساس ماه و سال وارد شده برنامه‌ریزی می‌شود. The notice might also contain a link to a talk page section. The TemplateData would look something like this:

The corresponding TemplateData documentation would display as follows:

{	"description": "Use this template to indicate that an article is in need of cleanup.", "format": "inline", "params": { "date": { "label": "Month and year", "description": "The month and year that the template was added", "type": "string", "autovalue": " ", "example": "January 2013", "suggested": true },		"reason": { "aliases": ["1"], "label": "Reason", "description": "The reason the article is in need of cleanup", "type": "string" },		"talk": { "aliases": ["talksection"], "label": "Talk page section", "description": "The section of the talk page containing relevant discussion", "type": "string" }	},	"paramOrder": [ "date", "reason", "talk" ] }



پارامترهای الگوداده
All available TemplateData parameters are listed below with a description and example. They are also listed in more technical detail at Extension:TemplateData#Format.

Within a parameter's name
Note: if neither,   nor   are set as   for a parameter, its status will show as   in the TemplateData documentation.

Once you're done, hit "". If you've made errors, it will not let you save (which is disruptive but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.

Note that if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.

Note that each item of information is enclosed in quotation marks (except for  and  ) and separated from the next item by a comma (unless it's the last one).

Type parameter
The  parameter is meant to signal to a template editor the nature of a parameter's value. In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this TemplateData value, such as to only allow the user to enter valid values that match the specified type. This parameter does not have any functional effect on the template parameter or its value; it merely controls how template editors see and treat the parameter in editing mode.

How to use

It is used by adding the  parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.

Example:

Effects

As of February 2020, only 5 of the 13 type values have visible effects in VisualEditor and the 2017 wikitext editor, while 8 have visible effects in TemplateWizard.

The effects of certain values are likely to change as the template editors get updates to support them. One such effort for VisualEditor and the 2017 wikitext editor is tracked in the Phabricator task T55613. A similar effort to get TemplateWizard to support the boolean value is tracked in T200664.

The currently known effects are listed as follows.

قالب دستی
When editing the  value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.


 * - start of the template
 * - content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like . If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with   for new lines).
 * - pipe (separates parameters)
 * - equals sign (precedes the value of a parameter)
 * or pressing the enter key - new line (this will display as  in the entry field)
 * - space (can be used with  to indent new lines)
 * - end of the template

The wikitext should at least meet the minimum of, otherwise there will be an invalid format string error.

Blank boilerplate
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.

Errors


خطای دستوری در جی‌سان یا قالب اشتباه آن
These errors occur when saving TemplateData, usually manually edited, with invalid JSON code (duplicate keys/parameters, trailing or missing commas, etc.) in VisualEditor or the 2017 wikitext editor.

"" appears in VisualEditor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the TemplateData GUI editor.

These errors can be difficult to detect and come in too many forms to list. The best way to avoid them is to edit template data exclusively with the TemplateData editor; the best way to detect them once they've occurred is to use an external JSON validator, such as JSONLint, which will highlight errors and aid in fixing them.

The 2010 wikitext editor does not check for invalid JSON thanks to an old, unfixed bug. Pages that contain invalid JSON may throw alarming "" messages. To fix these errors, your best bet is to use a JSON validator (see above).

Required property "paramOrder(number)" not found.
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that is missing. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

Invalid value for property "paramOrder(number)".
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

Property "params.parametername.required" is expected to be of type "boolean".
This error occurs if you put quotation marks around the value of either  or.

These are boolean values, not strings, therefore they require no quotation marks. To fix this, remove any quotation marks around the values  or   for these parameters.

Property "format" is expected to be ...
If the  parameter exists but its value is not ,   or a valid format string, you will see the error message "".

To fix this, make sure the value after  equals   or   and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of  and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats. Alternatively, you can remove the  parameter to remove this error.

Unexpected property "parametername".
This error occurs if you state a parameter that does not exist in TemplateData. This is probably due to spelling mistakes.

It also occurs if you state a parameter in any TemplateData object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one TemplateData object under another object that it doesn't belong to.

For example, you might have written the parameter  under the root TemplateData object instead of inside  :

Alternatively, if the unexpected parameter is under a template parameter inside, you'll see its name after "params.parametername." in the error.

To fix this, make sure there aren't any spelling mistakes in the parameter names, and make sure your parameters are in their correct location. Additionally, make sure you don't state any parameters that don't exist for a TemplateData object. You can check which parameters exist for an object in the section #TemplateData parameters.

Required property "params" not found.
This error occurs if there is no  object in the TemplateData. This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes. See the section above on how to add the  parameter.



محدودیت ها و بازخورد

 * ویژگی‌های ناموجود – TemplateData is an example of a tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please let us know.
 * تاخیر در نشان دادن الگو‌ها – After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in the visual editor. However, it is possible that it will take several hours before the metadata will show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change and without adding any edit summary.
 * مسائل جاری – A list of current bugs and feature requests is available in the Wikimedia bug tracker.



دیگر ابزارها

 * : A toolbar dialog window for entering template wikitext via an form built from TemplateData.
 * TemplateData Wizard: ابزاری است که از طریق یک رابط تعاملی TemplateData تولید می‌کند.
 * Skeleton TemplateData generator: A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
 * JSONLint: A tool that allows you to validate manually-written JSON to help find errors in the syntax.
 * [ List of all templates with TemplateData] on this wiki
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data
 * https://query.wikidata.org/ and Query Helper