Help:TemplateData/nl

 is een extensie voor het opslaan van informatie en parameters geassocieerd met een wikitext sjabloon, het maakt het beschikbaar voor het bewerken met een nterface die het kan tonen in een sjablooneditor -- dat helpt gebruikers bij het toevoegen en bewerken van sjablonen op pagina's.

In april 2019 is de TemplateData functionaliteit deel van de standaard gebruikerservaring voor alle gebruikers op alle Wikimedia wiki's bij het toevoegen van een sjabloon, ook voor anonieme gebruikers. Zowel de standaard source als de visual editor gebruiken het, net zoals veel script, hulpmiddelen en gadgets. Als u deze functionaliteit op uw eigen wiki wilt gebruiken, installeer dan.

Het toevoegen van TemplateData aan een sjabloon om deze extensie te gebruiken heeft het toevoegen van een klein stukje eenvoudige code  JSON nodig (hieronder uitgelegd) in de documentatiepagina van het sjabloon. U kunt dit handmatig doen of met de TemplateData editor, een grafische gebruikersinterface die u kunt benaderen via de pagina's ""/"" van het sjabloon op wiki's waar de extensie TemplateData is geïnstalleerd. Het JSON bevat een lijst met de parameters van het sjabloon en informatie over die parameters en het template zelf (details hieronder).

Als een gebruiker een sjabloon toevoegt op een pagina dan zal een sjabloon dat TemplateData bevat zal deze informatie tonen in de gebruikersinterface. Soms zal het het gedrag van de editor zich aanpassen wanneer u het gebruikt voor het bewerken of het invoegen van het sjabloon. Het maakt het gemakkelijker voor gebruikers om de stappen uit te voeren die nodig zijn voor het toevoegen van een bepaald sjabloon.

Geschiedenis
TemplateData is oorspronkelijk in 2013 ontwikkeld voor, dat was in die tijd in MediaWiki is de testfase. VisualEditor is de belangrijkste visuele interface voor bewerkingen in Wikimedia wiki's, door TemplateData is de interface krachtiger bij het toevoegen van sjablonen. Het is direct officieel door VisualEditor ondersteund. Bij de uitrol van VisualEditor in verschillende grote Wikimedia wiki's als standaardfunctie in de periode 2013 - 2016, maakte TemplateData daar deel van uit.

In december 2016 is de VisualEditor interface beschikbaar gemaakt voor het bewerken van source als een betafunctie. Dit was een voorwaarde bij de. Dit bracht voor het eerst de functies van TemplateData naar het bewerken van de bron.

In maart 2018 heeft Sam Wilson ontwikkelt, een GUI sjablooneditor extensie voor de standaard Wikimedia source editor,  (ook bekend als de 2010 wikitext editor), ontworpen voor het vereenvoudigen van het toevoegen van sjablonen door gebruik te maken van informatie uit TemplateData. In april 2019 is TemplateWizard een standaardonderdeel van de 2010 wikitext editor gemaakt op alle Wikimedia wiki's. Dit betekent dat TemplateData toen een standaardonderdeel is van zowel de visual editor als de source editor op Wikimedia wiki's.



TemplateData toevoegen en bewerken
Om TemplateData toe te voegen of te wijzigen, ga eerst naar een sjabloonpagina, dus iets met "/Template:Templatename".



De huidige status controleren
Kijk eerst of het sjabloon een subpagina documentatie heeft. Controleer dan of het sjabloon al TemplateData bevat en of dat dan op de sjabloonpagina staat of op de subpagina documentatie.



Documentatie subpagina's
Er zijn twee manieren waarop sjablonen op de meeste Wikimedia wiki's hun gebruiksaanwijzingen en andere informatie opslaan die niet toegevoegd moeten het sjabloon zelf, zoals categorieën waar het sjabloon in zou moeten zitten:


 * De meeste sjablonen houden gebruiksaanwijzingen en andere gegevens die niet bij de sjabloonpagina zelf behoren op een subpagina documentatie: "/Template:Templatename/doc". Op dergelijke pagina's, transcludes het sjabloon {{}} alle /doc pagina inhoud op de sjabloonpagina, hierdoor is de broncode van het sjabloon veel duidelijker.
 * Bij sjablonen met documentatie subpagina's wordt de kop "Test Template Info-Icon - Version (2).svg Template documentation" gevolgd door links als [view], [edit], [history] en [purge].


 * Een paar sjabloonpagina's hebben die informatie op de sjabloon hoofdpagina staan. U kunt het op die pagina's vinden door te zoeken naar  tussen  tags.

