Help:TemplateData/sv

 ä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 "" alldeles ovanför den öppna redigeringsrutan:

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

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

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.



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

Note that if you are abusing a hack template to dynamically generate TemplateData, it cannot be checked for errors before saving.

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

Custom formats
When editing custom format strings in the TemplateData editor you can either type  or press the enter key to represent a newline; in either case it will display as   in the entry field.

{| class="wikitable" ! style="width:25%" | Objective ! Format string ! Output each template on its own line
 * + Examples of formats you can use
 * Inline formatting
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * Block formatting
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * No space before the parameter name,
 * Indent each parameter
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Align all parameter names to a given length
 * Pipe characters at the end of the previous line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Inline style with more spaces, must be at start of line
 * Template at the start of a line, indent-aligned parameters, pipe beforehand
 * också skrivar som  eller.
 * 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.

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.

Syntax Error in JSON / Bad JSON format
Due to a long standing bug, users using the old wikitext editor are able to save pages which have certain types of invalid JSON, such as duplicate keys or trailing commas (details: ). However if you attempt to save this page in a JavaScript based editor, such as VisualEditor or the 2017 Wikitext editor, you will see an error message "Syntax error in JSON," as the JavaScript parser is stricter and doesn't allow invalid JSON. Additionally, if you attempt to open up such invalid JSON with the Template Data GUI editor, you will see the error message, "Bad JSON format." To fix these errors, you can enter the JSON block into an external JSON validator, such as JSONLint, and it will highlight the problematic commas and keys so they can be removed.

Other tools

 * : A toolbar dialog window for entering template wikitext via an form built from TemplateData.
 * 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