Help:TemplateData/it

 è un'estensione che memorizza le informazioni e i parametri associati a un wikitext template e li rende disponibili a un'interfaccia di editing che può recuperarli e presentarli in un editor di template, il che aiuta gli utenti ad aggiungere e modificare i template nelle pagine.

A partire da aprile 2019, la funzionalità TemplateData è parte dell'esperienza utente predefinita per tutti gli utenti di tutti i wiki Wikimedia quando aggiungono un modello, inclusi gli utenti non registrati. Sia l'editor predefinito dei sorgenti che quello visuale lo incorporano in qualche modo, così come molti script, strumenti e gadget. Se si desidera questa funzionalità sul proprio wiki, installare.

L'aggiunta di TemplateData a un template per l'uso di questa estensione comporta l'inserimento di un piccolo e semplice blocco di JSON (spiegato di seguito) nella pagina di documentazione del template. È possibile farlo manualmente o con l'editor TemplateData, un'interfaccia grafica a cui si può accedere nelle pagine ""/"" di un template sui wiki con l'estensione TemplateData installata. Il JSON contiene un elenco dei parametri del template e informazioni su tali parametri e sul template nel suo complesso (vedere sotto per i dettagli).

I template che contengono TemplateData visualizzeranno queste informazioni nell'interfaccia utente quando un utente aggiunge il template. In alcuni casi, cambierà il comportamento dell'editor quando si utilizza per modificare o inserire un determinato template, rendendo molto più semplice per gli utenti eseguire i passaggi necessari per aggiungere un determinato template.

Cronologia
TemplateData è stato originariamente sviluppato all'inizio del 2013 pensando a, che all'epoca era in fase di test su MediaWiki. VisualEditor è la principale interfaccia di editing visuale per i wiki Wikimedia e TemplateData le ha permesso di avere un'interfaccia più utile per l'aggiunta di template. È stato ufficialmente supportato da VisualEditor immediatamente. Dal 2013 al 2016 VisualEditor è stato introdotto come funzione predefinita nei principali wiki di Wikimedia e anche TemplateData ne ha fatto parte.

Nel dicembre 2016, l'interfaccia VisualEditor è stata resa disponibile per la modifica del codice sorgente come funzionalità beta. This was termed the. Questo ha portato per la prima volta le caratteristiche di TemplateData nell'editing dei sorgenti.

Nel marzo 2018, Sam Wilson ha sviluppato, un'estensione dell'editor di template con interfaccia grafica per l'editor di sorgenti predefinito di Wikimedia, (altrimenti noto come l'editor wikitext del 2010), progettato per rendere più semplice il processo di aggiunta dei template utilizzando le informazioni di TemplateData. Nel aprile 2019, TemplateWizard è stato reso una parte predefinita dell'editor wikitext 2010 su tutte le wiki Wikimedia. Ciò significava che TemplateData era ora una parte predefinita sia dell'editor visuale che dell'editor dei sorgenti sui wiki Wikimedia.



Aggiungere o modificare TemplateData
Per aggiungere o modificare i TemplateData, occorre innanzitutto navigare nella pagina di un template, che si trova in "/Template:Templatename".



Controllo dello stato attuale
Prima di aggiungere o modificare TemplateData, verificare se il template ha una sottopagina di documentazione. Quindi verificare se il template contiene già TemplateData e, in caso affermativo, se si trova nella pagina del template o nella sottopagina della documentazione.



Documentazione delle sottopagine
Ci sono due modi principali in cui i template nella maggior parte dei wiki Wikimedia memorizzano le loro note d'uso e altri dati che non dovrebbero essere inclusi nel template stesso, come le categorie in cui il template dovrebbe essere contenuto:


 * La stragrande maggioranza dei template conserva le note d'uso e altri dati che non appartengono alla pagina del template stesso in una sottopagina di documentazione: "/Template:Templatename/doc". In pagine come questa, il template {{}} transclude tutto il contenuto della pagina /doc nella pagina del template, mantenendo il codice sorgente del template più pulito.
 * Nei template con sottopagine di documentazione, l'intestazione "Test Template Info-Icon - Version (2).svg Documentazione del template" sarà seguita da collegamenti come [visualizza], [modifica], [cronologia] e [cancella].


 * Alcune pagine di template hanno mantenuto queste informazioni nella pagina principale del template. È possibile individuarlo in queste pagine cercando un'occorrenza di  tra i tag.

Wiki differenti possono presentare tutto questo in modo diverso. Raramente, le pagine dei template principali possono ancora contenere documentazione anche dopo aver controllato tutti i punti precedenti; in questo caso, un utente avrà aggiunto un titolo di pagina /doc personalizzato tra " " e " " e poi avrà aggiunto il contenuto dopo " ".

Si può anche cercare un avviso in fondo alla pagina simile a questo: "La documentazione di cui sopra è transclusa da Template:Templatename/doc".



Template senza documentazione di sottopagine
Se un template non ha una sottopagina di documentazione, crearla e spostare lì la documentazione del modello (o un segnaposto per essa). Quindi è possibile aggiungere TemplateData alla sottopagina della documentazione.



Creazione di sottopagine e spostamento della documentazione
Per creare la sottopagina della documentazione, fare clic su ""/"" nella pagina principale del template; cercare i tag e il loro contenuto (di solito in fondo).

Il risultato finale dovrebbe apparire più o meno così:

È possibile che contenga già TemplateData. In tal caso, il risultato finale apparirà più o meno così:

Selezionare tutto ciò che si trova dopo " " e prima di "" e copiarlo negli appunti o salvarlo in un documento temporaneo. Eliminare " ", lasciando solo quanto segue:

Salvare la pagina template.

Ora, per creare la nuova sottopagina, guardare la barra degli indirizzi del vostro browser e aggiungete /doc alla fine della URL. Premere Enter, quindi scegliere l'opzione per creare una nuova pagina.

Se questo wiki ha un template di avviso di {{}}, aggiungerlo all'inizio della nuova pagina. Si possono anche aggiungere altri template, come {{}} oppure {{}} (se supportato dal wiki in questione). Vedere m:Help:Template documentation per ulteriori informazioni.

Inserire il testo tagliato o salvato nel testo precedente (sotto il template di avviso, se applicabile).

Racchiudere le categorie nel tag in modo che si applichino solo alla pagina principale del template:

Molti wiki hanno un template. Utilizzare questo template se è probabile che quello che si sta modificando esiste in una versione sandbox (che si trova in "Template:Templatename/sandbox"), per evitare che le categorie si applichino alla pagina sandbox:

Infine, pubblicare la pagina.

È ora possibile aggiungere e modificare i TemplateData nella sottopagina della documentazione, utilizzando le istruzioni descritte in #Metodi.



Aggiungere e modificare TemplateData sulla pagina del template principale
Se non si riesce a creare la pagina /doc, si possono aggiungere e modificare i TemplateData nella pagina principale del template, seguendo le istruzioni in #Metodi.

Se un template ha una sottopagina di documentazione, controllare sia la pagina principale che la sottopagina di documentazione per la presenza di TemplateData (il tag seguito da un array tra parentesi graffe:  ).

In alternativa, l'estensione TemplateData può anche eseguire questo controllo. Fare clic su "" oppure "" in entrambe le pagine. Se il template ha già TemplateData in una delle due pagine, verrà visualizzato un avviso giallo nella parte superiore della pagina con la dicitura:



oppure

Il template ha TemplateData nella sua sottopagina di documentazione

Se il template ha TemplateData nella sua sottopagina di documentazione, questa è la pagina da modificare. È possibile farlo facendo clic sul pulsante "[modifica]" posto dopo l'intestazione " Template documentation" (o simile), oppure, se si è già nella pagina /doc, fare clic su "" o "" in alto. Seguire la guida in #Metodi per aggiungere o modificare i TemplateData.

Il template ha TemplateData nella sua pagina principale

Se il template ha TemplateData nella sua pagina principale, si hanno ancora una volta due opzioni:


 * È possibile spostarsi nella relativa sottopagina della documentazione. Questa è l'opzione preferita.


 * Oppure si può modificare nella pagina principale del modello.

Spostare TemplateData alla sottopagina di documentazione

Per farlo, fare clic su ""/"" nella pagina principale del template e cercare i tag, racchiusi all'interno dei tag. Il risultato finale dovrebbe apparire più o meno così:

Tagliare dal codice solo i tag e il loro contenuto, quindi salvare la pagina.

Quindi, modificare la sottopagina della documentazione facendo clic sul pulsante "[modifica]" situato dopo l'intestazione " Template documentation" (o simile).

Digitare un titolo, ad esempio "TemplateData", quindi incollare il TemplateData sotto di esso.

È ora possibile modificare il TemplateData in base alle indicazioni contenute in #Metodi.

Modificare TemplateData nella pagina principale del template 

Se non si desidera spostare i TemplateData nella pagina /doc, è possibile modificarli nella pagina principale del template. Vedere #Methods per sapere come modificare TemplateData.

Se il modello non ha ancora TemplateData ma ha una sottopagina doc.

Se il template non ha ancora TemplateData, è necessario aggiungerlo alla sottopagina della documentazione.

Per farlo, cliccare sul pulsante "[edit]" posto dopo il titolo " Template documentation" (o simile), oppure, se si è già nella pagina /doc, cliccare su "" o "" in alto. Digitare un'intestazione, ad esempio "TemplateData", quindi aggiungerla sotto l'intestazione. La sezione #Metodi spiega come aggiungere TemplateData.

Metodi


Metodo per la modifica del TemplateData
Questo è un modo semplice per aggiungere o modificare TemplateData, consigliato agli utenti meno esperti.

L'editor di TemplateData è un'interfaccia grafica utente per aggiungere e modificare TemplateData. Fa parte dell'estensione TemplateData, disponibile nella pagina di qualsiasi modello (o nella sottopagina della documentazione) facendo clic su "" o "".

Dopo aver fatto clic su "" o "", si vedrà un pulsante sopra l'area di modifica e il titolo della pagina che dice "".

|453px

Facendo clic su questo pulsante si accede al TemplateData Editor. Se la pagina in cui ci si trova contiene già TemplateData, questa apparirà automaticamente qui.

600px|Lo strumento di edit TemplateData, in una pagina che ancora non contiene TemplateData.

Caratteristiche nella finestra precedente:


 * Il primo elemento seleziona la lingua del testo dell'interfaccia. Consente di inserire contenuti testuali in più lingue, visualizzati agli utenti in base alle loro impostazioni nelle Preferenze, non in base alla lingua del wiki; wiki diversi hanno database di template completamente diversi. Se non esiste un TemplateData in tale lingua, l'interfaccia offrirà agli utenti solo la lingua del wiki, ma gli utenti possono fare clic su "" per aggiungere altri input. Il codice della lingua viene visualizzato tra parentesi accanto ai parametri a cui può essere applicato, come le descrizioni e le etichette.
 * L'elemento successivo è la descrizione del template. Descrive il template nella sua interezza; viene mostrata agli utenti in numerosi punti dell'editor di template durante l'aggiunta di un template. Questo parametro e i suoi effetti sono descritti qui.
 * Il terzo elemento voce controlla la formattazione del wikitesto del template. Questo parametro determina la disposizione del wikitesto quando l'utente fa clic su ""; i due tipi principali sono  (su una riga) e   (su nuove righe). Questo parametro e i suoi effetti sono descritti qui.
 * Se l'utente sceglie "", può inserire il wikitesto sotto "" secondo le regole descritte qui, in modo da creare un layout personalizzato per il template quando l'utente clicca su "".


 * Il quarto elemento configura i parametri di un modello. Se i parametri sono già stati definiti in TemplateData, quest'area li visualizza in un elenco. Se il codice sorgente del modello specifica parametri per i quali non esiste TemplateData, si può vedere un pulsante con l'etichetta "". L'editor estrae questi suggerimenti dal codice sorgente del template cercando  o  . Facendo clic su "" si aggiungono questi parametri utilizzando i loro nomi come definiti nel codice sorgente. Apparirà anche un avviso verde in alto, ad esempio "".
 * In fondo alla finestra è presente il pulsante "". Questo consente di aggiungere manualmente un parametro con un nome personalizzato.

Continuare al passo successivo facendo clic su uno qualsiasi dei parametri dell'elenco. In questo modo si potranno modificare le informazioni di quel parametro.

600px

Tutte queste caratteristiche e i loro effetti sono descritti nella sezione #Within a parameter's name.

Al termine, fare clic su "". Questo inserirà automaticamente il TemplateData in fondo alla pagina, prima del tag ; oppure, se già presente, verrà aggiornato con le nuove informazioni senza cambiare la sua posizione. Anche il testo di TemplateData verrà selezionato quando si fa clic su "".

L'editor TemplateData crea un parametro  in fondo al TemplateData (o lo aggiorna se esiste già). contiene i parametri correnti di TemplateData nell'ordine in cui sono stati visualizzati dall'editor di TemplateData. È possibile modificare il  trascinando i parametri verso l'alto e verso il basso nell'editor TemplateData utilizzando le tre barre orizzontali a sinistra. e i suoi effetti sono descritti qui.

Dopo di che, fare clic su "" per salvare la revisione della pagina.



Metodo manuale
È possibile aggiungere o modificare TemplateData anche manualmente. TemplateData è scritto in JSON, ma non è necessario imparare JSON per imparare a creare TemplateData. TemplateData segue alcune regole molto semplici e accetta solo poche decine di possibili parametri e valori predefiniti, tipicamente seguendo un formato.

Aggiungere TemplateData manualmente

Considerazioni:


 * Se si aggiungono i TemplateData nella sottopagina della documentazione di un template (consigliato), è possibile aggiungerli in qualsiasi punto della pagina; verificare se la Wikipedia della propria lingua ha una posizione preferita. Per esempio, nella Wikipedia inglese, TemplateData è tipicamente nella parte inferiore della pagina di documentazione; nella Wikipedia tedesca, è tipicamente in cima.
 * 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.

Esempio

Here is some example TemplateData for a hypothetical cleanup template. Such a template would display a notice and place the page into a dated category based on the month and year entered. 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": { "date": { "label": "Month and year", "description": "The month and year that the template was added", "type": "string", "autovalue": " ", "example": "January 2013", "suggested": true },		"reason": { "aliases": ["1"], "label": "Reason", "description": "The reason the article is in need of cleanup", "type": "string" },		"talk": { "aliases": ["talksection"], "label": "Talk page section", "description": "The section of the talk page containing relevant discussion", "type": "string" }	},	"paramOrder": [ "date", "reason", "talk" ] }



Descrizione e parametri
All available TemplateData parameters are listed below with a description and example. They are also listed in more technical detail at Extension:TemplateData#Format.

Within a parameter's name
Note: if neither,   nor   are set as   for a parameter, its status will show as   in the TemplateData documentation.

Una volta terminato, premere "". Se hai commesso errori, non ti consente di salvare (che disturba, ma significa che non puoi fare nulla). In caso di errori, spiega sulla feedback page cosa stavi cercando di fare e saremo felici di aiutarti.

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

Si noti che ogni elemento di informazione è racchiusa tra virgolette (eccetto  e  ) e separato dall'elemento successivo da una virgola (a meno che non sia l'ultima).

Type parameter
Il parametro  serve a segnalare all'editor di template la natura del valore di un parametro. 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.

How to use

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.

Example:

Effects

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.

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

/ Bad JSON format
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.



Limitazioni e domande

 * Le funzionalità che mancano – TemplateData è un esempio di uno strumento reso disponibile con poche funzionalità, nella speranza che possa aiutare a guidare gli utenti nello sviluppo delle funzionalità che si desiderano. Se desideri richiedere nuove funzionalità per TemplateData, per favore faccelo sapere.
 * Ritardi nella visualizzazione dei template – Dopo aver aggiunto TemplateData a un template, i metadati dovrebbero essere immediatamente visibili quando il template viene aperto nell'editor visivo. Tuttavia, è possibile che siano necessarie diverse ore prima che i metadati vengano visualizzati. È possibile forzare un aggiornamento apportando una modifica nulla alla pagina del template (non alla sottopagina della documentazione). Per eseguire una modifica nulla, apri la pagina del template per la modifica e salva la pagina "senza apportare modifiche e senza aggiungere alcun riepilogo di modifica".
 * Segnalazioni aperte – Un elenco di bug e richieste di funzionalità correnti è disponibile nel bug tracker di Wikimedia.

Other tools

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