Open main menu

Help:ԿաղապարիՏվյալ

This page is a translated version of the page Help:TemplateData and the translation is 62% complete.
Outdated translations are marked like this.
Other languages:
Bahasa Indonesia • ‎Cymraeg • ‎Deutsch • ‎English • ‎Ilokano • ‎Lëtzebuergesch • ‎Nederlands • ‎Oromoo • ‎Scots • ‎Tiếng Việt • ‎Türkçe • ‎Zazaki • ‎asturianu • ‎azərbaycanca • ‎català • ‎dansk • ‎emiliàn e rumagnòl • ‎español • ‎euskara • ‎français • ‎føroyskt • ‎galego • ‎hrvatski • ‎italiano • ‎lietuvių • ‎magyar • ‎occitan • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎slovenčina • ‎slovenščina • ‎suomi • ‎svenska • ‎čeština • ‎Ελληνικά • ‎български • ‎македонски • ‎русский • ‎српски / srpski • ‎українська • ‎հայերեն • ‎ייִדיש • ‎עברית • ‎العربية • ‎تۆرکجه • ‎سنڌي • ‎فارسی • ‎پښتو • ‎अङ्गिका • ‎अवधी • ‎मराठी • ‎हिन्दी • ‎বাংলা • ‎ไทย • ‎ქართული • ‎中文 • ‎日本語 • ‎ꯃꯤꯇꯩ ꯂꯣꯟ • ‎한국어
PD Ուշադրություն. Այս էջը խմբագրելով` դուք համաձայնվում եք հրապարակել ձեր ներդրումը CC0 արտոնագրի ներքո։ Մանրամասն տեղեկությունների համար ծանոթացեք օգնության էջերի կանոնակարգին:
PD

ՎիզուալԽմբագրիչը` վիքիէջերը խմբագրելու վիզուալ հավելումը, պարունակում է կաղապարները հեշտ խմբագրելու գործիք: Որպեսզի նրա աշխատանքն էլ ավելի օգտակար լինի, այն պետք է կաղապարի մասին տեղեկություն հավաքի: Մասնավորապես` այն կարիք ունի իմանալու կաղապարի հնարավոր պարամետրերն ու նրանց բովանդակությունները:

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

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

TemplateData-ի խմբագրիչ

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

ԿաղապարիՏվյալի խմբագրիչը օգտագործելու համար գնացեք կաղապարի էջ (կամ նրա փաստաթղթի էջ) և սեղմեք "Խմբագրել" կոճակը: Կբացվի "Manage TemplateData" կոճակը:

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

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

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

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

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

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 <noinclude> tags. On normal page rendering, it displays autogenerated documentation as shown in #Example.

ԿաղապարիՏվյալի կառուցվածք

ԿաղապարիՏվյալի կառուցվածքը հիմնված է JSON-ի վրա:

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

<templatedata>
{
    ...       // ԿաղապարիՏվյալի պարունակությունը գրվում է այստեղ
}
</templatedata>

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

Օրինակ

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

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

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

Վիքիպահեստի կատեգորիային կապելու կաղապար

Template parameters

ParameterDescriptionTypeStatus
Վիքիպահեստի կատեգորիա1

Վիքիպահեստի կատեգորիան, որին ցանկանում եք միացնել:

Default
Category:CommonsRoot
Stringrequired

Նկարագրություն և պարամետրեր

description Առաջին նշումը "description"ն է, որը նկարագրում է, թե ինչ է անում կաղապարը:
"description": "Վիքիպահեստի կատեգորիային կապելու կաղապար",
format Հաջորդը "format"-ն է, որը նկարագրում է, թե ինչպես պետք է ցուցադրվի կաղապարի վիքիտեքստը։

Սա կարող է լինել կամ "inline" (default) կամ "block"։

Եթե արժեքը "inline" է, այն վիքիտեքսը ցույց կտա առանց սպիտակ բացատների, օրինակ՝

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

Եթե արժեքը "block" է, այն վիքիտեքստը ցույց կտա կոտրված տողերով և մասերի միջև բացատներով, օրինակ՝

{{Foo
| bar = baz
| qux = quux
}}
"format": inline
params Այնուհետև գալիս է "params" պիտակը:

Բոլոր պարամետրերը ընդգրկված են "params" բաժնում:

"params": {
    ...    // պարամետրերը գրվում են այստեղ
}
  Յուրաքանչյուր պարամետրի ենթաբաժնում առաջինը գրվում է կաղապարի պարամետրի անվանումը:

Եթե պարամետրը անուն ունի, օրինակ` {{{category-link}}}, այն կերևա "category-link" տեսքով:

