Vikipedija:TemplateData

Kas yra šablono duomenys?

Šablono duomenys (angl. TemplateData) – standartizuotas šablono aprašymas, naudojamas įrankiuose – „VisualEditor“, 2017 vikiteksto redaktoriuje ir kituose, skirtas palengvinti naudotojams šablonų redagavimo patirtį. Tiek „VisualEditor“, tiek 2017 vikiteksto redaktorius jau turi šablonų redagavimo vedlį, tačiau, vedlys bus naudingiausias tik tada, jeigu pateiks vartotojui konkrečią informaciją apie kiekvieną šabloną, pavyzdžiui, trumpą šablono paskirties ir jo parametrų aprašymą. Būtent tokia informacija ir yra aprašyta šablono duomenyse.

Redagavimas be šablono duomenų

Įterpiant šabloną ir nenaudojant šablono duomenų kiekvieną parametrą reikės pridėti rankiniu būdu.

Informacija, kokia turėtų būti parametro reikšmė – nepateikiama.

Redagavimas naudojant šablono duomenis

Naudojant šablono duomenis, šablonui pateikiamas palaikomų parametrų sąrašas (ir jų aprašymas).

Šablono duomenys suteikia kiekvienam parametrui kontekstą ir leidžia vartotojams daug lengviau keisti šablonus.

Šablono duomenų pridėjimas

Šablonų duomenis pridėti prie šablonų (ypač labai naudojamų, pvz., informacinių lentelių), kad juos būtų lengviau redaguoti su „VisualEditor“, gali kiekvienas. Toliau pateikiamas minimalus pavyzdys, patalpintas šablono dokumentacijos puslapyje:

<templatedata>{
  "description": "čia yra šablono aprašymas",
  "params": {
    "first parameter": {
      "label": "x",
      "description": "x",
      "type": "string",
      "suggested": true,
      "autovalue": "išvestinė automatinė reikšmė",
      "default": "numatytoji reikšmė",
      "required": false
    }
  }
}</templatedata>

Pridėti arba redaguoti šablono duomenis galima naudojant GUI, paspaudžiant šį mygtuką, kuris rodomas redagavimo puslapio viršuje: Edit template data