Template:Tool/hy/doc

From MediaWiki.org
Jump to navigation Jump to search

Նպատակ[edit]

Այս կաղապարը պետք է ավելացնել այս Վիքիում նկարագրված գործիքների հիմնական էջերին (և միայն հիմնական էջերին)։ Այն ավելացնում է մատակարարված տեղեկությամբ (տես ստորև) օգտակար տեղեկաքարտ և ինքնուրույն ավելացնում է գործիքը բոլոր գործիքների կատեգորիային, ինչպես նաև հարմար կարգավիճակ և իրագործման տեսակ կատեգորիաները։

Օգտագործում[edit]

Պատճենել և փակցնել՝

{{Գործիք
|անուն = 
|վիճակ = 
|տեսակ1 = 
|տեսակ2 = 
|մասնակցիանուն = 
|հեղինակ = 
|նկարագրում = 
|պատկեր = 
|պատկերաչափ = 
|տարբերակ = 
|թարգմացում = 
|մեդիավիքի = 
|php = 
|թույլատրագիր = 
|բեռնում = 
|ինձկարդա = 
|տեղեկամատյանփոխել = 
|պարամետրներ = 
|պիտակներ = 
|օրինակ = 
|համատեղելիություն = 
|bugzilla =
}}

Պարամետրների արժեքների համար, տես ստորև։

ՄեդիաՎիքիի գործիքների ուղեցույց
Crystal Clear action run.png
Tool/hy/doc
ՕՆԼԱՅՆ Ստատուս: անհայտ
PHP {{{php}}}
Թույլատրագիր No license specified
Բեռնում հղում չկա


Բովանդակության պարամետրներ[edit]

Այս բաժինը նկարագրում է այն պարամետրները, որոնք կառավարում են տեղեկաքարտի բովանդակությունը։ Կաղապարիռեժիմ և այլ կարգավորող պարամետրների մասին օգնության համար, խնդրում ենք տեսնել՝ Կարգավորող պարամետրներ։

Բովանդակության պարամետրներ
Parameter Description
անուն գործիքի անուն
վիճակ ներկա հրապարակման կարգավիճակ

Մեկնումեկը՝

  • անկայուն (կոտրված - այս գործիքից չօգտվել)
  • փորձնական (զարգացման առաջին փուլեր, կարող է հիմնականապես փոխվել։)
  • բետա (կայուն բայց ոչ լիիրավ փորձված)
  • կայուն (կայուն տարբերակ)
  • անհայտ (լռելյայն)

Եթե կարգավիճաը վերուն նշվածից տարբեր լինի, այն կանտեսվի և փոխարենը 'անհայտ' լռելյայն արժեքը կցուցադրվի տեղեկաքարտում։ Երբ արժեքը չի ներառվում, անհայտ կատեգորիայում կզետեղվի։ Անվավեր արժեքի դեպքում, այն կտեղադրվի հատուկ կատեգորիայում, որպեսզի սխալը ուղղվի։

տեսակ1
տեսակ2
տեսակ3
տեսակ4
տեսակ5
տեսակ6
իրագործման տեսակ

Տեսակ1,տեսակ2,... պարամետրների թույլատրելի արժեքները՝

Any other value for 'type' is invalid, and will cause the tool to be placed in Category:Tools with invalid or missing type.

Note: Many tools have more than one type, if this applies to yours,replace |type= with |type1=|type2=|type3=.... You may define up to six types for a tool.

մասնակցիանուն The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page.
հեղինակ The tool author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present).
նկարագրում short description
պատկեր screenshot or logo of tool
պատկերաչափ facultative, size of the image (default size is 220px)
տարբերակ last version
թարմացում date of the last update
մեդիավիքի required version of MediaWiki
php required version of PHP
թույլատրագիր license(s) governing use of this tool, e.g. GPL
բեռնում link to the download : SVN or other. If you put the code into page in the MediaWiki Wiki, link to it using a full page name and section name, e.g. [[Tool:Example/version_1.22a#Code]] (it must remain valid when bot-copied elsewhere)
ինձկարդա link to the readme file : README or other
տեղեկամատյանփոխել link to the changelog file : CHANGELOG or other
պարամետրներ available parameters for LocalSettings.php
պիտակներ any tags your tool uses (e.g. <tag1>, <tag2>).
rights rights added by the tool. Not to be confused with the license! Not such as GFDL or LGPL or GPL - those are licenses!
օրինակ example, website or screenshot of working tool
համատեղելիություն compatibility chart, e.g. Template:Extension Testing
CheckUsageNameOverride override the page name used for the check usage link.

Control parameters[edit]

Control parameters
Parameter Description
templatemode Controls auto-categorization of host page.

Normally left blank. Alternate values are:

  • nocats - suppresses categorization and the 'check usage' link. Use this value if you are adding this template to subpages of an extension or to how-to documentation of extensions. For example, the usage image above sets templatemode=nocats because this isn't an actual extension page and we don't want to add this page to any categories on account of it.
  • nousage - suppresses the 'check usage' link. Link is also suppressed if the page is a subpage; it is not in the Extension: namespace; or if suppressed by 'templatemode=nocats'


If this is left blank, this template will add the host page to Category:All tools and to one or more additional categories, depending on the values assigned to the Content parameters.

Using the infobox[edit]

Existing extension pages[edit]

If you want to add the infobox to an existing page, copy and paste the code at the top of this page.

Create a new extension article[edit]

If you want to create a new extension page, enter the name below and click the button. A new page will be created with the infobox template already in place.


Template:Extension/Expectations

Enhancing this template[edit]

If you would like to improve on this template, thanks! This is a complicated template so here is some help along the way:

Fixing documentation[edit]

If you would like to fix documentation, please be aware that documentation and code is split into two files:

  • Template:Tool/hy/doc - stores all documentation.
  • Template:Tool - stores only the code for the template and a small amount of non-included material (category links, transcluded documentation link).


In addition, Template:Tool/Sample stores the boiler plate that is preloaded into newly created pages and contains some basic documentation on how to fill in the template parameters. It needs to be kept in sync with Template:Tool/hy/doc.

The Create extension button[edit]

To improve the create extension button behavior:

Infobox parameters[edit]

In general:

  • To make this template easy to use, each label in the infobox is linked to documentation on the template parameter(s) it displays. If you add a parameter, please be sure to also add it to the content parameter documentation and link its label to that documentation.


To change/correct/add to the implementation type parameters:


To change the behavior of the hook parameters:

Test case[edit]

See if the following pages are still ok, after edited this template.