Help:TemplateData/sv

 is a way of storing information about a wikitext template and its parameters, so that VisualEditor can retrieve and display it in its template editor, thus making it easier to edit pages using that template.

The TemplateData extension is installed on all WMF wikis. 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.

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

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 and 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 and tags and their content by pasting over them.

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. You can also provide an example how to use the parameter. 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 "Type" dropdown 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 parameter information" button will delete the parameter's entry from TemplateData.



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 tags. On normal page rendering, it displays autogenerated documentation as shown in #Example.

Structure of TemplateData
TemplateData's structure is based around the JSON standard. Note that all descriptions in TemplateData must be in plain text (no wikitext, no links, etc.).

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

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:

Detta skulle i mallen visas som så:

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

Description and parameters
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  och  ) 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  också skrivar som   eller.

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

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  för att bevara dessa värden:

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å:

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.

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.

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.
 * Lista av alla mallar med MallData på denna wiki
 * Med hjälp av tyskspråkiga wiki mallens MallData visas mallens information i en ruta och mallen läggs till en kategori av mallar med MallData