De weergave kan per wiki verschillen. Een hoofdpagina van een sjabloon kan heel soms toch nog documentatie bevatten ook al heeft u al het voorgaande gecontroleerd. Een gebruiker kan een aangepaste pagina-kop /doc hebben toegevoegd tussen " " en " " en daarna inhoud na " " hebben toegevoegd.

U kunt ook kijken naar een opmerking onderaan de pagina, die ongeveer het volgende is: "The above documentation is transcluded from Template:Templatename/doc".



Sjablonen zonder documentatie subpagina's
Als het sjabloon geen documentatie subpagina heeft, maak die dan aan en verplaats de sjabloon documentatie daarheen (of met een placeholder). U kunt dan TemplateData toevoegen aan de subpagina documentatie.



Subpagina aanmaken en documentatie verplaatsen
Om de subpagina documentatie aan te maken, klik op ""/"" op de hoofdpagina van het sjabloon; zoek naar de tags tags en de inhoud (meestal onderaan).

Het is iets als dit:

U kunt ook zien dat het al TemplateData bevat. Als dat zo is, dan is het iets als dit:

Selecteer alles tussen " " en "" en verplaats het in uw klembord of sla het even ergens op. Verwijder " ", dan blijft over:

Sla de sjabloonpagina op.

Om nu de nieuwe subpagina aan te maken, ga naar de adresbalk van de browser en voeg /doc toe aan het einde van de URL. Druk op Enter, kies dan de optie om een nieuwe pagina aan te maken.

Als deze wiki een notificatie sjabloon {{}} heeft, voeg het dan toe bovenaan de nieuwe pagina. U kunt ook andere sjablonen willen toevoegen zoals een {{}} of{{}} link (indien door de wiki ondersteund). Meer informatie.

Voegt de tekst toe die u eerder had gekopieerd of opgeslagen in de vorige tekst (onder het notificatie sjabloon, indien van toepassing).

Zet eventuele categorieën tussen tags, dan behoren ze alleen tot de hoofdpagina van het sjabloon:

Veel wiki's hebben een sjabloon. Gebruik dit sjabloon als het waarschijnlijk is dat het sjabloon dat u bewerkt in een zandbak versie ("Template:Templatename/sandbox") aanwezig is, dit om te voorkomen de de categorieën worden toegekend aan de zandbak pagina:

Publiceer vervolgens de pagina.

U kunt nu TemplateData toevoegen of wijzigen op de documentatien subpagina met gebruik van de instructies hier beschreven.



TemplateData toevoegen of bewerken op de hoofdpagina van het sjabloon
Als u geen /doc pagina kunt aanmaken, dan kunt u TemplateData toevoegen of bewerken op de hoofdpagina van het sjabloon met deze instructies.

Als een sjabloon een documentatie subpagina heeft, controleer dan zowel de hoofdpagina als de documentatie subpagina op de aanwezigheid van TemplateData (de tag gevolgd door een array binnen accolades:  ).

De extensie TemplateData kan voor u deze controle ook doen. Klik op "" of "" op een van de pagina's. Als het sjabloon al TemplateData op een pagina bevat, dan ziet u een gele melding bovenaan de pagina met de tekst:



of

Als het sjabloon TemplateData heeft op de documentatie subpagina

Als het sjabloon TemplateData heeft op de documentatie subpagina heeft, dan is dat de te wijzigen pagina. U kunt dit doen door te klikken op de "[edit]" achter de kop " Template documentation" (of zoiets), of, als u al op de /doc pagina bent, door te klikken op "" of "" bovenaan. Volg de de aanwijzingen bij de Methoden op om TemplateData toe te voegen of te wijzigen.

Als het sjabloon TemplateData heeft op de hoofdpagina

Als het sjabloon TemplateData heeft op zijn hoofdpagina, dan heeft u weer twee opties:


 * U kunt het beide verplaatsen naar de documentatie subpagina. Dit heeft de voorkeur.


 * U kunt het ook bewerken op de hoofdpagina van het sjabloon.

TemplateData verplaatsen naar de documentatie subpagina

Om dit te doen, klik op ""/"" op de hoofdpagina van het sjabloon, en kijk naar de tags, die staan tussen tags. Het is iets als dit:

Haal alleen de tags en die inhoud uit de code, sla daarna de pagina op.

Wijzig daarna de documentatie subpagina door te klikken op de "[bewerk]" die staat na de kop " Sjabloon documentatie" (of iets in die richting).

Tik een kop in, bijvoorbeeld "TemplateData", en plak daaronder de TemplateData.

U kunt nu de TemplateData bewerken, gebaseerd op deze richtlijnen.

TemplateData bewerken op de hoofdpagina van het sjabloon

Als u de TemplateData niet wil verplaatsen naar de /doc pagina, dan kunt u het wijzigen op de hoofdpagina van het sjabloon. Lees hier hoe u de TemplateData kunt bewerken.

Als het sjabloon geen TemplateData heeft maar een doc subpagina

Als het sjabloon nog geen TemplateData heeft, voeg het dan toe aan de subpagina documentatie.

U kunt dit doen door te klikken op de "[edit]" achter de kop " Template documentation" (of zoiets), of, als u al op de /doc pagina bent, door te klikken op "" of "" bovenaan. Tik een kop in, bijvoorbeeld "TemplateData", en voeg dat toe onder de kop. Lees hier hoe u de TemplateData kunt toevoegen.

Methoden


TemplateData bewerkingsmethode
Dit is een eenvoudige manier om TemplateData toe te voegen of te bewerken, aanbevolen voor minder ervaren gebruikers.

De TemplateData editor is een grafische gebruikersinterface voor het toevoegen en bewerken van TemplateData. Het is een onderdeel van de extensie TemplateData, beschikbaar op elke sjabloonpagina (of documentatie subpagina) door te klikken op "" of "".

Na dat klikken, ziet u een knop boven het bewerkingsveld en een paginatitel "".

|453px

Door op de knop te klikken gaat u naar de TemplateData Editor. Als de pagina al TemplateData bevat, dan wordt dat hier getoond.

600px|Het hulpmiddel op een pagina zonder TemplateData.

Functies in het bovenstaand venster:


 * Het bovenste item dient voor het kiezen van de taal van de interface. Het staat toe om tekst in te voeren in meerdere talen, aan gebruikers getoond op grond van die instelling van die gebruiker bij de voorkeuren. Dus niet op basis van de taal van de wiki; andere wiki's hebben eigen sjablonen en de sjablonen verschillen dus per wiki. Als er TemplateData in die taal is, dan geeft de interface de taal van de wiki, maar gebruikers kunnen dan door te klikken op  "" om meer invoer toe te voegen. De taalcode wordt tussen haakjes getoond naast de parameters waarbij het kan worden toegepast, zoals beschrijvingen en labels.
 * Het volgende item is de beschrijving van het sjabloon. Het wordt op meerdere plaatsen aan aan de gebruikers die een artikel schrijven getoond als ze het sjabloon via de sjablooneditor toevoegen in hun artikel. Deze parameter en het effect zijn hier omlijnd.
 * Het derde item zorgt voor de opmaak van de wikitekst van het sjabloon. De parameter bepaalt hoe de wikitekst wordt geplaatst als de gebruiker klikt op "", de twee belangrijkste types zijn  (op een regel) en   (op nieuwe regels). Deze parameter en het effect is hier omlijnd.
 * Als de gebruiker "" kiest, dan kan de gebruiker wikitext invoeren onder "" volgens de regels hier omlijnd, om de aangepast lay-out aan te maken voor het sjabloon als de gebruiker op "" klikt.


 * Het vierde item stelt de parameters van het sjabloon in. Als die al in de TemplateData zijn gedefinieerd dan worden ze hier in een lijst getoond. Als het sjabloon een parameter heeft die niet in de TemplateData is beschreven, dan kunt u een knop "" zien. De editor haalt deze suggesties uit de code van het sjabloon door te kijken naar   en  . Door te klikken op "" worden deze parameters toegevoegd met de namen zoals ze in het sjabloon zijn. Er wordt bovenin een groene melding getoond, bijvoorbeeld, "".
 * Onderaan het scherm staat de knop "". Hiermee kunt u handmatig een parameter toevoegen.

Ga verder met de volgende stap door te klikken op een van de parameters in de lijst. U kunt dan de informatie van de parameter aanpassen.

600px

Al deze functies en hun gevolgen zijn hier beschreven.

Indien klaar, klik op "". Hierdoor wordt automatisch de TemplateData onderaan de pagina toegevoegd voor de tag. Als er al TemplateData was dan wordt die informatie bijgewerkt (op die positie). De TemplateData tekst wordt ook geselecteerd door het klikken op "".

