Help:TemplateData/hy

 is a way of storing information about a wikitext template and its parameters, so that VisualEditor can retrieve and display it in its template editor, thus making it easier to edit pages using that template.

Կաղապարի տվյալների հավելումը ներդրված է ՎՄՀ-ի բոլոր վիքիներում։ Եթե դու սեփական վիքին ունես, ապա պետք է տեղադրես Extension:TemplateData-ն։

ԿաղապարիՏվյալը կաղապարների կոդերին ավելացնում է ընդամենը մի քանի բիթանոց տվյալներ և դրանով հեշտացնում տվյալ կաղապարի խմբագրումը ՎիզուալԽմբագրիչով:

TemplateData editor
Գոյություն ունի ԿաղապարիՏվյալի պարզ խմբագրման համար ներդրված գործիք:

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 "", just above the open editing window:

Click this button to enter the GUI tool for editing TemplateData.

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 and 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 and 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.



Ավարտելուց հետո սեղմեք "Հիշել":

Ուշադրություն. ԿաղապարիՏվյալի խմբագրիչը կավելացնի ԿաղապարիՏվյալը կաղապարի էջում կամ նրա փաստաթղթում:

Սահմանափակումներ և հարցեր

 * Բացակայող պարամետրեր — ԿաղապարիՏվյալը գործիքի օրինակ է, որով կպարզեցվի ՎիզուալԽմբագրիչի աշխատանքը:
 * Կաղապարների ցուցադրման հետաձգումներ — ԿաղապարիՏվյալ ավելացնելուց հետո մետադատան միանգամից պետք է ցուցադրվի, երբ ՎիզուալԽմբագրիչում բացվում է կաղապարը:
 * Առկա խնդիրներ — Առկա խնդիրներն ու առաջարկներն առկա են Վիքիմեդիայի խնդիրների էջում:

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

ԿաղապարիՏվյալի կառուցվածք
TemplateData's structure is based around the JSON standard. Note that all descriptions in TemplateData must be in plain text (no wikitext, no links, etc.).

Առաջին քայլը  նշման ավելացումն է կաղապարի փաստաթղթում, օրինակ`

Սա ցույց է տալիս, որ երկու պիտակների միջև առկա է ԿաղապարիՏվյալ:

Օրինակ
ԿաղապարիՏվյալի ներսում նկարագրությունները ունեն ստանդարտ դասավորություն: Օրինակ` ունենք "Վիքիպահեստ" կաղապարը. այն ունի մեկ պարտադիր պարամետր: Այս կաղապարի ԿաղապարիՏվյալը կունենա հետևյալ տեսքը

Սա կցուցադրվի կաղապարում հետևյալ ձևով.

{   "description": "Վիքիպահեստի կատեգորիային կապելու կաղապար", "params": { "1": {           "label": "Վիքիպահեստի կատեգորիա", "description": "Վիքիպահեստի կատեգորիան, որին ցանկանում եք միացնել:", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

Նկարագրություն և պարամետրեր
Վերջացնելուց հետո սեղմեք "հիշել": Եթե սխալներ եք թույլ տվել, էջը չի պահպանվի:

Հաշվի առեք, որ տեղեկության յուրաքանչյուր բիթ ընդգրկված է քաղվածելու պիտակի մեջ և հաջորդ բիթից առանձնացված է ստորակետով:

Parameter aliases
Որոշ կաղապարներ թույլ են տալիս, որ նույն պարամետրը ունենա տարբեր անվանումներ:

Օրինակ` ը կարող է գրվել նաև   կամ  :

Այս տեղեկությունը ԿաղապարիՏվյալին ավելացնելու համար անհրաժեշտ է պարամետրի տեղեկությանը ավելացնել ծածկանունը:

Ինքնարժեք
Դուք կարող եք սահմանել պարամետրի "ինքնարժեք":

Այս տեղեկությունը ԿաղապարիՏվյալին ավելացնելու համար պարզապես ավելացրեք ինքնարժեքը պարամետրի բովանդակությանը: Արժեքները ճիշտ դարձնելու համար կցանկանաք օգտագործել.

Մի քանի պարամետրեր
Եթե առկա են մի քանի պարամետրեր, պարզապես կրկնեք յուրաքանչյուր բաժինը և լրացրեք դրանք:

Նույնատիպ պարամետրեր
Եթե կաղապարն ունի մի քանի պարամետրեր, նրանցից մի քանիսը սովորաբար լինում են նույն տեսակի: Այս դեպքում անհրաժեշտ է նշել միայն առաջինի բովանդակությունը:

Blank boilerplate
Դուք կարող եք կաղապարին ԿաղապարիՏվյալ ավելացնելու համար պատճենել ներքևի դատարկ կոդը:

Այլ գործիքներ

 * TemplateDataEditor: Խմբագրիչ, որը հեշտացնում է ԿաղապարիՏվյալի ներդնումը կաղապարի մեջ: Այդպիսի խմբագրիչ առկա է ֆրանսերենում և կարող է թարգմանվել այլ լեզուներով:
 * TemplateData Wizard: Գործիք, որը ստանում է ԿաղապարիՏվյալ ինտերակտիվ ինտերֆեյսից:
 * Skeleton TemplateData generator: Գործիք, որը կարդում է կաղապարի վիքիտեքստը և փորձում է տեղեկություն քաղել պարամետրերի մասին:
 * JSONLint: Գործիք, որն օգնում է հաստատել ձեռքով գրված JSON, որպեսզի գտնի սխալները:
 * Այս վիքիի բոլոր ԿաղապարիՏվյալով կաղապարները
 * Գերմաներեն վիքիում ԿաղապարիՏվյալ կաղապարի տվյալը երևում է աղյուսակում և այդ կաղապարը ավելացված է կաղապարի տվյալով կաղապարների կատեգորիային: