Help:TemplateData

From MediaWiki.org
Jump to: navigation, search
This page is a translated version of the page Help:TemplateData and the translation is 65% complete.

Outdated translations are marked like this.
Other languages:
अङ्गिका • ‎العربية • ‎asturianu • ‎azərbaycanca • ‎تۆرکجه • ‎български • ‎বাংলা • ‎català • ‎čeština • ‎dansk • ‎Deutsch • ‎Zazaki • ‎Ελληνικά • ‎emiliàn e rumagnòl • ‎English • ‎español • ‎euskara • ‎فارسی • ‎suomi • ‎føroyskt • ‎français • ‎Frysk • ‎galego • ‎עברית • ‎हिन्दी • ‎hrvatski • ‎magyar • ‎Հայերեն • ‎Bahasa Indonesia • ‎Ilokano • ‎italiano • ‎日本語 • ‎ქართული • ‎한국어 • ‎Lëtzebuergesch • ‎lietuvių • ‎मराठी • ‎Nederlands • ‎occitan • ‎Oromoo • ‎polski • ‎پښتو • ‎português • ‎português do Brasil • ‎română • ‎русский • ‎Scots • ‎سنڌي • ‎slovenščina • ‎svenska • ‎Türkçe • ‎українська • ‎Tiếng Việt • ‎ייִדיש • ‎中文
PD Note: When you edit this page, you agree to release your contribution under the CC0. See Public Domain Help Pages for more info.
PD

TemplateDataExtension:TemplateData är ett sätt att lagra information om en mall och dess parametrar så att VisualEditor kan hämta och visa den i mallredigeraren för att förenkla mallredigering.

The TemplateData extension is installed on all wikis operated by the Wikimedia Foundation. If you have your own wiki, then you will need to install Extension:TemplateData.

Syntaxen för MallData låter användare skriva små stycken strukturerad data på en mallsida, eller för infogning på mallsidan (som t.ex. från en malldokumentationssida). När en mall har denna information kan det visas i VisualEditor på rätt sätt. Emedan detta låter komplicerat är det faktiskt mycket enkelt.

TemplateData editor

Det finns ett inbyggt verktyg för att redigera MallData på ett enklare sätt.

För att använda MallDataredigeraren, klicka "Edit"-knappen på mallsidan (eller dokumentationssidan). Detta visar en knapp som säger "Manage TemplateData" alldeles ovanför den öppna redigeringsrutan:

Manage template documentation button for TemplateData 2014.png

Klicka på denna knapp för att öppna det grafiska gränssnittet för att redigera MallData.

A screenshot of the TemplateData editing tool

The editor allows you to add template parameters 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 "Add suggested parameter(s)" and "Add parameter" buttons to document the names and attributes of the parameters that the template uses.

Note Note: If the template documentation is in a subpage, the "Add suggested parameter(s)" button will only appear on the template page. A solution is to edit the template page, click on the "Add suggested parameter(s)" in the TemplateData editor and then copy-and-paste the TemplateData content (between the <templatedata> and </templatedata> tags) in the documentation subpage.

If the template page is protected, you can copy-and-paste the template code in the subpage, use the "Add suggested parameter(s)" button there, copy the TemplateData content, edit back the subpage to get rid of the template code and then paste the TemplateData content. To know where to paste the TemplateData content inside the subpage, you can edit TemplateData without adding anything; you can then replace the <templatedata> and </templatedata> tags and their content by pasting over them.

Du kan lista namnen på parametern, andra namn för parametern, etiketten och beskrivningen som kommer att visas för användarna. De enda fält som krävs är Namn (det första fältet i varje namn) och i det fältet anger du exakt namn för parametern. I popupmenyn kan du välja innehållstypen för den parametern, som t.ex. sträng, sida eller datum. Om mallen ska ge ett fel om en parameter är tom ska den parametern markeras som "Nödvändig". Om parametern används ofta eller om dess användning är rekommenderad ska den markeras som "Föreslagen". "Ta bort"-knappen tar bort parameterns information från MallData.

Screenshot of the TemplateData editor, showing a second parameter being added

När du är färdig med att redigera parametrarna klickar du "Använd" för att infoga den förformaterade MallDatan i den öppna redigeringsrutan. Du måste fortfarande spara sidan med "Spara"-knappen nedanför redigeringsrutan.

