Help:TemplateData/fa

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

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

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

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

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

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

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



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



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



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

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


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

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

You can also look for a notice at the bottom of the page similar to this: "The above documentation is transcluded from Template:Templatename/doc".

Templates without documentation subpages
اگر یک الگو دارای زیرصفحه توضیحات نیست، شما دو گزینه دارید: پس از این، می‌توانید الگوداده را به زیرصفحه توضیحات اضافه کنید. این گزینه ارجح است.

Creating the subpage and moving the documentation
To create the documentation subpage, click ""/"" on the main template page; look for the tags and their contents (usually at the bottom).

It should look something like this:

You may also find that it already contains TemplateData. If so, it will look something like this:

Select everything after " " and before "" and cut it into your clipboard or save it in a temporary document. Delete " ", leaving only the following:

Save the template page.

Now, to create the new subpage, look at your browser's address bar and add /doc to the end of the URL. Press Enter, then choose the option to create a new page.

If this wiki has a {{}} notice template, add it at the top of the new page. You may also wish to add other templates, such as a {{}} or {{}} link (if supported by the wiki in question). See m:Help:Template documentation for more info.

Insert the text you cut or saved in the previous text (beneath the notice template, if applicable).

Wrap any categories in tags so that they apply only to the template's main page:

Many wikis have a  template. Use this template here if it's likely that the template you're editing exists in a sandbox version (located at "Template:Templatename/sandbox") in order to prevent the categories from applying to the sandbox page:

Finally, publish the page.

You can now add and edit the TemplateData on the documentation subpage using the instructions described in #Methods.

Adding and editing TemplateData on the main template page
If you can't create the /doc page, you can add and edit TemplateData on the template's main page by following the instructions in #Methods.

If a template has a documentation subpage, check both the main page and the documentation subpage for the presence of TemplateData (the tag followed by an array inside curly brackets:  ).

Alternatively, the TemplateData extension can perform this check for you. Click "" or "" on either page. If the template already has TemplateData on either page, you will see a yellow notice at the top of the page saying either:



or

If the template has TemplateData on its documentation subpage

If the template has TemplateData on its documentation subpage, this is the page you should edit. You can do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, by clicking "" or "" at the top. Follow the guidance at #Methods to add or edit the TemplateData.

If the template has TemplateData on its main page

If the template has TemplateData on its main page, you once again have two options:


 * You can either move to its documentation subpage. This is the preferred option.


 * Or, you can edit it on the main template page.

Moving TemplateData to the documentation subpage

To do this, click ""/"" on the main template page, and look for the tags, enclosed within  tags. It should look something like this:

Cut only the tags and their contents out of the code, then save the page.

Next, edit the documentation subpage by clicking the "[edit]" located after the heading " Template documentation" (or similar).

Type a heading, like "TemplateData", then beneath it paste the TemplateData.

You can now edit the TemplateData based on the guidance at #Methods.

Editing TemplateData on the main template page

If you do not wish to move the TemplateData to the /doc page, you can edit it on the main template page. See #Methods for how to edit TemplateData.

If the template does not yet have TemplateData but has a doc subpage

If the template does not yet have TemplateData, you should add it to the documentation subpage.

Do this by clicking the "[edit]" located after the heading " Template documentation" (or similar), or, if you are already on the /doc page, by clicking "" or "" at the top. Type a heading, like "TemplateData", then add it beneath this heading. The section #Methods explains how to add TemplateData.

Methods


روش‌های ویرایشگر الگوداده
This is a simple way to add or edit TemplateData, recommended for less experienced users.

ویرایشگر الگوداده یک رابط کاربری گرافیکی برای افزودن و ویرایش الگوداده است. It is part of the TemplateData extension, available on any template's page (or documentation subpage) by clicking "" or "".

After clicking "" or "", you will see a button above the editing area and page title that says "".

|453px

