Wikipedia:VisualEditor/TemplateData/Pagsursuruan

Manipud iti Wikipedia, ti nawaya nga ensiklopedia


Ania kadi ti TemplateData?[urnosen ti taudan]

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.

Ti TemplateData ket mangpalubos kadagit iagara-aramat ti agsurat kadagiti bassit a naestruktura a datos iti panid ti plantilia, wenno mailak-amto iti dayta a panid ti plantilia (a kas idiay panid ti dokumentasion). Kalpasanton no adda daytoy ti naestruktura a datos, mabalinton a husto a maiparang iti VisualEditor. Bayat a daytoy ket kasla narigat, daytoy ket pudno a nalaka met.

Estruktura ti TemplateData[urnosen ti taudan]

Ti estruktura ti TemplateData ket naibatay iti alagaden ti JSON, ken silple met laeng daytoy. Laglagipen nga amin dagiti palplawag 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 <templatedata>, iti aniaman a lugar ti dokumentasion a subpanid ti plantilia, kasla daytoy:

<templatedata>
{
        ...   <--  ti linaon ti TemplateData ken mapan ditoy
}
</templatedata>

Daytoy ket mangibaga ti sopwer nga aimin nga adda ti baetan dagitoy dua nga etiketa ket ti TemplateData, ken nasken a pagibasaran no mausar ti plantilia

Kas pagarigan[urnosen ti taudan]

Dagiti panangipalplawag 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 anasken a parametro: ti nagan ti kategoria idiay Commons. Ti TemplateData ket kastoyto ti kitana:

<templatedata>
{
        "description": "Ti plantilia a 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
                }
        }
}
</templatedata>

Daytoy ket mangiparanto, idiay plantilia, iti kastoy:

Ti plantilia a panagisilpo ti kategoria idiay commons a maipanggep ti maysa nga artikulo

Dagiti parametro ti plantilia

ParametroDeskripsionKitaKasasaad
Kategoria ti Commons1

Ti kategoria ti commons a kayatmo nga isilpo.

Kasisigud
Category:CommonsRoot
Kuerdasnasken

Panangipalplawag ken dagiti parametro[urnosen ti taudan]


Ti umuna nga etiketa ket ti "description", a mangipalawag no ania ti aramiden ti plantilia.
"description": "Ti plantilia a panagisilpo ti kategoria idiay commons a maipanggep ti maysa nga artikulo",

Addanto metten ti etiketa ti "params" , a manginagan kadagiti sumaruno a paset a sumakop ti tungngal maysa a parametro ti plantilia.

Amin kadagiti parametro a sumaruno ket mairaman iti paset ti "params".

"params": {
        ... <-- mapan ditoy ti parametro
}

Iti uneg ti tungngal maysa a subpaset ti parametro, ti umuna nga etiketa ket ti nagan ti parametro ti plantilia iti kaunegan ti plantilia.

No adda nagan ti parametro, a kas ti {{{category-link}}}, daytoy nga etiketa ket isunto ti "category-link".

No ti parametro ket saan a "nanaganan", a kayatna a saoen ket ti bilang laeng a kas ti {{{1}}}, daytoy nga etiketa ket isunto ti "1".

Amin dagiti pirgis ti pakaammo a maipanggep ti parametro ket mairaman iti paset a mangrugi iti nagan ti parametro.

        "1": {                 <-- nagana ti parametro
                ...            <-- pakaammo a maipanggep ti parametro ket mapan ditoy
        }

Ti sumaruno ket ti "label", ditoy ti pagikabilam ti mabasa ti tao a titulo para iti parametro a maiparangto iti uneg ti editor ti plantilia.
                "label": "Kategoria ti Commons",

Kalpasanna ti "description": tattan ket, ti deskripsion ti parametror, a saan a ti napno a plantilia.
                "description": "Ti kategoria ti commons a kayatmo nga isilpo.",

Ti sumaruno ket ti "default", a mangipalawag ti kasisigud a pateg para iti parametro.

Mabalinmo a saan nga ikaskaso daytoy a parametro no awan ti kasisigud.

                "default": "Category:CommonsRoot",

Kalpasanna daytoy ti "type", a mangtengngel no kasano nga ipatarus ti editor ti plantilia dayta a parametro. Daytoy ket mabalin a:
  • "string":

ti agasmang dagiti karakter, kasla daytoy a sentensia;

  • "number":

ti agasmang dagiti bilang;

  • "string/wiki-user-name":

ti agasmang dagiti karakter a mangirepresenta ti nagan ti agar-aramat;

  • "string/wiki-page-name":

ti agasmang dagiti karakter a mangirepresenta ti titulo ti panid.

                "type": "string",

Kalpasanna addaantayo ti "required", a mabain a maiyasentar iti true wenno false.

Daytoy ket simple laeng a mangtengngel no ti panangipunno ti parametro ket nasken para iti dayta a plantilia.

                "required": true

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 true ken false), ken naisina manipud ti sumaruno a pirgis babae ti koma (malaksid no daytoy ket ti naudi).

Dagiti parbo a nagan ti parametro[urnosen ti taudan]

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

Kas pagarigan, {{Commons|category=Apples}} ket mabalin pay a maisurat a kas ti {{Commons|Apples}} wenno {{Commons|link=Apples}}.

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

        "params": {
                "category": {
                        ... "aliases": ["1", "link"]                      
                }

Dagiti nadumaduma a parametro[urnosen ti taudan]

No addaanka kadagiti nadumaduma a parametro, ulitem 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:

        "params": {
                "1": {
                        ...
                },                     <-- madlaw ti koma (comma) ditoy
                "2": {
                        ...
                },                     <-- ken ditoy
                "3": {
                        ...
                }
        }

Dagiti agpapada a parametro[urnosen ti taudan]

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.

        "params": {
                "topiko1": {
                        "label": "Topiko",
                        "description": "Ti topiko a naibaga iti daytoy a panagipalpalawag a panid",
                        "type": "string",
                },
                "topiko2": {
                        "inherits": "topiko1"
                },
                "topiko3": {
                        "inherits": "topiko1"
                },
        }

Blanko a pagtabasan[urnosen ti taudan]

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

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

Dagiti limitasion ken salsaludsod[urnosen ti taudan]

  • 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 panagurnos ti panid ti plantilia (saan nga idiay dokumentasion a subpanid). Ti panagaramid ti awan linaonna a panagurnos, lukatan ti panid ti plantilia para it panagurnos, ken idulin ti panid nga ti panagaramid ti aniaman a panagbalaliw.
  • Dagiti agdamaparikut — Ti listaan dagiti agdama aparikut ket dagiti kiddaw ti langa ket magun-od idiay bugzilla.
Ti TemplateDataEditor para iti TemplateData
  • TemplateDataEditor — Ti eskritu ti agar-aramat nga agaramid ti nalaklaka a proseso ti panaginayon ti TemplateData . Agdama nga adda daytoy iti Pranses (aglaon kadagiti patarus ti Inggles, Italiano, Hapon ken ken Koreano), ken nalaka met a maipatarus kadagiti sabali a pagsasao.
  • TemplateData Wizard — Ti ramit nga agpataud ti TemplateData babaen ti maysa nga interaktibo nga interface.
  • 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 addaan 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.
  • JSON Formatter - Ramit ti panagpormat ken panagurnos iti JSON.