Varning: MallDataredigeraren kommer att placera MallData antingen på mallsidan eller på malldokumentationssidan. Det är upp till dig att bestämma var MallData infogas genom att öppna den sida där du vill att MallData ska sparas. Om många MallDatablock placeras på samma mall kommer emellertid endast ett av blocken att användas. Om det redan finns MallData på en sida måste du redigera sidan där MallData lagras för att undvika dubblering av MallDatablock.

Limitations and questions

  • Funktioner som saknas — MallData är ett exempel på ett verktyg som tillhandahölls med få funktioner i hopp om att användare skulle hjälpa till med att styra utvecklingen av funktioner de ville ha. Om du vill be om nya funktioner för MallData, hör av dig.
  • Fördröjning i mallvisning — Då MallData lagts till i en mall borde metadatan genast bli synlig när mallen öppnas i VisualEditor. Det är emellertid möjligt att det kan ta timmar innan metadatan syns. Du kan tvinga mallen att updateras genom att göra en tom redigering till mallen (inte malldokumentationssida). För att göra en tom redigering, öppna mallsidan för redigering och spara sedan sidan utan att göra några ändringar.
  • Nuvarande problem — En lista på nuvarande buggar och begärda funktioner finns på Wikimedias bugg tracker.

Location of TemplateData

TemplateData shall be on the page it describes, or be transcluded into it. In a template, it shall typically be wrapped into <noinclude>Noinclude tags. On normal page rendering, it displays autogenerated documentation as shown in #Example.

Structure of TemplateData

MallDatas struktur baseras på JSON-standarden och är relativt enkel. Notera att alla beskrivningar måste vara oformaterad text (ingen wikitext, inga länkar etc.)

Det första du gör är att skriva in ett par <templatedata>-märken var som helst på mallens dokumentationsside, så här:

<templatedata>
{
    ...       // Innehåll för MallData här
}
</templatedata>

Detta berättar för programvaran att allt mellan de två märkena är MallData som refereras när mallen används.

Example

Beskrivningarna i MallData använder en standardlayout. Låt oss anta att du har en mall som heter "Commons" och som länkar till en Commonskategori om ett visst ämne. Mallen har en obligatorisk parameter - namnet på Commonskategorin. MallDatasektionen skulle se ut typ så här:

<templatedata>
{
    "description": "En mall för att länka till Commonskategorier om ett visst ämne",
    "params": {
        "1": {
            "label": "Commonskategori",
            "description": "Commonskategorin du vill länka till.",
            "default": "Category:CommonsRoot",
            "type": "string",
            "required": true
        }
    }
}
</templatedata>

Detta skulle i mallen visas som så:

En mall för att länka till en Commonskategori för ett visst ämne

Template parameters

Parameter Description Type Status
Commonskategori 1

Commonskategorin du vill länka till.

Default
Category:CommonsRoot
Example
empty
Auto value
empty
String required

Description and parameters

description Det första märket är "description" och det beskriver vad mallen gör.
"description": "En mall för att länka till en Commonskategori",
format Next is "format", which describes how the template's wikitext representation should be laid out. This can be set to either "inline" (ursprungsinställning) or "block".

If the parameter is set to "inline" it will create a wikitext representation with no white space, like so:

{{Foo|bar=baz|qux=quux}}

If the parameter is set to "block" it will create a wikitext representation with line breaks and single spaces between each part, like so:

{{Foo
| bar = baz
| qux = quux
}}
"format": inline
params Sedan har vi "params"-märket som visar att efterföljande sektioner behandlar mallparametrar.

Alla parametrar som följer inkluderas i "params"-sektionen.

"params": {
    ...    // parametrar här
}
  Inom varje parameters undersektion är första märket mallparameterns namn inom mallen.

Om parametern har ett namn, som {{{category-link}}}, skulle detta märke vara "category-link".

Om parametern är namnlös, det vill säga endast ett nummer som {{{1}}}, blir märket "1".

All information om denna parameter täcks av sektionen som börjar med parameterns namn.

"1": {     // parameterns namn
    ...    // information om parametern här
}
label Sedan har vi "label" där du skriver in en läsbar titel för parametern som visas i mallredigeraren.
"label": "Commonskategori",
description Sedan har vi "description" - i det här fallet en beskrivning av parametern och inte hela mallen.
"description": "Commonskategorin du vill länka till.",
default Nästa märke är "default". Vissa mallar har standardvärden som används om du inte ändrar dem. Här visas standardvärdet för parametern.

