Help:الگوداده

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Help:TemplateData and the translation is 36% complete.

Outdated translations are marked like this.
Other languages:
अङ्गिका • ‎العربية • ‎asturianu • ‎azərbaycanca • ‎تۆرکجه • ‎български • ‎বাংলা • ‎català • ‎čeština • ‎Cymraeg • ‎dansk • ‎Deutsch • ‎Zazaki • ‎Ελληνικά • ‎emiliàn e rumagnòl • ‎English • ‎español • ‎euskara • ‎فارسی • ‎suomi • ‎føroyskt • ‎français • ‎Frysk • ‎galego • ‎עברית • ‎हिन्दी • ‎hrvatski • ‎magyar • ‎Հայերեն • ‎Bahasa Indonesia • ‎Ilokano • ‎italiano • ‎日本語 • ‎ქართული • ‎한국어 • ‎Lëtzebuergesch • ‎lietuvių • ‎मराठी • ‎Nederlands • ‎occitan • ‎Oromoo • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎Scots • ‎سنڌي • ‎slovenščina • ‎svenska • ‎Türkçe • ‎українська • ‎Tiếng Việt • ‎ייִדיש • ‎中文
PD توجه: وقتی که شما این صفحه را ویرایش کنید، در واقع شما توافق کرده‌اید که تحت سی‌سی‌0 با ما همکاری می‌کنید. برای اطلاعات بیشتر

صفحه‌ی کمک برای دامنه‌های عمومی را نگاه کنید.


PD

TemplateDataExtension:TemplateData روشی برای ذخیره کردن اطلاعات دربارهٔ یک الگو و پارامترهای آن است تا ویرایشگر دیداری بتواند آن را در ویرایشگر الگو بازیابی کند و نمایش دهد. این روش، برای ساده‌سازی ویرایش الگوها است.

الگوداده روی همه ویکی‌های بنیاد نصب شده است. اگر شما یک ویکی دارید، پس نیاز به نصب Extension:TemplateData پیدا می‌کنید.

TemplateData syntax allows users to write small bits of structured data to a template page, or to be transcluded into that template page (such as on a template documentation page). Once a template has this structured data, it can be displayed properly in the VisualEditor. While this may sound complex, it's actually very easy.

There is a built-in tool for editing TemplateData in a simpler way.

To use the TemplateData editor, go to the template's page (or its documentation subpage) and press the "Edit" button. That will give you a button that says "مدیریت TemplateData", just above the open editing window:

Manage template documentation button for TemplateData 2014.png

برای ورود به ویرایش TemplateData توسط ابزار رابط گرافیکی کاربر روی اینجا کلیک کنید.

A screenshot of the TemplateData editing tool

The editor allows you to add template parameters and to set the most common attributes. If the page you edited already contains a block of TemplateData, then the information already documented will automatically be shown when you open the correct page in the TemplateData editor. In the first box, you can add or update a short description of the template in plain text. After that, you can use the "Add suggested parameter(s)" and "Add parameter" buttons to document the names and attributes of the parameters that the template uses.

نکته نکته: If the template documentation is in a subpage, the "Add suggested parameter(s)" button will only appear on the template page. A solution is to edit the template page, click on the "Add suggested parameter(s)" in the TemplateData editor and then copy-and-paste the TemplateData content (between the <templatedata> and </templatedata> tags) in the documentation subpage.

If the template page is protected, you can copy-and-paste the template code in the subpage, use the "Add suggested parameter(s)" button there, copy the TemplateData content, edit back the subpage to get rid of the template code and then paste the TemplateData content. To know where to paste the TemplateData content inside the subpage, you can edit TemplateData without adding anything; you can then replace the <templatedata> and </templatedata> tags and their content by pasting over them.

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. You can also provide an example how to use the parameter. The only required field is Name (the first field in each row), which is where you record the exact, case-sensitive name of the parameter. In the "Type" dropdown menu, you can choose the type of content that the parameter should receive, such as a string (for plain-text answers), page (for links to other pages), or dates. If the template will produce an error if this parameter is left blank, please mark it as "Required". If the parameter is commonly used or recommended, then mark it as "Suggested". The "Remove parameter information" button will delete the parameter's entry from TemplateData.

Screenshot of the TemplateData editor, showing a second parameter being added

When you are finished documenting each of the parameters, click "Apply" to insert the pre-formatted TemplateData into the open editing box. You must still save the page, using the normal "Save" button underneath the editing window.

Caution: The TemplateData editor will place TemplateData on either the template page or on a documentation subpage. You determine where the TemplateData will be added by opening (editing) the page that you want the TemplateData to be placed on. However, if multiple TemplateData blocks are placed on the same template, then only one of those TemplateData blocks will be used. If there is already TemplateData on a page, then you need to edit the page where the TemplateData was previously placed to avoid accidentally creating multiple blocks of TemplateData.

محدودیت‌ها و پرسش‌ها[edit]

  • ویژگی‌های ناموجود — 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 VisualEditor. 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.

Location of TemplateData[edit]

TemplateData shall be on the page it describes, or be transcluded into it. In a template, it shall typically be wrapped into <noinclude>Noinclude tags. On normal page rendering, it displays autogenerated documentation as shown in #Example.

ساختار الگوداده[edit]

ساختار الگوداده بر پایهٔ استاندارد JSON است و نسبتاً ساده می‌باشد. توجه کنید که همهٔ توضیحات الگوداده باید در متن ساده (بدون متن ویکی، بدون پیوند و غیره) باشد.

The first thing to do is to type out a pair of <templatedata> tags, anywhere on the template's documentation subpage, like so:

<templatedata>
{
    ...       // محتوای TemplateData اینجا قرار می‌گیرد
}
</templatedata>