De TemplateData editor maakt een  parameter aan onderaan de TemplateData (of wijzigt die als die er al is). bevat de huidige TemplateData parameters in de volgorde waarin ze getoond worden in de TemplateData editor. U kunt de  wijzigen door de parameters naar boven of onder te slepen in de TemplateData editor met gebruik van de drie streepjes aan de linkerkant. en het effect zijn hier beschreven.

Klik daarna op "" om uw revisie van de pagina op te slaan.



Handmatige methode
U kunt de TemplateData ook handmatig toevoegen of bewerken. TemplateData is geschreven in JSON, maar om TemplateData aan te maken, heeft u geen kennis nodig van JSON. TemplateData volgt een paar erg eenvoudige regels en accepteert maar een paar dozijn mogelijke voorgedefinieerde parameters en waarden, volgens een  formaat.

Handmatig TemplateData toevoegen

Overwegingen:


 * Als u TemplateData toevoegt op een sjabloon documentatie subpagina (aanbevolen), dan kunt het overal op de pagina toevoegen; controleer of uw wiki een voorkeur heeft voor de locatie. In bijvoorbeeld de Engelse Wikipedia staat TemplateData meestal vrij onderaan in de documentatie pagina; in de Duitse Wikipedia staat het juist bovenaan.
 * If you're adding TemplateData on a template's main page (not recommended; see #Prior checks), you must make sure to place it inside the  tags.

Click "" or "" on the respective page, then move to the place in the page where you intend to add TemplateData and write a heading: "TemplateData".

Many wikis have a TemplateData header template that adds a short notice regarding TemplateData. If your wiki does, add it after the heading.

To start adding TemplateData, type an opening and closing tag and a pair of curly brackets on new lines, with an empty line between them:

Next, add an indent on the empty line between the two curly brackets, and start adding parameters. Details for the parameters can be found at #TemplateData parameters. Most are optional; some are highly recommended.

Parameters can be in any order, but what follows is the order that best conforms to TemplateData documentation and makes the content easiest to use for editors:

Make sure the parameters, for example, in the  object, remain inside that object; otherwise you will trigger an "" error when you try to save.

Voorbeeld

Een voorbeeld met TemplateData voor een hypothetische cleanup sjabloon. Een dergelijk sjabloon zou een melding moeten tomen en in een categorie moeten zetten op basis van het ingevulde maand en jaar. The notice might also contain a link to a talk page section. The TemplateData would look something like this:

The corresponding TemplateData documentation would display as follows:

{	"description": "Use this template to indicate that an article is in need of cleanup.", "format": "inline", "params": { "datum": { "label": "Maand en jaar", "description": "De maand en jaar waarop het sjabloon is toegevoegd", "type": "string", "autovalue": " ", "example": "Januari 2013", "suggested": true },		"reden": { "aliases": ["1"], "label": "Reden", "description": "De reden is dat het artikel opgeschoond moet worden", "type": "string" },		"overleg": { "aliases": ["overleg sectie"], "label": "Overlegpagina sectie", "description": "De sectie van de overlegpagina met de relevante discussie", "type": "string" }	},	"paramOrder": [ "datum", "reden", "overleg" ] }

TemplateData parameters
Alle beschikbare TemplateData parameters worden hieronder genoemd met een beschrijving en een voorbeeld. Er is ook een wat technischer beschrijving.



Binnen parameters


Binnen de naam van een parameter
Note: if neither,   nor   are set as   for a parameter, its status will show as   in the TemplateData documentation.

Once you're done, hit "". If you've made errors, it will not let you save (which is disruptive but means you can't break anything). Should you run into errors, explain on the feedback page what you were trying to do, and we will be happy to help.

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

Note that each item of information is enclosed in quotation marks (except for  and  ) and separated from the next item by a comma (unless it's the last one).

Type parameter
The  parameter is meant to signal to a template editor the nature of a parameter's value. In some cases, template editors have been programmed to modify the user interface for a certain parameter according to this TemplateData value, such as to only allow the user to enter valid values that match the specified type. This parameter does not have any functional effect on the template parameter or its value; it merely controls how template editors see and treat the parameter in editing mode.

Hoe te gebruiken

It is used by adding the  parameter, followed by a colon and a space, then adding any of the values listed in the table below in quotation marks.

Voorbeeld:

Effecten

As of February 2020, only 5 of the 13 type values have visible effects in VisualEditor and the 2017 wikitext editor, while 8 have visible effects in TemplateWizard.

The effects of certain values are likely to change as the template editors get updates to support them. One such effort for VisualEditor and the 2017 wikitext editor is tracked in the Phabricator task T55613. A similar effort to get TemplateWizard to support the boolean value is tracked in T200664.

The currently known effects are listed as follows.

Custom formats
When editing the  value, you create custom formats by inputting a set of wikitext symbols using some predefined rules.


 * - start of the template
 * - content (e.g., string, integer or parameter). This underscore serves to indicate the minimum length of a value in characters and can be repeated, like . If this length is not reached, it fills the remaining characters with spaces. This can be used to align all equals signs to a specific position after a parameter (if used with   for new lines).
 * - pipe (separates parameters)
 * - equals sign (precedes the value of a parameter)
 * or pressing the enter key - new line (this will display as  in the entry field)
 * - space (can be used with  to indent new lines)
 * - end of the template

The wikitext should at least meet the minimum of, otherwise there will be an invalid format string error.

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

Fouten


/ Slecht JSON formaat
These errors occur when saving TemplateData, usually manually edited, with invalid JSON code (duplicate keys/parameters, trailing or missing commas, etc.) in VisualEditor or the 2017 wikitext editor.

"" appears in VisualEditor and the 2017 wikitext editor; "Bad JSON format" appears when editing in the TemplateData GUI editor.

These errors can be difficult to detect and come in too many forms to list. The best way to avoid them is to edit template data exclusively with the TemplateData editor; the best way to detect them once they've occurred is to use an external JSON validator, such as JSONLint, which will highlight errors and aid in fixing them.

The 2010 wikitext editor does not check for invalid JSON thanks to an old, unfixed bug. Pages that contain invalid JSON may throw alarming "" messages. To fix these errors, your best bet is to use a JSON validator (see above).

Required property "paramOrder(number)" not found.
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that is missing. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

Invalid value for property "paramOrder(number)".
This error occurs if you state a parameter in  that is not stated in. The number in the square brackets refers to the parameter in  that shouldn't be there. It refers to its order in the sequence, but it is one less than its actual position, since  is an array; 0 is the first one, 1 is the second, etc.

To fix this, make sure all parameters stated in  are listed in. Alternatively, you can remove the  object to remove this error.

Property "params.parametername.required" is expected to be of type "boolean".
This error occurs if you put quotation marks around the value of either  or.

These are boolean values, not strings, therefore they require no quotation marks. To fix this, remove any quotation marks around the values  or   for these parameters.

Property "format" is expected to be ...
If the  parameter exists but its value is not ,   or a valid format string, you will see the error message "".

To fix this, make sure the value after  equals   or   and that there no spelling mistakes. Alternatively, if it's wikitext, make sure it contains a minimum of  and that there are no mistakes in the syntax that would normally cause a template to fail, such as duplicate equals signs or missing/duplicate curly brackets; see the section #Custom formats for the syntax for custom formats. Alternatively, you can remove the  parameter to remove this error.

Unexpected property "parametername".
This error occurs if you state a parameter that does not exist in TemplateData. This is probably due to spelling mistakes.

It also occurs if you state a parameter in any TemplateData object that is not a parameter of that object. This may be due to spelling mistakes, or you may have written the parameter of one TemplateData object under another object that it doesn't belong to.

For example, you might have written the parameter  under the root TemplateData object instead of inside  :

Alternatively, if the unexpected parameter is under a template parameter inside, you'll see its name after "params.parametername." in the error.

To fix this, make sure there aren't any spelling mistakes in the parameter names, and make sure your parameters are in their correct location. Additionally, make sure you don't state any parameters that don't exist for a TemplateData object. You can check which parameters exist for an object in the section #TemplateData parameters.

Required property "params" not found.
This error occurs if there is no  object in the TemplateData. This is a necessary object, as it contains all the details of each parameter, so to fix this error, make sure it's added and that there are no spelling mistakes. See the section above on how to add the  parameter.



Beperkingen en feedback

 *  Missing features  – TemplateData is an example of a 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 the visual editor. However, it is possible that it will take several hours before the metadata will 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 and without adding any edit summary.
 *  Current issues  – A list of current bugs and feature requests is available in the Wikimedia bug tracker.



Andere hulpmiddelen

 * : A toolbar dialog window for entering template wikitext via an form built from TemplateData.
 * 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.
 * [ List of all templates with TemplateData] on this wiki
 * With dewiki template TemplateData template data is shown in a box, and the template is added to a category of templates with template data
 * https://query.wikidata.org/ and Query Helper