Du kan ignorera denna parameter om det inte finns något standardvärde.

"default": "Category:CommonsRoot",
type Sedan har vi "type" som kontrollerar hur mallredigeraren tolkar parametern. Detta kan vara:
  • "string": en grupp tecken, som denna mening;
  • "number": en grupp siffror;
  • "wiki-user-name": en grupp tecken som motsvarar ett användarnamn;
  • "wiki-page-name": en grupp tecken som motsvarar ett sidnamn.
  • "wiki-file-name": ett filnamn.
"type": "string",
required Sedan har vi "required" som kan sättas till true eller false.

Detta styr huruvida det är obligatoskt eller inte att definiera parametern. Standardvärdet är false.

"required": true
suggested

Till sist har vi "suggested" som kan sättas till true eller false.

Detta betyder att en parameter inte är obligatorisk, men rekommenderas starkt för mallanvändare. Standardvärdet är false.

"suggested": true
deprecated

Finally, there is "deprecated", which can be set to true, false, or a string describing what users should instead do.

This is a status for parameters which should not be used any more, but still exist for the time being. This could be because uses of the template are being moved from one set of parameters to another. If you don't specify, it will be assumed to be false.

"deprecated": "Please use 'publicationDate' instead."

När du är klar klickar du "spara". Om du gjort ett fel kan du inte spara (vilket kan vara irriterande, men det betyder att du inte kan spara en icke fungerande mall). Om du upptäcker fel kan du förklara på feed-backsidan vad du försökte göra och vi hjälper gärna till.

Notera att varje informationsbit är inom citationstecken (förutom true och false) och åtskild från efterföljande bit med ett komma (om det inte är sista biten).

Parameter aliases

Vissa mallar tillåter att samma parameter har olika namn.

Som exempel kan {{Commons|category=Apples}} också skrivar som {{Commons|Apples}} eller {{Commons|link=Apples}}.

För att lägga till denna information till MallData lägger du helt enkel till aliasen till parameterns information:

    "params": {
        "kategori": {
            ...
            "aliases": ["1", "länk"]
        }

Auto value

Du kan ange ett "automatvärde" för en parameter. När användare lägger till mallen till en sida kommer detta värde att läggas till automatiskt. Som exempel använder många åtgärdsmallar datum. Om du anger ett automatvärde för mallens datumparameter kommer datumet att infogas automatiskt.

För att lägga till denna information i MallData lägger du helt enkelt till automatvärded till parameterns information. Du kommer förmodliugen att vilja använda subst: för att bevara dessa värden:

    "params": {
        "datum": {
            ...
            "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
        }

Multiple parameters

Om du har ett flertal parametrar behöver du bara repetera varje sektion (med början vid märket "1") och fylla i dem som du vill. Notera att om en mall har flera parametrar måste du skilja dem åt i MallData med komman, som så:

"params": {
    "1": {
        ...
    },      // notera kommat här
    "2": {
        ...
    },      // och här
    "3": {
        ...
    }
}

Similar parameters

När en mall har ett flertal parametrar kan flera av dem vara av samma sort. I dessa fall behöver du bara ange full information för den första - de efterföljande kan "ärva" egenskaper från den första.

    "params": {
        "ämne1": {
            "label": "Ämne",
            "description": "Ett ämne som nämns på denna förgreningssida",
            "type": "string"
        },
        "ämne2": {
            "inherits": "ämne1"
        },
        "ämne3": {
            "inherits": "ämne1"
        },
    }

Blank boilerplate

Du kan kopiera den tomma standardtexten nedan för att lägga till MallData till en mall. Endast de vanligaste märkena finns med.

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

Other tools

TemplateDataEditor
Att användarskript som gör det lättare att lägga till MallData. Det finns för nuvarande på franska (innehåller engelska, italienska, japanska och koreanska översättningar) och kan enkelt översättas till andra språk.
TemplateData Wizard
Ett verktyg som skapar MallData genom ett interaktivt gränssnitt.
Skeleton TemplateData generator
Ett verktyg som läser wikitexten i en mall, försöker finna alla använda parametrar och matar ut ett ramdokument med parametrarna listade.
JSONLint
Ett verktyg som låter dig validera handskriven JSON-kod för att hjälpa dig finna syntaxfel.