Help:TemplateData/ilo



Ania kadi ti TemplateData?
Ti TemplateData ket isu ti waya ti panagipenpen ti pakaammo a maipanggep ti plantilia ken dagiti parametrona, tapno ti VisualEditor ket makaala ket makaiparang daytoy idiay editor ti plantilia, tapno mapalaka ti agurnos kadagiti plantilia.

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



TemplateData editor
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 "", just above the open editing window: Click this button to enter the GUI tool for editing TemplateData. The editor allows you to add one row per template parameter 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 "Import parameters" and "Add parameters" buttons to document the names and attributes of the parameters that the template uses.

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. 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 pop-up 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" button will delete the parameter's entry from TemplateData.

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.



Estruktura ti TemplateData
Ti estruktura ti TemplateData ket naibatay iti alagaden ti JSON, ken silple met laeng daytoy. Laglagipen nga amin dagiti deskripsion iti TemplateData ket nasken a naranas a testo (awan ti wikitext, wenno silsilpo, kdpy).

Ti umuna nga aramiden ket ti panangimakinilia ti paris dagiti etiketa ti, iti aniaman a lugar ti dokumentasion a subpanid ti plantilia, kasla daytoy:

Daytoy ket mangibaga ti sopwer nga amin nga adda ti baetan dagitoy dua nga etiketa ket ti TemplateData, ken nasken a maibasaran no mausar ti plantilia.



Kas pagarigan
Dagiti deskripsion ti uneg ti TemplateData ket sumurot ti alagaden a tabas; kunatayo koma nga addaanka ti plantilia a tinawtawagan ti "Commons" para iti panagisilpo ti kategoria ti Commons a maipanggep ti topiko. Daytoy ket mangala ti maysa a nasken a parametro: ti nagan ti kategoria idiay Commons. Ti TemplateData ket kastoyto ti kitana:

Daytoy ket mangiparangto, iti plantilia, a kastoy: {       "description": "Ti plantilia para iti panagisilpo ti kategoria idiay commons a maipanggep ti maysa nga artikulo", "params": { "1": {                       "label": "Kategoria ti Commons", "description": "Ti kategoria ti commons a kayatmo nga isilpo.", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



Deskripsion ken dagiti parametro
No nalpaskan, talmegam ti "idulin". No addaanka kadagiti biddut, daytoy ket saan a mangpalubos kenka nga agidulin (a makariro, ngem nasayaat ta saaka a makadadael). No makasarakka kadagiti biddut, ipadamagmo idiay pagibagaan a panid no ania ti padpadasem nga ar-aramiden, ken naragsak kaminto a tumulong kenka.

Laglagipen a ti tungngal maysa a pirgis ti pakaammo ket narikpan kadagiti marka ti sasao (malaksid para iti  ken  ), ken naisina manipud ti sumaruno a pirgis babaen ti koma (malaksid no daytoy ket ti naudi).



Dagiti parbo a nagan ti parametro
Adda met dagiti plantilia a mangpalubos ti isumet laeng a parametro nga addaan ti sabali a nagnagan.

Kas pagarigan,  ket mabalin pay a maisurat a kas ti   wenno.

Ti pananginayon ti daytoy a pakaammo iti TemplateData, simple laeng nga inayon dagiti parbo a nagan iti pakaammo ti parametro:



Auto value
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  to make the values stick:



Dagiti nadumaduma a parametro
No addaanka kadagiti nadumaduma a parametro, uliem laeng ti tungngal maysa a paset (mangrugi manipud ti etiketa ti "1" ) ken punnuem dagitoy no mabalin. Laglagipen a no ti plantilia ket addan kadagiti nadumaduma a parametro, nasken nga ilasinmo koma ida iti TemplateData, a kasla daytoy:



Dagiti agpapada a parametro
No ti plantilia ket addan kadagiti nadumaduma a parametro, sagpaminsan nga adda dagitoy ket agpapada a kita. Iti daytoy a kaso, nasken laeng a mangtedka kadagiti napno a tagikua para iti umuna, ken dagiti dadduma ket "tawidanda" dagiti tagikuada manipud ti immuna.



Blanko a pagtabasan
Mabalinmo ti agkopia ti blanko a pagtabasan dita baba tapno makanayon ti baro a TemplateData iti plantilia. Dagiti laeng kadawyan nga etiketa ti nairaman.



Dagiti limitasion ken salsaludsod

 * Dagiti awan a langa — Ti TemplateData ket kas pagarigan laeng ti ramit a naaramid a magun-od nga addan laeng kadagiti bassit a langai, iti namnama a dagiti agar-aramat ket mangtulong a mangkuyog ti panagrang-ay dagiti langa a kayatda. No kayatmo ti agkiddaw kadagiti baro a langa para iti TemplateData, pangngaasi a pakaammuan dakami.
 * Mangtaktak ti panangipakita kadagiti plantilia — Kalpasan ti pananginayon ti TemplateData iti plantilia, ti metadata ket nasken koma a dagus a makita no ti plantilia ket nalukatan iti VisualEditor. Nupay kasta, daytoy ket mabalin nga agapaut kadagiti adu nga oras sakbay a maiparang ti metadata. Mabalinmo a piliten a pabaruen ti awan linaonna a panag-urnos ti panid ti plantilia (saan nga idiay dokumentasion a subpanid). Ti panagaramid ti awan linaonna a panag-urnos, lukatan ti panid ti plantilia para it panag-urnos, ken idulin ti panid nga awan ti panagaramid ti aniaman a panagbalaliw.
 * Dagiti agdama parikut — Ti listaan dagiti agdama a parikut ken dagiti kiddaw ti langa ket magun-od idiay bugzilla.



Other tools

 * TemplateDataEditor — Ti eskritu ti agar-aramat nga agaramid ti nalaklaka a proseso ti panaginayon ti TemplateData. Agdama nga adda daytoy iti Inggles ken Pranses, ken nalaka met a maipatarus kadagiti sabali a pagsasao.
 * TemplateData Wizard — Ti ramit nga gapataud ti TemplateData babaen ti maysa nga interaktibo nga interface.
 * Skeleton TemplateData generator — Ti ramit a mangbasa ti taudan ti wikicode ti plantilia, ken mangpadas nga agbiruk kadagiti amin a parametro nga inus-usar ken mangiparuar ti rurog a dokumento nga addan dagiti nailista a parametro.
 * JSONLint — Ti ramit a mangpalubos kenka a mangpasingked ti naisurat ti ima a JSON tapno makatulong nga agbiruk kadagiti biddut ti eskritu.
 * List of all templates with TemplateData on this wiki