This tells the software that everything between the two tags is TemplateData, and should be referenced when the template is used.

مثال[edit]

The descriptions inside TemplateData follow a standard layout; let's say that you have a template called "Commons" for linking to a Commons category about a topic. It takes one mandatory parameter: the name of the category on Commons. The TemplateData would look something like this:

<templatedata>
{
    "description": "یک الگو برای پیوند دادن به رده ویکی‌انبار دربارهٔ یک مقاله",
    "params": {
        "1": {
            "label": "رده ویکی‌انبار",
            "description": "رده ویکی‌انبار که شما می‌خواهید به آن پیوند دهید.",
            "default": "Category:CommonsRoot",
            "type": "string",
            "required": true
        }
    }
}
</templatedata>

این ممکن است در الگو نمایش داده شود مانند:

یک الگو برای پیوند دادن به رده ویکی‌انبار دربارهٔ یک مقاله

Template parameters

Parameter Description Type Status
رده ویکی‌انبار 1

رده ویکی‌انبار که شما می‌خواهید به آن پیوند دهید.

Default
Category:CommonsRoot
Example
empty
Auto value
empty
String required

توضیحات و پارامترها[edit]

description برچسب نخست، یک "description" است که نحوهٔ عملکرد الگو را توضیح می‌دهد.
"description": "یک الگو برای پیوند دادن به رده ویکی‌انبار",
format Next is "format", which describes how the template's wikitext representation should be laid out. This can be set to either "inline" (پیش‌فرض) or "block".

If the parameter is set to "inline" it will create a wikitext representation with no white space, like so:

{{Foo|bar=baz|qux=quux}}

If the parameter is set to "block" it will create a wikitext representation with line breaks and single spaces between each part, like so:

{{Foo
| bar = baz
| qux = quux
}}
"format": inline
params There is then a "params" tag, which indicates that subsequent sections cover each parameter in the template.

همهٔ پارامترهایی که در ادامه می‌آیند، در بخش "params" قرار داده می‌شوند.

"params": {
    ...    // پارامترها در اینجا قرار می‌گیرند
}
  Within each parameter's subsection, the first tag is the name of the template parameter within the template.

If the parameter has a name, like {{{category-link}}}, this tag would be "category-link".

If the parameter is "unnamed", meaning it's just a number like {{{1}}}, this tag would be "1".

All the bits of information about this parameter are included in the section that starts with the parameter's name.

"1": {     // نام پارامتر
    ...    // اطلاعات در مورد پارامتر اینجا درج می‌شود
}
label Next we have "label", in which you put a human-readable title for the parameter that will be displayed within the template editor.
"label": "رده ویکی‌انبار",
description We then have "description": this time, it's a description of the parameter, not of the template as a whole.
"description": "رده ویکی‌انبار که شما می‌خواهید به آن پیوند دهید.",
default Next is "default". Some templates have a default value that is used unless you change it. This item tells the user what the default value for this parameter is.

اگر پیش‌فرضی وجود ندارد شما می‌توانید این پارامتر را نادیده بگیرید

"default": "Category:CommonsRoot",
type After that we have "type", which controls how the template editor will interpret that parameter. This can be:
  • "string": a set of characters, like this sentence;
  • "number": مجموعه‌ای از اعداد؛
  • "wiki-user-name": a set of characters that represents a user's name;
  • "wiki-page-name": a set of characters that represents a page's title.
  • "wiki-file-name": نام فایل.
"type": "string",
required We then have "required", which can be set to either true or false.

This simply controls whether filling out the parameter is mandatory for that template. If you don't specify, it will be assumed to be false.

"required": true
suggested There is "suggested", which can be set to either true or false.

This is a status for parameters which are not 'required' but are recommended to be high value (but not mandatory) for template users. If you don't specify, it will be assumed to be false.

"suggested": true
deprecated

Finally, there is "deprecated", which can be set to true, false, or a string describing what users should instead do.

This is a status for parameters which 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. If you don't specify, it will be assumed to be false.

"deprecated": "Please use 'publicationDate' instead."

Once you're done, hit "save". 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 each bit of information is enclosed in quotation marks (except for true and false), and separated from the next bit by a comma (unless it's the last one).

Parameter aliases[edit]

Some templates allow a same parameter to have different names.

For example, {{Commons|category=Apples}} could also be written as {{Commons|Apples}} or {{Commons|link=Apples}}.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:

    "params": {
        "رده": {
            ...
            "aliases": ["1", "پیوند"]
        }

مقدار خودکار[edit]

You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use the prefix subst: with the values to make them stick:

    "params": {
        "تاریخ": {
            ...
            "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
        }

Multiple parameters[edit]

If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:

"params": {
    "1": {
        ...
    },      // مشخص کردن ویرگول در اینجا
    "2": {
        ...
    },      // و اینجا
    "3": {
        ...
    }
}

پارامترهای مشابه[edit]

When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.

    "params": {
        "topic1": {
            "label": "موضوع",
            "description": "A topic mentioned on this disambiguation page",
            "type": "string"
        },
        "موضوع۲": {
            "inherits": "موضوع۱"
        },
        "موضوع۳": {
            "inherits": "موضوع۱"
        },
    }

Blank boilerplate[edit]

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

<templatedata>
{
    "description": "",
    "params": {
        "1": {
            "label": "",
            "description": "",
            "type": ""
        },
        "2": {
            "label": "",
            "description": "",
            "type": ""
        }
    }
}
</templatedata>

دیگر ابزارها[edit]

TemplateDataEditor
A user script that makes the process of adding TemplateData easier. It currently exists in French (contains English, Italian, Japanese and Korean translations), and can easily be translated into other languages.
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.