Wikipedia:Visual Editor/TemplateData leiðbeiningar

Úr Wikipediu, frjálsa alfræðiritinu
Stökkva á: flakk, leita


TemplateData er geymslumiðill fyrir upplýsingar um snið, til dæmis nöfn gilda eða lýsing á sniðinu. Á þann hátt getur Visual Editor ritillinn sótt upplýsingarnar og sýnt notendum þau í viðmótinu. Þótt þetta hljómi flókið þá er það nokkuð auðvelt.

Notkun á TemplateData[breyta]

Uppbygging TemplateData[breyta]

Fyrst er að skrifa tvö <TemplateData> tög, innan við <noinclude></noinclude> tögin eða á „/doc” undirsíðu:

<TemplateData>
{
        ...                            <-- Innihald TemplateData er sett hér.
}
 
</TemplateData>

A.T.H. Kóðinn hér fyrir ofan er ókláraður og mun þess vegna skila villu. Lestu áfram til að klára TemplateData upplýsingarnar.

Þetta segir hugbúnaðinum að allt á milli þessara tveggja taga er TemplateData og eigi að nota þegar sniðinu sé breytt í ritlinum. TemplateData upplýsingarnar sjálfar fylgja hefðbundnu útliti sem ber kennsl á gildin sem eru notuð af sniðinu.

Lyklar[breyta]

Til þess að klára TemplateData upplýsingarnar þarf að bæta við nokkrum lyklum. Lyklarnir eru settir fram í sömu röð og þeim er bætt við í TemplateData.

Fyrsti lykillinn er "description". Þar kemur fram lýsing á sniðinu, innan gæsalappa.

Á eftir því kemur "params" sem er tafla yfir gildi sniðsins. Lyklarnir í þessari töflu eru inndregnir.

"label" Merkimiði gildisins, innan gæsalappa. Merkimiðinn verður birtur sem heiti gildisins. Merkimiðinn má mest vera 20 stafa langur.
"description" Lýsing gildisins, innan gæsalappa. Lýsingin ætti að skýra fyrir notendanum hvað hann getur skrifað við þetta gildi.
"type" Gerð gildisins. Gerðin getur verið "string" - strengur (þ.e. safn stafa eða orða), "number" - tölustafir, "string/wiki-user-name" - gilt notendanafn eða "string/wiki-page-name" - gilt heiti síðu á þessum wiki.
"default" Sjálfgefið eigindargildi fyrir gildið, innan gæsalappa. Eða með öðrum orðum, þau orð sem koma fram ef eigindargildið er ekki gefið.
"required" Tekur við orðunum true eða false. True er tilgreint ef það þarf að tilgreina þetta gildi, en false ef það þarf ekki - þ.e. ef gildið er valfrjálst.
"aliases" Nafn gildis, innan gæsalappa, sem sinnir sama hlutverki í sniðinu. Hér er hægt að nefna gildi sem er hægt að nota í staðinn fyrir höfuðgildið.
"deprecated" Merking sem segir til um að gildið sé úrelt. Getur verið true eða false.
"inherits" Nafn gildis, innan gæsalappa, sem þetta gildi fær upplýsingar frá. Notað fyrir svipuð gildi.

Athugaðu að allar upplýsingar, fyrir utan true og false, eru sett innan gæsalappa.

Nokkur gildi[breyta]

Ef þú hefur nokkur gildi í sniðinu, endurtaktu þá hvern hluta (frá "1" taginu) og fylltu það út. Taktu eftir því að þegar snið hefur nokkur gildi þarf að aðgreina þau með kommu, eins og má sjá hér:

        "params": {
                "1": {
                        ...
                },                     <-- taktu eftir kommunni hér
                "2": {
                        ...
                },                     <-- og hér
                "3": {
                        ...
                }
        }

Svipuð gildi[breyta]

Ef tvö eða fleiri gildi eru svipuð þá nægir að gefa upplýsingarnar upp einu sinni og gefa upp lykilinn "inherits" fyrir hin gildin. Við það eru upplýsingarnar fengnar frá fyrsta gildinu.

        "params": {
                "efni1": {
                        "label": "Efni",
                        "description": "Efni sem er minnst á þessari aðgreiningarsíðu",
                        "type": "string"
                },
                "efni2": {
                        "inherits": "efni1"
                },
                "efni3": {
                        "inherits": "efni1"
                },
        }

Snið með engum gildum[breyta]

Ef sniðið hefur engin gildi þá er lýsingin á sniðinu gefin og taflan fyrir "params" höfð tóm:

<templatedata>{
  "description": "Lýsing sniðsins",
  "params": { }
}</templatedata>


Tómt TemplateData[breyta]

Hérna er gefið tómt TemplateData með algengustu lyklunum, sem þú getur afritað og notað annarstaðar. Mundu eftir því að skrifa nafn gildisins í staðinn fyrir 1, fyrir fyrsta gildið og nafn seinna gildisins í staðinn fyrir 2. Gildi sem hafa enga bókstafi eru tölusettir, þ.e. 1 fyrir fyrsta gildi, 2 fyrir annað, o.s.frv.

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

Takmarkanir[breyta]

  • Eiginleika sem vantar - TemplateData er tól með fáum möguleikum, með þeirri von að notendur myndu segja til um hvaða möguleika vanti. Ef þú vilt óska eftir nýjum möguleikum, vinsamlegast láttu vita á Skilja eftir svörun.
  • Tafir í því að TemplateData birtist á sniðum - Eftir að TemplateData er bætt við snið ættu lýsisgögnin að vera sýnileg um leið og sniðið er opnað í VisualEditor. Það getur þó gerst að það taki nokkra klukkutíma fyrir lýsisgögnin að sjást. Þú getur ýtt við þessu með því að gera breytingu þar sem engu sé breytt.
  • Núverandi villur - Lista yfir núverandi villur og óskum eftir möguleika er að finna á bugzilla.wikimedia.org.

Smáforrit[breyta]

  • TemplateDataEditor — Smáforrit sem gerir þér auðveldara fyrir að bæta við TemplateData.
  • TemplateData Wizard — Smáforrit sem býr til TemplateData í gegnum viðmót.
  • Skeleton TemplateData generator — Smáforrit sem les wikikóða sniðsins og reynir að finna öll gildi þess. Forritið skilar síðan grunnupplýsingum um sniðið.
  • JSONLint — Smáforrit sem hjálpar þér að finna villur í málskipan TemplateData.