Help:TemplateData/da



Hvad er TemplateData?
TemplateData er en måde at opbevare information om en skabelon og dens parametre, så VisualEditor kan hente og vise det i skabelonens editor, og dermed gøre det nemmere at redigere skabeloner.

TemplateData giver brugerne mulighed for at skrive små bidder struktureret data på en skabelonside, eller på en side som skal trækkes ind og vises på en skabelonside (som på en dokumentationsside). Når en skabelon har disse strukturerede data, vises det korrekt i VisualEditor. Selvom det kan lyde kompliceret, er det faktisk meget nemt.



TemplateData-struktur
TemplateData strukturen er bygget op omkring JSON-standarden, og er forholdsvis enkel. Bemærk at alle beskrivelser i TemplateData skal være i almindelig tekst (ingen wikitekst, ingen links, etc.).

Det første der skal gøres, er at skrive et par  tags, hvor som helst på skabelonens dokumentation underside, som her:

Dette fortæller softwaren, at alt mellem de to mærker er TemplateData og skal refereres, når skabelonen anvendes.



Eksempel
Beskrivelserne i TemplateData følger et standard layout, så lad os sige at du har en skabelon kaldet "Commons" der skal linke til en Commons kategori om et emne. Det kræver en obligatorisk parameter: navnet på den pågældende Commons-kategori. TemplateData får da dette udseende:

Det vil i skabelonen blive vist sådan: {       "description": "En skabelon for at linke til en commons kategori om en artikel", "params": { "1": {                       "label": "Commons kategori", "description": "Commons kategorien du vil linke til.", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



Beskrivelse og parametre
Når man er færdig, så klik "Gem side". Hvis man har gjort noget galt, så får man ikke lov at gemme (hvilket er irriterende, men betyder at man ikke ødelægger noget). Skulle man komme ud for fejl, så forklar på feedback-siden, hvad du prøvede at gøre. Så vil vi med glæde hjælpe dig.

Vær opmærksom på, at hver delinformation er indesluttet i anførselstegn (undtagen for  og  ), og adskilt fra næste del med et komma (undtagen for den sidste del).



Parameter aliases
Some templates allow a same parameter to have different names.

For example,  could also be written as   or.

To add this information to TemplateData, you simply need to add the aliases to the parameter's information:



Multiple parameters
If you have multiple parameters, just repeat each section (starting from the "1" tag) and fill it out as you see fit. Note that if a template has multiple parameters, you need to separate them with a comma in the templatedata, like so:



Similar parameters
When a template has multiple parameters, sometimes some of them can be of the same kind. In this case, you only need to provide full properties for the first one, and the others can "inherit" their properties from it.



Blank boilerplate
You can copy the blank boilerplate below to add new TemplateData to a template. Only the most common tags are included.



Limitations and questions

 * Missing features — TemplateData is very much an example of tool that was made available with few features, in hope that users would help to guide development of features that they desired. If you'd like to request new features for TemplateData, please let us know.
 * Delays in showing in templates — After adding TemplateData to a template, the metadata should be visible immediately when the template is opened in VisualEditor. However, it is possible that it takes hours before the metadata show. You can force an update by making a null edit to the template page itself (not the documentation subpage). To perform a null edit, open the template page for editing, and save the page without making any change.
 * Current issues — A list of current bugs and feature requests is available in bugzilla.



Værktøjer

 * TemplateDataEditor — A user script that makes the process of adding TemplateData easier. It currently exists in French (contains English, Italian, Japanese and Korean translations), and can easily be translated into other languages.
 * TemplateData Wizard — A tool that generates TemplateData through an interactive interface.
 * Skeleton TemplateData generator — A tool that reads the source wikicode of a template, tries to find all the parameters used and outputs a skeleton document with the parameters listed.
 * JSONLint — A tool that allows you to validate manually-written JSON to help find errors in the syntax.