راهنما:الگوداده
 |
توجه: شما در هنگام ویرایش این صفحه، موافق با انتشار مشارکت‌هایتان تحت CC0 هستید. صفحه‌های راهنمای مالکیت عمومی را برای اطلاعات بیشتر ببینید. | |
TemplateData افزونه‌ای است اطلاعات و پارامترهای مرتبط با یک الگوی ویکی‌متنی را ذخیره می‌کند و آنها را برای استفاده در یک رابط ویرایش، که قادر به واکشی و ارائهٔ آنها در یک ویرایشگر الگو است، در دسترس قرار می‌دهد -- تمام این‌ها به کاربران در افزودن و ویرایش الگوها در صفحه کمک می‌کنند.
تا آوریل ۲۰۱۹، تابع الگوداده بخشی از تجربهٔ کاربری پیش‌فرض برای همهٔ کاربران در همهٔ ویکی‌های ویکی‌مدیا هنگام اضافه کردن الگو، حتی کاربران ثبت‌نام نکرده بوده است. هم ویرایشگر متنی پیش‌فرض و هم ویرایشگر دیداری، همانند بسیاری از اسکریپت‌ها، ابزارها و گجت‌ها، به‌نحوی از آن استفاده می‌کنند. اگر خواهان نصب این تابع در ویکی اختصاصی خود هستید، Extension:TemplateData را نصب کنید.
اضافه کردن الگوداده به یک الگو به‌منظور استفاده توسط این افزونه شامل قرار دادن یک بلوک کوچک از کد جی‌سان (توضیح داده شده در زیر) در صفحهٔ مستندات الگو است. این کار را می‌توانید به‌صورت دستی یا با استفاده از ویرایشگر الگوداده انجام دهید. این ویرایشگر یک رابط کاربری گرافیکی دارد که پس از نصب افزونهٔ الگوداده می‌توانید در صفحه‌های «ویرایش»/«ویرایش مبدأ» الگوها در ویکی‌ها به آن دسترسی داشته باشید. فایل جی‌سان حاوی فهرستی از پارامترهای الگو و اطلاعاتی پیرامون آن پارامترها و کلیت خود الگو است (برای جزئیات بیشتر پایین را ببینید).
اطلاعات الگوهایی که حاوی الگوداده هستند، هنگامی که کاربر الگو را به صفحه اضافه کند، در رابط کاربری به او نمایش داده می‌شوند. در برخی موارد، هنگامی که از ویرایشگر برای ویرایش یا افزودن یک الگوی مشخص استفاده کنید، نحوهٔ رفتار آن تغییر می‌کند و طی کردن مراحل لازم برای افزودن یک الگوی مشخص را برای کاربران آسان‌تر می‌کند.
تاریخچه
الگوداده در ابتدا در اوایل سال ۲۰۱۳ با در نظر داشتن VisualEditor توسعه یافت که در آن زمان در مراحل آزمایشی مدیاویکی قرار داشت. ویرایشگر دیداری رابط اصلی ویرایش بصری برای ویکی‌های ویکی‌مدیا است و الگوداده امکان داشتن رابطی کاربردی‌تر هنگام افزودن الگوها را برای آن فراهم کرده است. ویرایشگر دیداری بلافاصله به‌طور رسمی از این افزونه پشتیبانی کرد. به محض معرفی ویرایشگر دیداری در ویکی‌های بزرگ مختلف ویکی‌مدیا به‌عنوان یک ویژگی پیش‌فرض از سال ۲۰۱۳ تا ۲۰۱۶، الگوداده نیز به بخشی از آن بدل شد.
در دسامبر ۲۰۱۶، رابط کاربری ویرایشگر دیداری به‌عنوان یک ویژگی آزمایشی برای ویرایش کد مبدأ در دسترس قرار گرفت. این ویژگی ویرایشگر ویکی‌متن ۲۰۱۷ نام گرفت. این موضوع باعث شد تا برای نخستین بار ویژگی‌های الگوداده به ویرایش مبدأ نیز وارد شوند.
در مارس ۲۰۱۸، سم ویلسون افزونهٔ TemplateWizard را توسعه داد که یک افزونهٔ ویرایشگر الگو با رابط کاربری گرافیکی برای ویرایشگر متنی پیش‌فرض ویکی‌مدیا با نام WikiEditor (شناخته‌شده تحت عنوان ویرایشگر ویکی‌متن ۲۰۱۷) بود و برای تسهیل فرایند افزودن الگوها به‌واسطهٔ استفاده از اطلاعات الگوداده طراحی شده بود. در آوریل ۲۰۱۹، جادوگر الگو در تمام ویکی‌های ویکی‌مدیا به بخشی پیش‌فرض از ویرایشگر ویکی‌متن ۲۰۱۰ تبدیل شد. به این معنی که الگوداده اکنون بخشی پیش‌فرض از هر دو ویرایشگر دیداری و متنی در ویکی‌های ویکی‌مدیا بود.
افزودن یا ویرایش الگوداده
برای افزودن یا ویرایش الگوداده، ابتدا به صفحهٔ الگو، که در «/الگو:نام الگو» قرار دارد، بروید.
بررسی حالت کنونی
پیش از افزودن یا ویرایش الگوداده، بررسی کنید که الگو دارای یک زیرصفحهٔ توضیحات باشد. سپس بررسی کنید که آیا الگو از پیش دارای الگوداده هست» یا خیر؛ و، در صورت وجود الگوداده، بررسی کنید که در صفحهٔ خود الگو قرار دارد یا زیرصفحهٔ توضیحات آن.
زیرصفحه‌های مستندات
در بیشتر ویکی‌های ویکی‌مدیا، دو روش اصلی برای ذخیره‌سازی یادداشت‌های نحوهٔ استفاده و دیگر داده‌های الگو که نباید در الگوی اصلی موجود باشند، وجود دارد. مانند رده‌هایی که الگو باید در آنها قرار گیرد:
- اکثریت قریب به اتفاق الگوها یادداشت‌های نحوهٔ استفاده و سایر داده‌هایی که نباید در صفحهٔ اصلی الگو قرار گیرند را در یک زیرصفحهٔ توضیحات ذخیره می‌کنند.:
«/الگو:نام‌الگو/توضیحات». در صفحه‌هایی مانند این، الگوی {{Documentation}} تمام محتوای صفحهٔ /توضیحات را در صفحهٔ الگو تراگنجانش می‌کند و باعث می‌شود تا کد مبدأ الگو تمیزتر بماند.
- در الگوهای دارای زیرصفحهٔ توضیحات، سرآیند «
توضیحات الگو» و سپس پیوندهایی نظیر [نمایش]، [ویرایش]، [تاریخچه] و [پاکسازی] درج می‌شوند.
- در الگوهای دارای زیرصفحهٔ توضیحات، سرآیند «
- بعضی از صفحه‌های الگو این اطلاعات را در صفحهٔ اصلی الگو نگهداری می‌کنند. این حالت را می‌توانید با جستجو برای وجود عبارت
{{Documentation|content=در میان برچسب‌های<noinclude>در صفحه‌های مذکور دریابید.
ویکی‌های مختلف ممکن است این‌ها را به‌شکلی متفاوت ارائه دهند.
به‌ندرت پیش می‌آید که صفحه‌های اصلی الگوها، با وجود این که همهٔ موارد فوق را بررسی کرده‌اید، همچنان حاوی توضیحات باشند؛
در این صورت، ممکن است کاربری عنوان یک صفحهٔ /توضیحات سفارشی را بین «{{Documentation|» و «|content=» افزوده باشد و سپس محتوا را در «|content=» درج کرده باشد.
همچنین می‌توانید به‌دنبال یک اعلان در پایین صفحه بگردید که متن آن چیزی مشابه این متن است: «توضیحات بالا تراگنجانده‌شده از الگو:نام‌الگو/توضیحات است».
الگوهای فاقد زیرصفحهٔ توضیحات
اگر الگو فاقد زیرصفحهٔ توضیحات نیست، آن را ایجاد کنید و مستندات الگو را به آنجا (یا جای مناسبی برای آن) منتقل کنید. سپس می‌توانید الگوداده را به زیرصفحهٔ توضیحات بیافزایید.
ایجاد زیرصفحه و انتقال مستندات
برای ایجاد زیرصفحهٔ توضیحات، روی «ویرایش»/«ویرایش مبدأ» در صفحهٔ اصلی الگو کلیک کنید؛ به‌دنبال برچسب‌های <noinclude> و محتوای میان آنها (معمولاً در پایین صفحه) باشید.
این محتوا باید چیزی مشابه متن زیر باشد:
<noinclude>
{{Documentation|content=
== استفاده ==
اطلاعات پیرامون استفاده از الگو.
== سرفصل‌های نمونهٔ دیگر ==
محتوای نمونهٔ دیگر
[[رده:رده نمونه]]
[[رده:رده نمونه ۲]]
}}
</noinclude>
ممکن است دریابید که الگو از پیش حاوی الگوداده است. در این صورت، متن چیزی مشابه متن زیر خواهد بود:
<noinclude>
{{Documentation|content=
...
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "پارامتر نمونه",
"description": "توضیح پارامتر نمونه",
"type": "string"
}
}
}
</templatedata>
</noinclude>
هرچیزی که پس از «|content=» و پیش از «</noinclude>» آمده را انتخاب کنید و آن را در بریده‌دان خود یا یک سند موقت ذخیره کنید. «|content=» را حذف کنید تا فقط متن زیر باقی بماند:
<noinclude>
{{Documentation}}
</noinclude>
صفحهٔ الگو را ذخیره کنید.
حالا، برای ایجاد زیرصفحهٔ تازه، به نوار نشانی مرورگر خود بنگرید و /توضیحات را به انتهای نشانی اضافه کنید. ↵ Enter را بفشارید و سپس گزینهٔ ایجاد صفحهٔ تازه را انتخاب کنید.
اگر این ویکی دارای یک الگوی اعلان {{Documentation subpage}} بود، آن را به بالای صفحهٔ تازه اضافه کنید. ممکن است بخواهید الگوهای دیگری نظیر پیوندی به {{Purge button}} یا {{Purge}} (در صورت پشتیبانی توسط ویکی مورد بحث) را نیز اضافه کنید.
متنی که از متن قبلی بریده بودید یا ذخیره کرده بودید را در صفحه (زیر الگوی اعلان در صورت وجود) قرار دهید.
رده‌ها را در میان برچسب‌های <includeonly> قرار دهید تا تنها به صفحهٔ اصلی الگو افزوده شوند:
<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>
بسیاری از ویکی‌ها دارای یک الگوی {{Sandbox other}} هستند.
در صورتی که احتمال این می‌رود که الگویی که دارید ویرایش می‌کنید، در یک نسخهٔ تمرینی نیز موجود باشد (قرار گرفته در «الگو:نام‌الگو/تمرین»)، از این الگو استفاده کنید تا از افزوده شدن رده‌ها به صفحهٔ تمرین الگو جلوگیری شود:
<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>
در نهایت، صفحه را منتشر کنید.
اکنون می‌توانید الگوداده را در زیرصفحهٔ توضیحات و با کمک از دستورالعمل‌های مندرج در #روش‌ها اضافه یا ویرایش کنید.
افزودن و ویرایش الگوداده در صفحهٔ اصلی الگو
اگر قادر به ایجاد صفحهٔ /توضیحات نیستید، می‌توانید با دنبال‌کردن دستورالعمل‌های مندرج در #روش‌ها الگوداده را در صفحهٔ اصلی الگو اضافه یا ویرایش کنید.
اگر الگویی دارای زیرصفحهٔ توضیحات بود، وجود یا عدم وجود الگوداده در صفحهٔ اصلی و زیرصفحهٔ توضیحات را بررسی کنید (برچسب <templatedata> و سپس آرایه‌ای در میان دو آکولاد: {}).
افزونهٔ الگوداده نیز می‌تواند به‌عنوان یک جایگزین این کار را برای شما انجام دهد. در هر یک از صفحه‌ها روی «ویرایش» یا «ویرایش مبدأ» کلیک کنید. اگر الگو از پیش در هر یک از صفحه‌ها دارای الگوداده باشد، اعلانی زرد رنگ را در بالای صفحه مشاهده خواهید کرد که یکی از پیام‌های زیر را نمایش می‌دهد:
- لطفاً توجه کنید: از پیش قطعهٔ داده‌های الگو در صفحهٔ مرتبط «[[الگو:نام‌الگو/توضیحات]]» وجود دارد.
یا
- لطفاً توجه کنید: از پیش قطعهٔ داده‌های الگو در صفحهٔ مرتبط «[[الگو:نام‌الگو]]» وجود دارد.
در صورتی که الگو در زیرصفحهٔ توضیحات خود دارای الگوداده باشد
الگو الگو در زیرصفحهٔ توضیحات خود دارای الگوداده باشد، آن زیرصفحه همان صفحه‌ای است که باید ویرایشش کنید.
این کار را می‌توانید با کلیک کردن بر روی «[ویرایش]»، که پس از سرآیند «.svg){kind=icon}
توضیحات الگو» (یا مشابه آن) قرار گرفته، یا، در صورتی که در صفحهٔ /توضیحات قرار دارید، با کلیک کردن بر روی «ویرایش» یا «ویرایش مبدأ» در بالای صفحه انجام دهید.
برای ویرایش یا افزودن الگوداده راهنمایی‌های مندرج در #روش‌ها را دنبال کنید.
در صورتی که الگو در صفحهٔ اصلی خود دارای الگوداده باشد
در صورتی که الگو در صفحهٔ اصلی خود دارای الگوداده باشد، باز هم دو گزینه را پیش روی خود دارید:
- می‌توانید آن را به زیرصفحهٔ توضیحات منتقل کنید. این گزینه بر دیگری ارجح است.
- یا این که می‌توانید آن را در صفحهٔ اصلی الگو ویرایش کنید.
انتقال الگوداده به زیرصفحهٔ توضیحات
برای انجام این کار، در صفحهٔ اصلی الگو روی «ویرایش»/«ویرایش مبدأ» کلیک کنید و به‌دنبال برجسب‌های <templatedata> که در میان برچسب‌های <noinclude> قرار گرفته‌اند، بگردید.
این محتوا باید چیزی مشابه متن زیر باشد:
<noinclude>
{{Documentation}}
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "پارامتر نمونه",
"description": "توضیح پارامتر نمونه",
"type": "string"
}
}
}
</templatedata>
</noinclude>
فقط برچسب‌های <templatedata> را از محتوا ببُرید و صفحه را ذخیره کنید.
سپس، زیرصفحهٔ توضیحات را با کلیک بر روی پیوند «[ویرایش]»، که پس از سرآیند « توضیحات الگو» (یا مشابه آن) قرار گرفته، ویرایش کنید.
عنوان یک سرآیند مانند «الگوداده» را تایپ کنید، سپس محتوای الگوداده را زیر آن قرار دهید.
اکنون می‌توانید الگوداده را مطابق با راهنمایی‌های مندرج در #روش‌ها ویرایش کنید.
ویرایش الگوداده در صفحهٔ اصلی الگو
اگر نمی‌خواهید الگوداده را به صفحهٔ /توضیحات منتقل کنید، می‌توانید آن را در صفحهٔ اصلی الگو ویرایش کنید. برای آگاهی از چگونگی ویرایش الگوداده، #روش‌ها را ببینید.
در صورتی که الگو هنوز فاقد الگوداده است، اما زیرصفحهٔ توضیحات را دارد
در صورتی که الگو هنوز فاقد الگوداده است، باید آن را به زیرصفحهٔ توضیحات بیافزایید.
این کار را با کلیک کردن بر روی پیوند «[ویرایش]»، که پس از سرآیند « توضیحات الگو» (یا مشابه آن) قرار گرفته، یا، در صورتی که در صفحهٔ /توضیحات قرار دارید، با کلیک کردن بر روی «ویرایش» یا «ویرایش مبدأ» در بالای صفحه انجام دهید.
عنوان یک سرآیند مانند «الگوداده» را تایپ کنید، سپس محتوای الگوداده را زیر آن قرار دهید.
نحوهٔ افزودن الگوداده در بخش #روش‌ها توضیح داده شده است.
روش‌ها
روش ویرایشگر الگوداده
این روش، راهی ساده برای افزودن یا ویرایش الگوداده است که استفاده از آن به کاربرانی با تجربهٔ کمتر توصیه می‌شود.
ویرایشگر الگوداده یک رابط کاربری گرافیکی برای افزودن و ویرایش الگوداده است. این ویرایشگر بخشی از افزونهٔ الگوداده است که در تمام صفحه‌های الگوها (یا زیرصحفحه‌های توضیحات آنها) از طریق کلیک کردن بر روی «ویرایش» یا «ویرایش مبدأ» در دسترس است.
پس از کلیک کردن بر روی «ویرایش» یا «ویرایش مبدأ»، دکمه‌ای را در بالای پنجرهٔ ویرایش خواهید دید که عنوان آن «ویرایش داده‌های الگو» است.
کلیک کردن بر روی این دکمه شما را به محیط ویرایشگر الگوداده می‌برد. اگر صفحه‌ای که در آن قرار دارید از پیش حاوی الگوداده باشد، محتوای آن به‌طور خودکار در اینجا نمایش می‌یابد.
ویژگی‌های موجود در پنجرهٔ فوق:
- آیتم موجود در بالای پنجره برای انتخاب زبان متن رابط کاربری به‌کار می‌رود. این آیتم امکان وارد کردن محتوای متنی به زبان‌های مختلف، که بر پایهٔ تنظیمات کاربران در ترجیحات به آنها، و نه بر پایهٔ زبان ویکی حاضر به آنها نمایش داده می‌شود را به شما می‌دهد: ویکی‌های مختلف پایگاه‌های دادهٔ کاملاً متفاوتی برای الگوها دارند. اگر الگودادهٔ زبانی موجود نباشد، رابط کاربری تنها زبان خودِ ویکی را به کاربران پیشنهاد می‌دهد، اما کاربرانی می‌توانند روی «$1» کلیک کنند و ورودی‌های بیشتری را بیافزایند. شناسهٔ زبان در داخل کروشه و پس از پارامترهایی که به‌ان‌ها قابل اعمال است، مانند توصیف‌ها و برچسب‌ها، نمایش داده می‌شود.
If no language template data exists, the interface will only offer users the wiki's own language, but users can click "افزودن زبان" to add more inputs. The language code is displayed in brackets next to the parameters to which it can be applied, such as descriptions and labels.
- آیتم بعدی، توصیف الگو است. این در واقع توصیفی است از کلیت عملکرد و کاربرد الگو که در موقعیت‌های مختلفی در ویرایشگرهای الگو هنگام افزودن الگو به کاربران نشان داده می‌شود. توضیح پیرامون این پارامتر و اثرات آن را می‌توانید در اینجا مطالعه کنید.
- آیتم سوم قالب‌بندی ویکی‌متن الگو را کنترل می‌کند. این پارامتر چگونگی قرارگیری ویکی‌متن هنگام کلیک بر روی «اعمال» توسط کاربر را تعیین می‌کند و دو نوع اصلی آن شامل
"inline"(در یک سطر) و"block"(در سطرهای جداگانه) است. توضیح پیرامون این پارامتر و اثرات آن را می‌توانید در اینجا مطالعه کنید.
- اگر کاربر «سفارشی» را انتخاب کند، می‌تواند به‌منظور ایجاد یک قالب‌بندی سفارشی برای الگو هنگام کلیک بر روی «اعمال» توسط کاربر، ویکی‌متنی را تحت «متن قالب‌بندی‌کنندهٔ سفارشی» و مطابق با قواعد مستند شده در اینجا وارد کند.
- آیتم چهارم پارامترهای الگو را پیکربندی می‌کند. اگر پارامترهایی از پیش در الگوداده تعریف شده باشند، در این قسمت در قالب یک فهرست نمایش داده می‌شوند. اگر کد مبدأ الگو پارامترهایی را در خود داشته باشد که برای آنها الگوداده‌ای موجود نباشد، دکمه‌ای را خواهید دید که عنوان آن «$1» است. ویرایشگر، به‌واسطهٔ جستجو برای $2 و $3، این پیشنهادها را از کد مبدأ الگو استخراج می‌کند. با کلیک کردن بر روی «$1»، این پارامترها با استفاده از نام آنها به‌شکلی که در کد مبدأ الگو تعریف شده‌اند، به فهرست افزوده می‌شوند. یک اعلان سبز نیز در بالای صفحه نمایش می‌یابد که متن آن، برای مثال، برابر با «
{{$4|''نام پارامترها''}}» است.
If parameters have already been defined in template data, this area displays them in a list. If the template's source code specifies parameters for which no template data exists, you may see a button labeled "افزودن 2 پارامتر پیشنهادشده". The editor extracts these suggestions from the template's source code by looking for {{{parametername}}} or {{{parametername|}}}. Clicking "افزودن 2 پارامتر پیشنهادشده" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "2 پارامتر تازه وارد شد: names of parameters".
- در پایین پنجره یک دکمهٔ «افزودن پارامتر» را مشاهده می‌کنید. این دکمه امکان افزودن پارامتر به‌صورت دستی به‌همراه نام سفارشی را برای شما فراهم می‌کند.
برای ادامه دادن و رفتن به مرحلهٔ بعدی، روی هر یک از پارامترهای موجود در فهرست کلیک کنید. این کار به شما این امکان را می‌دهد تا اطلاعات آن پارامتر را ویرایش کنید.
توضیحات پیرامون تمامی این ویژگی‌ها و تأثیرات آنها را می‌توانید در بخش #درون نام یک پارامتر مطالعه کنید.
- ویرایشگر الگوداده اجازهٔ تغییر یک پارامتر به یک «نام» خالی را به شما نمی‌دهد. پارامترهای موجود در الگوداده که به‌نحوی رشته‌های خالی را به‌عنوان نام اختیار می‌کنند، در ویرایشگر ویکی‌متن ۲۰۱۰ به‌همراه جادوگر الگو مشکلی ایجاد نمی‌کنند، اما ویرایشگر دیداری و ویرایشگر ویکی‌متن ۲۰۱۷ آنها را به‌هیچ وجه نمایش نخواهد داد. این فیلد، تنها فیلد الزامی در ویرایشگر الگوداده است.
- کلیک کردن بر روی «حذف اطلاعات پارامتر» باعث می‌شود که پارامتر و تمام اطلاعات آن از الگوداده حذف شوند. شما قادر به بازیابی یا واگردانی این تغییر در الگوداده نخواهید بود؛ مگر آن که پس از آن روی «X» کلیک کنید. شما می‌توانید هرگونه تغییر اعمال‌شده پس از کلیک کردن بر روی «اعمال» را با فشردن Ctrl+Z واگردانی کنید.
- خروج از ویرایشگر الگوداده پس از اعمال تغییرات، درخواستی را به شما نشان می‌دهد و از شما می‌خواهد تا عمل چشم‌پوشی از تغییرات خود را تأیید کنید.
در پایان، روی «اعمال» کلیک کنید.
این کار باعث می‌شود که الگوداده در پایین صفحه و پیش از برچسب </noinclude> قرار گیرد؛ یا، در صورتی که الگوداده از پیش موجود باشد، با اطلاعات جدید و بدون تغییر محل قرارگیری آن، به‌روزرسانی خواهد شد.
هرگاه روی «اعمال» کلیک کنید، متن الگوداده نیز انتخاب خواهد شد.
ویرایشگر الگوداده یک پارامتر "paramOrder" را نیز در پایین متن الگوداده ایجاد خواهد کرد (یا آن را در صورت موجود بودن از قبل، به‌روز خواهد کرد).
"paramOrder" حاوی پارامترهای کنونی الگوداده به‌ترتیبی که در ویرایشگر الگوداده نمایش یافته بودند، است.
می‌توانید با کشیدن پارامترها به بالا یا پایین با استفاده از سه خط افقی در سمت راست هر پارامتر در رابط ویرایشگر الگوداده، "paramOrder" را تغییر دهید.
توضیحات پیرامون "paramOrder" و تأثیرات آن در اینجا موجود است.
پس از این روی «ذخیره» کلیک کنید تا نسخهٔ خود را در صفحه ذخیره کنید.
روش دستی
می‌توانید الگوداده را به‌صورت دستی نیز اضافه یا ویرایش کنید.
الگوداده در قالب جی‌سان نوشته می‌شود، اما برای آموختن چگونگی ایجاد الگوداده، نیازی نیست جی‌سان را یاد بگیرید.
الگوداده از چند قانون بسیار ساده پیروی می‌کند و فقط چند پارامتر از پیش تعیین‌شده و مقدارهای ممکن را می‌پذیرد که معمولاً از قالب "parameter": "value" پیروی می‌کنند.
افزودن الگوداده به‌صورت دستی
در نظر داشته باشید:
- اگر در حال افزودن الگوداده به زیرصفحهٔ توضیحات یک الگو هستید (توصیه می‌شود)، می‌توانید آن را به هر جایی از صفحه بیافزایید؛ بررسی کنید که آیا ویکی‌پدیای زبان شما مکانی تعیین‌شده برای آن دارد یا خیر. برای مثال، در ویکی‌پدیای فارسی، الگوداده معمولاً در نزدیکی انتهای صفحهٔ توضیحات افزوده می‌شود؛ اما در ویکی‌پدیای آلمانی، معمولاً در بالای صفحه قرار می‌گیرد.
- اگر در حال افزودن الگوداده به صفحهٔ اصلی یک الگو هستید (توصیه نمی‌شود؛ #بررسی‌های قبلی را ببینید)، باید اطمینان حاصل کنید که آن را درون برچسب‌های
<noinclude>...</noinclude>قرار داده باشید.
در صفحهٔ متعاقب روی «ویرایش» یا «ویرایش مبدأ» کلیک کنید و سپس به موقعیتی از صفحه که قصد قرار دادن الگوداده در آن را دارید بروید و عنوان بخش را تایپ کنید: «الگوداده».
بسیاری از ویکی‌ها دارای یک الگوی {{TemplateData header}} هستند که اعلانی کوتاه پیرامون الگوداده را نمایش می‌دهد. اگر ویکی شما این الگو را دارد، آن را زیر عنوان بخش بیافزایید.
برای آغاز فرایند افزودن الگوداده، یک برچسب آغازین و پایانی <templatedata> را به‌همراه یک جفت آکولاد در دو سطر جداگانه تایپ کنید و یک سطر را میان آنها خالی بگذارید:
<templatedata>
{
}
</templatedata>
سپس، یک دندانه در سطر خالی میان دو آکولاد اضافه کنید و شروع به افزودن پارامترها کنید. جزئیات پیرامون پارامترها را می‌توانید در #پارامترهای الگوداده بیابید. بیشتر این پارامترها اختیاری هستند؛ استفاده از برخی از آنها نیز به‌شدن توصیه می‌شود.
ترتیب‌بندی پارامترها می‌تواند به هر شکلی باشد، اما آنچه در ادامه می‌آید، ترتیبی است که بیشتر با مستندات الگوداده مطابقت دارد و استفاده از محتوا را برای ویرایشگران تسهیل می‌کند:
<templatedata>
{
"description": "",
"format": "",
"params": {
"parameter1": {
"aliases": ["",""]
"label": "",
"description": "",
"type": ""
}
},
"paramOrder": [
""
]
}
</templatedata>
مطمئن شوید که پارامترهایی که برای مثال در شیء "params" قرار دارند، در داخل همان شیء بمانند؛ در غیر این صورت، هنگام تلاش برای ذخیره‌سازی باعث فعال‌شدن یک خطای «ویژگی «نام‌ویژگی» غیرمنتظره است.» خواهید شد.
نمونه
در اینجا چند نمونهٔ الگوداده برای یک الگوی تمیزکاری فرضی آورده شده است. چنین الگویی، یک اعلان را نمایش می‌دهد و صفحه را بر پایهٔ ماه و سال وارد شده به الگو، در رده‌ای تاریخ‌دار قرار می‌دهد. این اعلان ممکن است حاوی پیوندی به یک بخش در صفحهٔ بحث نیز باشد. الگودادهٔ این الگو چیزی مشابه متن زیر خواهد بود:
<templatedata>
{
"description": "از این الگو برای اشاره به نیازمندی مقاله به تمزیکاری استفاده کنید.",
"format": "inline",
"params": {
"date": {
"label": "ماه و سال",
"description": "ماه و سال افزوده شدن الگو",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"example": "اکتبر ۲۰۲۲",
"suggested": true
},
"reason": {
"aliases": ["1"],
"label": "دلیل",
"description": "دلیلی برای نیازمندی مقاله به تمیزکاری",
"type": "string"
},
"talk": {
"aliases": ["بخش بحث"],
"label": "بخش مرتبط در صفحهٔ بحث",
"description": "بخشی در صفحهٔ بحث که حاوی بحث‌های مرتبط است",
"type": "string"
}
},
"paramOrder": [
"date",
"reason",
"talk"
]
}
</templatedata>
مستندات الگودادهٔ متناظر به شکل زیر نمایش خواهد یافت:
از این الگو برای اشاره به نیازمندی مقاله به تمزیکاری استفاده کنید.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| ماه و سال | تاریخ | ماه و سال افزوده شدن الگو
| String | suggested |
| دلیل | دلیل 1 | دلیلی برای نیازمندی مقاله به تمیزکاری | String | optional |
| بخش مرتبط در صفحهٔ بحث | بحث بخش بحث | بخشی در صفحهٔ بحث که حاوی بحث‌های مرتبط است | String | optional |
پارامترهای الگوداده
تمام پارامترهای در دسترس الگوداده به‌همراه توضیح و یک نمونه در زیر فهرست شده‌اند. جزئیات فنی بیشتر برای این پارامترها نیز در Extension:TemplateData#Format فهرست شده‌اند.
- این اطلاعات در تاریخ نوامبر ۲۰۲۱ به‌روز شده‌اند و در صورت افزوده شدن پارامترهای جدید یا به‌روزرسانی رابط‌های کاربری ویرایش الگو به‌منظور پشتیبانی از پارامترهای موجود یا تغییر رفتار در مواجهه با پارامتره،ا ممکن است تغییر کنند.
- نشانه‌گذاری ویکی در توصیف‌ها و برچسب‌ها کار نخواهد کرد. آنها رشته‌های متنی کاملاً ساده هستند.
- سطرهای جدید («
\n») در توصیف‌ها، برچسب‌ها، نمونه‌ها یا پیش‌فرض‌ها در هیچ‌یک از ویرایشگرهای اصلی (جادوگر الگو، ویرایشگر دیداری یا ویرایشگر متنی ۲۰۱۷) نمایش داده نخواهند شد؛ حتی اگر در مستندات الگودادهٔ تولیدشده به‌صورت خودکار نشان داده شوند. آنها در فرم‌های ورودی با یک رشتهٔ خالی، و در مکان‌های دیگر با یک فاصله جایگزین می‌شوند.
| پارامتر | توصیف | نمونه |
|---|---|---|
| description |
پارامتر تأثیرات در صفحهٔ توضیحات الگو، این توصیف به‌شکل متن ساده در زیر زیرعنوان «الگوداده [نام الگو]» نمایش داده می‌شود. در تمام ویرایشگرهای اصلی (VisualEditor، ویرایشگر ویکی‌متن ۲۰۱۷ و WikiEditor به‌همراه جادوگر الگو)، این توصیف در دو حالت اصلی نمایش می‌یابد:
در ویرایشگر دیداری و ویرایشگر ویکی‌متن ۲۰۱۷، حدود ۵۰ نویسه از این توصیف در زیر هر نتیجهٔ پیشنهادی جستجو نمایش می‌یابد و پس از آن یک «...» قرار می گیرد، اما کل توصیف در پنجرهٔ ویرایشگر الگو نمایش داده می‌شود. هر دو به‌شکل متن خاکستری‌رنگ نمایش می‌یابند. در پنجرهٔ اصلی ویرایشگر الگو، به توصیف‌های طولانی‌تر از چهار سطر (حدود ۵۴۰ نویسه) یک نوار لغزنده نیز اضافه می‌شود و متن به‌شکل متن سیاه‌رنگ نمایش می‌یابد. اگر تعریف نشود اگر پارامتر توصیف موجود نباشد یا مقداری برای آن تعریف نشده باشد، متن «بدون توصیف.» در مستندات الگوداده در زیر زیرعنوان «الگوداده [نام الگو]» نمایش خواهد یافت. علاوه بر این:
|
"description": "یک الگو برای پیوند دادن به یک رده در ویکی‌انبار",
|
| format |
پارامتر This parameter is not required, but it is recommended. The default behavior when this parameter is not provided is preserving the existing formatting for existing parameters, or inline formatting for newly added parameters and templates. Effects Inline: ( When inserted, the template will lay its wikitext out on a single line with no white space between elements, like so:
Block: ( When inserted, the template will distribute its parameters each on a new line, with single spaces between each element, like so: {{Foo
| bar = baz
| longparameter = quux
}}
Custom formatting: Alternatively, if the parameter is set to a custom string of wikitext, as per the rules listed at #Custom formats, the template will lay its wikitext out as per the given wikitext. |
"format": "inline"
|
| params |
The It should contain the name of each parameter followed by a set of template data sub-parameters listed in #Within a parameter's name. If there are multiple parameters, place a comma between each parameter object, but do not add one after the last curly bracket (see example). |
"params": {
"parameter1": {
... // parameter info
}, // مشخص کردن ویرگول در اینجا
"parameter2": {
... // parameter info
}, // و اینجا
"parameter3": {
... // parameter info
} // but not here
}
|
| paramOrder |
The How to use Add the parameter The parameters need not be on new lines (they may be written as We recommend you place You must include every parameter mentioned in the template data; otherwise a "ویژگی مورد نیاز «propertyname» پیدا نشد." error will show. If not specified Without With other parameters In the 2010 wikitext editor with TemplateWizard:
In the visual editor and the 2017 wikitext editor, |
"paramOrder": [
"date",
"reason",
"talk"
]
|
Within params
| Parameter | Description | Example |
|---|---|---|
| نام پارامترنام پارامتر |
The only first-level item of the For example, in a template's source code, You may also see parameters named
Note: a user can still force the use of How to use Each of these "نام پارامترنام پارامتر" objects should contain all of the information about the parameter, in the form of more template data parameters. These are listed in the following section, Within a parameter's name. |
"1": { // نام پارامتر
... // اطلاعات در مورد پارامتر اینجا درج می‌شود
}
|
Within the parameter's name
| Parameter | Description | Example |
|---|---|---|
| aliases |
The optional
or
This means that if the user inserts either of these parameters with a value, they will perform the same function. Literally, it translates to, "Value of parameter1. If parameter1 doesn't exist or have a value: value of parameter2." In the second case, it also means, "If parameter2 doesn't exist or have a value: no value." To insert the |
"aliases": ["1", "talk", "talksection"],
|
| inherits |
To use this parameter, type |
"params": {
"موضوع۱": {
"label": "موضوع",
"description": "A topic mentioned on this disambiguation page",
"type": "string"
},
"موضوع۲": {
"inherits": "موضوع۱"
},
"موضوع۳": {
"inherits": "موضوع۱",
"label" : "A different label"
}
}
|
| label |
The |
"label": "Month and year",
|
| description |
Here, |
"description": "The month and year that the template was inserted",
|
| type |
See the #Type parameter section. |
|
| default |
Some template parameters have a default value; the value is used unless overridden by the user.
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), if |
"default": "Category:CommonsRoot",
|
| autovalue |
A parameter can be assigned an This value can be overwritten by the user in the template editor. With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
|
| example |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), this property is displayed below the parameter description (and below the With other parameters In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), |
"example": "January 2013",
|
| suggested values |
The parameter property
Other types (file, page, template, user, date, boolean, URL) are not currently supported because they have special functionalities in the visual editor already, such as autocomplete, which would interfere with the drop-down menu for suggested values in the visual editor. ویرایش داده های الگو به صورت JSON در ویکی متن To add suggested values to any parameter type, add the new property "suggestedvalues" to the parameter in JSON. The “suggestedvalues” attribute must be a list of strings. Editing template data with the template data editor
Effects Once the values have been added to template data, the visual editor will display them in a combo box (a dropdown into which users can also enter a custom value) for the parameter types listed above. The user selects the desired value by clicking on it. If the list of values is long -- for example, a list of a country’s states -- the user can begin typing in the field, whereupon the list will be filtered to show only values containing the typed text. To change an entered value, the user must simply clear the field, and the full dropdown list will appear again. If the user needs a value not included in the list (for example, "message in a bottle") they can type it in manually. |
"suggestedvalues": [
"Journal",
"Book",
"Newspaper",
"Magazine"
]
|
| Status option | Description | Example |
|---|---|---|
| required |
The It determines whether filling in the given parameter is mandatory for the template. Effects This status has several effects in the visual editor and the ویرایشگر ویکی‌متن ۲۰۱۷:
In the WikiEditor with افزونه:جادوگر الگو, as in the other editors, it displays the parameter automatically when a user inserts the template, but the parameter cannot be removed using this or any editor. It also does not display "بخش مورد نیاز است." in the parameter description; rather, it lists the parameter on the side under "پارامترهای اجباری". Other than this, it generally behaves the same as in the other editors, except that the prompt says that the input doesn't "match the expected format". With other parameters In the visual editor and the 2017 wikitext editor, the |
"required": true
|
| suggested |
The Use Effects In the visual editor and the ویرایشگر ویکی‌متن ۲۰۱۷, it causes the parameter to automatically show up when a user inserts a template. If the parameter has an autovalue set, this will also automatically be in the parameter's input box. It has no other effect and doesn't show any additional text or warnings. In the WikiEditor with TemplateWizard, it does not place the parameter in the template automatically but instead causes it to be listed on the side under "پارامترهای پیشنهادی". The user can then click a "+" next to the parameter to add it to the template. With other parameters The |
"suggested": true
|
| deprecated |
Finally, there is This is a status for parameters that should not be used any more but still exist for the time being. This could be because uses of the template are being moved from one set of parameters to another. Effects The effect of this parameter in the visual editor and the 2017 wikitext editor is that a grey exclamation mark shows next to the parameter's label when it is inserted, and in the parameter's information tooltip, the grey, italic text "بخش زشت شده. deprecation reason" is shown below the parameter description. It does not affect the functionality or usability of the parameter or show any additional warnings. Despite the fact that it can take a string, as of January 2020 none of the main editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor) display the contents of the string anywhere to users.
Inputting a string has the same effect as In the 2010 wikitext editor with TemplateWizard, setting this value as With other parameters If you set both this and If you set both this and In the 2010 wikitext editor with TemplateWizard, |
"deprecated": "Please use 'publicationDate' instead."
|
Note: if neither "required", "suggested" nor "deprecated" are set as true for a parameter, its status will show as "optional" in the template data 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 template data, it cannot be checked for errors before saving.
Note that each item of information is enclosed in quotation marks (except for true and false) and separated from the next item by a comma (unless it's the last one).
Type parameter
The "type" 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 template data 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 "type" parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.
Example:
"type": "string",
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.
| Value | Description | |
|---|---|---|
| unknown |
The Effects In all main editors (VisualEditor, 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| string |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| line |
The Effects
| |
| content |
The Effects
| |
| unbalanced-wikitext |
The Effects
| |
| wiki-page-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-file-name |
The Effects
| |
| wiki-template-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| wiki-user-name |
The Effects In all main editors (the visual editor, the 2017 wikitext editor and the 2010 wikitext editor with TemplateWizard), | |
| number |
The Effects
With other parameters
| |
| boolean |
The Effects As of February 2020, none of the main Wikimedia editors (the visual editor, the 2017 wikitext editor or the 2010 wikitext editor with TemplateWizard) make use of this value. It has no visible effects. With the | |
| date |
The Effects
With other parameters
| |
| url |
The Effects
required" setting, but it does not warn the user if they attempt to insert the template without a valid URL. It also occurs with any status setting (such as "suggested"" or "deprecated").
With other parameters
| |
قالب دستی
When editing the "format" 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\nfor new lines).|- pipe (separates parameters)=- equals sign (precedes the value of a parameter)\nor pressing the enter key - new line (this will display as↵in the entry field)\nto 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.
| Objective | Format string | خروجی |
|---|---|---|
| Inline formatting | {{_|_=_}} inline
|
{{Foo|bar=baz|longparameter=quux}}{{Bar}}
|
| Block formatting | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| longparameter = quux
}}{{Bar}}
|
| No space before the parameter name, each template on its own line | \n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|longparameter = quux
}}
{{Bar}}
|
| Indent each parameter | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|longparameter = quux
}}{{Bar}}
|
| Align all parameter names to a given length | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|longparameter = quux
|veryverylongparameter = bat
}}
{{Bar}}
|
| Pipe characters at the end of the previous line | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
longparameter = quux}}{{Bar}}
|
| Inline style with more spaces, must be at start of line | \n{{_ | _ = _}}
|
{{Foo | bar = baz | longparameter = quux}}
{{Bar }}
|
| Template at the start of a line, indent-aligned parameters, pipe beforehand | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
longparameter = quux}}
{{Bar}}
|
Blank boilerplate
You can copy the blank boilerplate below to add new template data to a template. Only the most common tags are included.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Errors
خطای دستوری در جی‌سان یا قالب اشتباه آن
These errors occur when saving template data, usually manually edited, with invalid JSON code (duplicate keys/parameters, trailing or missing commas, etc.) in the visual editor or the 2017 wikitext editor.
"خطای نحوی در جی‌سن." appears in the visual editor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the template data 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 template data 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 (وظیفه T128029). Pages that contain invalid JSON may throw alarming "خطای داخلی" messages. To fix these errors, your best bet is to use a JSON validator (see above).
ویژگی مورد نیاز «paramOrder[تعداد]» پیدا نشد.
This error occurs if you state a parameter in "params" that is not stated in "paramOrder".
The number in the square brackets refers to the parameter in "paramOrder" that is missing. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"reason": { ...
},
"talk": { ... // <-- This parameter is not stated in "paramOrder", but it should be.
}
},
"paramOrder": [
"date",
"reason"
]
// Error: Required property "paramOrder[2]" not found.
To fix this, make sure all parameters stated in "params" are listed in "paramOrder".
Alternatively, you can remove the "paramOrder" object to remove this error.
مقدار ویژگی «paramOrder[تعداد]» نامعتبر است.
This error occurs if you state a parameter in "paramOrder" that is not stated in "params".
The number in the square brackets refers to the parameter in "paramOrder" that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since "paramOrder" is an array; 0 is the first one, 1 is the second, etc.
"params": {
"date": { ...
},
"talk": { ...
}
},
"paramOrder": [
"date",
"reason", // <-- This parameter is not stated in "params", but it should be.
"talk"
]
// Error: Invalid value for property "paramOrder[1]".
To fix this, make sure all parameters stated in "paramOrder" are listed in "params".
Alternatively, you can remove the "paramOrder" object to remove this error.
انتظار می‌رود ویژگی «params.نام پارامتر.required» از نوع «boolean» باشد.
"suggested": "true" // <-- These quotation marks shouldn't be here.
These are boolean values, not strings, therefore they require no quotation marks.
To fix this, remove any quotation marks around the values true or false for these parameters.
Property "format" is expected to be ...
If the "format" parameter exists but its value is not "inline", "block" or a valid format string, you will see the error message "انتظار می‌رود که ویژگی «format» برابر با «inline»، «block» یا یک رشتهٔ قالب‌بندی معتبر باشد.".
"format": "notinline"
// Error : Property "format" is expected to be "inline", "block", or a valid format string.
To fix this, make sure the value after "format": equals "inline" or "block" 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 "format" parameter to remove this error.
ویژگی «نام پارامتر» غیرمنتظره است.
This error occurs if you state a parameter that is unknown in template data. This is probably due to spelling mistakes or the use of uppercase letters instead of lowercase.
<templatedata>
{
"description": "",
"format": "inline",
"params": {
"1": {
"label": "",
"descriptino": "", // <-- spelling mistake
"type": ""
}
}
}
</templatedata>
It also occurs if you state a parameter in any template data 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 template data object under another object that it doesn't belong to.
For example, you might have written the parameter "label" under the root template data object instead of inside "params":
<templatedata>
{
"description": "",
"format": "inline",
"label": "", // <-- incorrectly placed parameter
"params": {
"1": { // ↓ it should be in here
"description": "",
"type": ""
}
}
}
</templatedata>
Alternatively, if the unexpected parameter is under a template parameter inside "params", 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 template data object. You can check which parameters exist for an object in the section #Template data parameters.
ویژگی مورد نیاز «params» پیدا نشد.
This error occurs if there is no "params" object in the template data.
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 "params" parameter.
محدودیت ها و بازخورد
- ویژگی‌های ناموجود – Template data 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 template data, please let us know.
- تاخیر در نشان دادن الگوها – After adding template data 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 template data.
- 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 template data on this wiki
- With dewiki template template data: 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