با کلیک بر روی این دکمه وارد ویرایشگر الگوداده می شوید. If the page you are on already contains TemplateData, it will automatically appear here.

600px| The TemplateData editing tool, on a page with no TemplateData.

Features in the above window:


 * The top item chooses the language of the interface text. It allows you to enter text content in multiple languages, displayed to users based on their settings in Preferences, not based on the wiki's language; different wikis have entirely different template databases. If no language TemplateData 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.
 * The next item is the template description. This is the description of the template as a whole; it's shown to users in numerous places in the template editors while adding a template. This parameter and its effects are outlined here.
 * The third item controls the wikitext formatting of the template. This parameter determines how the wikitext will be laid out when the user clicks "", the two main types being  (on one line) and   (on new lines). This parameter and its effects are outlined here.
 * If the user chooses "", they can enter wikitext under "" according to rules outlined here, in order to create a custom layout for the template when the user clicks "".


 * The fourth item configures a template's parameters. If parameters have already been defined in TemplateData, this area displays them in a list. If the template's source code specifies parameters for which no TemplateData exists, you may see a button labeled "". The editor extracts these suggestions from the template's source code by looking for  or  . Clicking "" will add these parameters using their names as defined in the source code. A green notice will also appear at the top, for example, "".
 * At the bottom of the window you see an "" button. This allows you to add a parameter manually with a custom name.

Continue to the next step by clicking any one of the parameters in the list. This will allow you to edit that parameter's info.

600px

All of these features and their effects are outlined in the section #Within a parameter's name.

When finished, click "". This will automatically insert the TemplateData at the bottom of the page before the tag; or, if already present, it will be updated with the new information without changing its position. The TemplateData text will also be selected when you click "".

The TemplateData editor creates a  parameter at the bottom of the TemplateData (or updates it if it already exists). contains the current TemplateData parameters in the order in which they were displayed by the TemplateData editor. You can change the  by dragging the parameters up and down in the TemplateData editor using the three horizontal bars on the left. and its effects are described here.

After this, click "" to save your revision of the page.

Manual method
You can also add or edit TemplateData manually. ساختار الگوداده بر پایه استاندارد JSON بنا شده است، اما برای یادگیری نحوه قرار دادن الگوداده نیازی به یادگیری JSON نیست. TemplateData follows a few very simple rules and accepts only a few dozen possible predefined parameters and values, typically following a  format.

Adding TemplateData manually

Considerations:


 * If you're adding TemplateData on a template's documentation subpage (recommended), you may add it anywhere on the page; check to see if your language's Wikipedia has a preferred location for it. For example, on the English Wikipedia, TemplateData is typically near the bottom of the documentation page; on the German Wikipedia, it is typically at the top.
 * If you're adding TemplateData on a template's main page (not recommended; see #Prior checks), you must make sure to place it inside the  tags.

Click "" or "" on the respective page, then move to the place in the page where you intend to add TemplateData and write a heading: "TemplateData".

Many wikis have a TemplateData header template that adds a short notice regarding TemplateData. If your wiki does, add it after the heading.

To start adding TemplateData, type an opening and closing tag and a pair of curly brackets on new lines, with an empty line between them:

Next, add an indent on the empty line between the two curly brackets, and start adding parameters. Details for the parameters can be found at #TemplateData parameters. Most are optional; some are highly recommended.

Parameters can be in any order, but what follows is the order that best conforms to TemplateData documentation and makes the content easiest to use for editors:

Make sure the parameters, for example, in the  object, remain inside that object; otherwise you will trigger an "" error when you try to save.

نمونه

در اینجا چند نمونه الگوداده برای یک الگوی پاکسازی فرضی آورده شده است. این الگو یک اعلان را نمایش می‌دهد و کد منبع آن برای قرار دادن صفحه در یک گروه تاریخ‌دار بر اساس ماه و سال وارد شده برنامه‌ریزی می‌شود. 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