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 editor
There is a built-in tool for editing TemplateData. It may not be installed on your wiki yet.

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 one row per template parameter 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 "Import parameters" and "Add parameters" buttons to document the names and attributes of the parameters that the template uses.

You can list the name of the parameter, any aliases for it, the label and the description that will display to users. 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 pop-up 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" button will delete the parameter's entry from TemplateData.

When you are finished documenting each of the parameters, click "Apply" to insert the pre-formatted TemplateData into the open editing box. You must still save the page, using the normal "Save" button underneath the editing window.

Caution: The TemplateData editor will place TemplateData on either the template page or on a documentation subpage. You determine where the TemplateData will be added by opening (editing) the page that you want the TemplateData to be placed on. However, if multiple TemplateData blocks are placed on the same template, then only one of those TemplateData blocks will be used. If there is already TemplateData on a page, then you need to edit the page where the TemplateData was previously placed to avoid accidentally creating multiple blocks of TemplateData.



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



Aliasser for parametre
Nogle skabeloner tillader, at samme parameter har flere navne.

For eksempel kunne  også skrives som   eller.

For at føje denne information til TemplateData, så behøver man blot at tilføje aliasserne til parameterens information:



Auto value
You can specify an "autovalue" for a parameter. When users add the template to a page, the value will be added automatically. An example is when a clean-up template shows the date it was added.

To add this information to TemplateData, simply add the autovalue to the parameter's information:



Flere parametre
Hvis der findes flere parametre, så opret blot tilsvarende afsnit for de andre parametre. Bemærk at når en skabelon har flere parametre, så er det nødvendigt at adskille dem med komma på denne måde:



Næsten identiske parametre
Når en skabelon har flere parametre, kan nogle af dem undertiden være af samme slags. I det tilfælde er det kun nødvendigt at angive fuld information for den første parameter, de andre kan "arve" deres information fra den første ved hjælp af ordet "inherits".



Tom tekstskabelon
Man kan kopiere den tomme tekstskabelon nedenfor for at føje ny TemplateData til en skabelon. Kun de mest almindelige tags (mærker) er medtaget.



Begrænsninger og spørgsmål

 * Manglende funktioner — TemplateData er et eksempel på et værktøj som er gjort tilgængeligt med kun få funktioner i det håb, at brugerne ville hjælpe med ideer til nye, ønskede funktioner. Hvis man efterspørger nye funktioner for TemplateData, så kontakt os venligst.
 * Forsinkelse i visning — Efter at have tilføjet TemplateData til en skabelon, så skulle metadata blive synlige med det samme, når skabelonen åbnes i VisualEditor. Dog kan det ske, at det tager timer, inden metadata vises. Man kan fremtvinge en opdatering ved at lave en "nul-redigering" af skabelonen (ikke dokumentationssiden). For at udføre en nul-redigering, så åbn skabelonen for redigering og gem straks siden igen uden at foretage nogen ændinger.
 * Nuværende problemer — En liste over øjeblikkelige fejl og ønskede funktioner er tilgængelig hos bugzilla.



Other tools

 * TemplateDataEditor — Et personligt JavaScript, der gør det nemmere at tilføje TemplateData. Det findes i øjeblikket på fransk (indeholder engelsk, italiensk, japansk og koreansk oversættelse), og kan nemt oversættes til andre sprog.
 * TemplateData Wizard — Et værktøj der danner TemplateData ved hjælp af en interaktiv brugerflade.
 * Skeleton TemplateData generator — Et værktøj der læser kildekoden for en skabelon og dernæst forsøger at finde alle parametre for at danne et dokument, hvor alle parametre er oplistet.
 * JSONLint — Et værktøj der muliggør en validering af et manuelt skrevet JSON med hensyn til syntaks-fejl.