Եթե պարամետրը անուն չունի, օրինակ` {{{1}}}, այն կերևա "1" տեսքով:

Այս պարամետրի մասին ամբողջ ինֆորմացիան առկա է պարամետրի անունով սկսվող մասում:

"1": {     // պարամետրի անվանում
    ...    // պարամետրի մասին տեղեկությունը գրվում է այստեղ
}
label Հաջորդը գալիս է "label", որտեղ ներդրվում է մարդու կողմից կարդացվելիք պարամետրի անվանումը, որը պետք է ցուցադրվի կաղապարի խմբագրիչում:
"label": "Վիքիպահեստի կատեգորիա",
description Այնուհետև գալիս է "description", որն իրենից ներկայացնում է պարամետրի նկարագրությունը:
"description": "Վիքիպահեստի կատեգորիան, որին ցանկանում եք միացնել:",
default Առկա է նաև "default": Որոշ կաղապարներ ունեն լռելայն արժեք:

Կարող եք անտեսել այս պարամետրը, եթե չկա լռելայն:

"default": "Category:CommonsRoot",
type Դրանից հետո գալիս է "type", որը կարգավորում է, թե ինչպես խմբագրիչը կհասկանա այդ պարամետրը: Այն կարող է լինել.
  • "string": նշանների շարք,
  • "number": թվերի շարք,
  • "boolean": '0' for false, '1' for true, '' for unknown;
  • "wiki-user-name": մասնակցի անվանումը ցույց տվող նշանների շարք,
  • "wiki-page-name": էջի անվանումը ցույց տվող նշանների շարք,
  • "wiki-file-name": ֆայլի անվանում:

Other types include: "unknown", "date", "url", "wiki-template-name", "content", "unbalanced-wikitext", "line"

"type": "string",
required Գոյություն ունի նաև "required", որը կարող է լինել true կամ false:

Այս ամենը կարգավորում է կաղապարի պարամետրի լրացման պարտադիր լինելը:

"required": true
suggested

Գոյություն ունի նաև "suggested", որը կարող է լինել true կամ 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 if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.

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

Custom formats

When editing custom format strings in the TemplateData editor you can either type \n or press the enter key to represent a newline; in either case it will display as in the entry field.

Examples of formats you can use
Objective Format string Output
Inline formatting {{_|_=_}}
inline
{{Foo|bar=baz|qux=quux}}{{Bar}}
Block formatting {{_\n| _ = _\n}}
block
{{Foo
| bar = baz
| qux = quux
}}{{Bar
}}
No space before the parameter name,

each template on its own line

\n{{_\n|_ = _\n}}\n
{{Foo
|bar = baz
|qux = quux
}}
{{Bar
}}
Indent each parameter {{_\n |_ = _\n}}
{{Foo
 |bar = baz
 |qux = quux
}}{{Bar
}}
Align all parameter names to a given length {{_\n|_______________ = _\n}}\n
{{Foo
|bar             = baz
|qux             = quux
|veryverylongparameter = bat
}}
{{Bar
}}
Pipe characters at the end of the previous line {{_|\n _______________ = _}}
{{Foo|
  bar             = baz|
  qux             = quux}}{{Bar}}
Inline style with more spaces, must be at start of line \n{{_ | _ = _}}
{{Foo | bar = baz | qux = quux}}
{{Bar }}
Template at the start of a line, indent-aligned parameters, pipe beforehand \n{{_ |\n _______________ = _}}
{{Foo |
  bar             = baz |
  qux             = quux}}
{{Bar}}

Parameter aliases

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

Օրինակ` {{Commons|category=Apples}}ը կարող է գրվել նաև {{Commons|Apples}} կամ {{Commons|link=Apples}}:

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

    "params": {
        "կատեգորիա": {
            ...
            "aliases": ["1", "հղում"]
        }

Ինքնարժեք

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

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

    "params": {
        "ամսաթիվ": {
            ...
            "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
        }

Մի քանի պարամետրեր

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

"params": {
    "1": {
        ...
    },      // ուշադրություն դարձրեք ստորակետին այստեղ
    "2": {
        ...
    },      // և այստեղ
    "3": {
        ...
    }
}

Նույնատիպ պարամետրեր

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

    "params": {
        "թեմա1": {
            "label": "Թեմա",
            "description": "Թեմա, որը նշված է այս բազմիմաստության էջում",
            "type": "string"
        },
        "թեմա2": {
            "inherits": "թեմա1"
        },
        "թեմա3": {
            "inherits": "թեմա1"
        },
    }

Blank boilerplate

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

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

Errors

Syntax Error in JSON / Bad JSON format

Due to a long standing bug, users using the old wikitext editor are able to save pages which have certain types of invalid JSON, such as duplicate keys or trailing commas (details: task T128029). However if you attempt to save this page in a JavaScript based editor, such as VisualEditor or the 2017 Wikitext editor, you will see an error message "Syntax error in JSON," as the JavaScript parser is stricter and doesn't allow invalid JSON. Additionally, if you attempt to open up such invalid JSON with the Template Data GUI editor, you will see the error message, "Bad JSON format." To fix these errors, you can enter the JSON block into an external JSON validator, such as https://jsonlint.com/, and it will highlight the problematic commas and keys so they can be removed.

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

Help:Extension:TemplateWizard
A toolbar dialog window for entering template wikitext via an form built from TemplateData.
TemplateData Wizard
Գործիք, որը ստանում է ԿաղապարիՏվյալ ինտերակտիվ ինտերֆեյսից:
Skeleton TemplateData generator
Գործիք, որը կարդում է կաղապարի վիքիտեքստը և փորձում է տեղեկություն քաղել պարամետրերի մասին:
JSONLint
Գործիք, որն օգնում է հաստատել ձեռքով գրված JSON, որպեսզի գտնի սխալները: