Help:TemplateData/it



Cos'è TemplateData?
TemplateData è un metodo di immagazinare le informazioni di un template e dei suoi parametri in modo che VisualEditor possa richiamarli e mostrarli nell'editor del template, quindi rendendo più semplice la moifica dei template.

La sintassi TemplateData permette agli utenti di scrivere piccoli bit di dati strutturati in una pagina del namespace "Template", o essere riportati nella pagina del template (così come succede per le pagine di documentazione dei template). Una volta che un template ha dei dati strutturati, può essere mostrato correttamente in VisualEditor. Nonostante possa sembrare un processo complesso, è in realtà molto semplice.



Editor TemplateData
Esiste uno strumento integrato per modificare TemplateData in modo semplice.

Per usare l'editor TemplateData, vai alla pagina del template (o della sua sottopagina di documentazione) e premi il pulsante "Edit". Ciò, renderà visibile il pulsante "" subito sopra la casella di modifica appena aperta. Premi questo pulsante per entrare nello strumento di modifica TemplateData. L'editor ti permette di aggiungere una riga per ogni parametro del template e di impostare gli attributi più comuni. Se la pagina che hai modificato contiene già un blocco di TemplateData, le informazioni già contenute verranno automaticamente mostrate quando apri la pagina con l'editor TemplateData. Nel primo box puoi aggiungere o aggiornare una breve descrizione del template. Dopo ciò, puoi utilizzare "Importa parametri" e "Aggiungi parametri" per documentare i nomi e gli attributi dei parametri usati dal template.

Puoi elencare il nome del parametro, qualsiasi alias, l'etichetta e la descrizione che verranno mostrate all'utente. L'unico campo che è obbligatorio compilare è "Nome" (il primo di ogni riga), ovvero il campo dove registrare l'esatto nome del parametro (con le maiuscole corrette). Nel menù pop-up, puoi scegliere il tipo di contenuti che il parametro deve ricevere, ad esempio una stringa (per testi semplici), pagina (un wikilink ad una pagina) o date. Se il template produce un errore se il parametro viene lasciato vuoto, segnalalo come "Obbligatorio". Se il parametro è usato frequentemente o è raccomandato che venga usato, segnalalo com "Consigliato". Il pulsante "Rimuovi" cancellerà il parametro appena inserito dal TemplateData.

Quando hai terminato di inserire la documentazioni per ogni parametri, premi "Applica" per inserire i dati nella finestra di modifica. È necessario salvare la pagina, utilizzando il pulsante "Salva" sotto la finestra di modifica, per creare la tabella.

Attenzione: l'editor TemplateData inserirò TemplateData o nulla pagina del template o nella sottopagina di documentazione. Per determinare in quale pagina dovrebbe essere inserito, devi aprire (modificare) la pagina in cui vuoi che compaia TemplateData. Tuttavia, se vengono posti TemplateData molteplici in una stessa pagina, verrà utilizzato solo uno dei blocchi TemplateData. Se esiste già un TemplateData in una pagina, devi modificare la pagina in cui era già presente TemplateData, per evitare di creare accidentalmente blocchi TemplateData multipli.



Struttura di TemplateData
La struttura di TemplateData è basata sullo standard JSON ed è abbastanza semplice. Tutte le descrizioni in TemplateData devono essere in testo semplice (niente wikimarkup, niente link, ecc).

La prima cosa da fare è inserire un pagio di tag  in qualsiasi punto della sottopagina di documentazione del template, in questo modo:

Questo dice al software che qualsiasi cosa si trovi tra i due tag è TemplateData e dovrebbe essere mostrato quando viene utilizzato il template.



Esempio
La descrizione all'interno di TemplateData segue un'impostazione standard; poniamo, per esempio, che abbia un template chiamato "Commons" per collegare la categoria di Commons di un argomento. Serve un parametro necessariamente: il nome della categoria su Commons. Il TemplateData dovrebbe essere qualcosa di simile a questo:

Verrà mostrato, nel template, in questo modo: {       "description": "Un template per collegare la categoria di Commons di un articolo", "params": { "1": {                       "label": "Categoria di Commons", "description": "La categoria di Commons che vuoi collegare.", "default": "Category:CommonsRoot", "type": "string", "required": true }       } }



Descrizione e parametri
Once you're done, hit "save". 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 each bit of information is enclosed in quotation marks (except for  and  ), and separated from the next bit by a comma (unless it's the last one).



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:



Auto value
You can specify an "autovalue" for a parameter. When users add the template to a page, this value will be added automatically. For example, many clean-up templates need to have the date added; if you specify an autovalue for the template's date parameter, then the date will be filled in automatically.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use  to make the values stick:



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.



Other tools

 * 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.
 * List of all templates with TemplateData on this wiki