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
Una volta finito, premi "Salva". Se hai fatto qualche errore, non potrai salvare (cosa distruttiva, ma significa che non puoi "rompere" nulla). Se dovessi incorrere in errore, spiega nella feedback page cosa volevi fare, e saremo felici di aiutarti.

Ogni bit di informazioni è incluso due virgolette (fatta eccezione per  e  ) e separato dal successivo da una virgola (a meno che non sia l'ultimo).



Alias dei parametri
Alcuni template permettono di richiamare un parametro con nomi differenti.

Per esempio,  può anche essere scritto come   o.

Per aggiungere questa informazione a TemplateData, devi emplicemente aggiungere gli alias alle informazioni del parametro:



Valore automatico
Puoi specificare un "valore automatico" per un parametro. QUando un utente aggiunge il template alla pagina, questo valore viene aggiunto automaticamente. Per esempio, molti template di avviso devono avere una data di inserimento; se specifichi un valore automatico per il parametro "data di inserimento", la data verrà aggiunta automaticamente.

Per aggiungere questa informazione a TemplateData, devi emplicemente aggiungere il valore automatico alle informazioni del parametro: Dovrai, probabilmente, utilizzare  per rendere i valori fissi:



Parametri multipli
Se hai parametri multipli, ripeti ogni sezione (partendo dal tag "1") e compilali come devi. Fai attenzione, che se un template ha parametri multipli, devi separarli con una virgola in TemplateData, in questo modo:



Parametri simili
Quando un template ha parametri multipli, delle volte alcuni di essi possono essere dello stesso tipo. In questo caso, ti basta inserire tutte le proprietà per il primo e gli altri possono "ereditare" le loro proprietà da esso.



Codice vuoto
Puoi copiare il codice vuoto qui sotto per aggiungere un TemplateData a un template. Sono inclusi solo i tag più comuni.



Limitazioni e domande

 * Funzionalità mancanti — TemplateData è un buon esempio di strumento reso disponibile con poche funzioni, con la speranza che gli utenti avrebbero aiutato a guidare lo sviluppo di funzioni che desideravano. Se vuoi richiedere una nuova funzione per TemplateData, faccelo sapere.
 * Ritardo nella finestra di modifica — Dopo aver aggiunto TemplateData ad un template, i metadati dovrebbero essere visibili immediatamente quando il template viene aperto con VisualEditor. Tuttavia, è possibile che ci vogliano ore prima che vengano mostrati i metadati. Puoi forzare l'aggiornamento facendo un null edit nella pagina del template (non nella sottopagina di documentazione). Per fare un null edit, apri la pagina del template come se volessi modificarla e salva la pagina senza fare alcuna modifica.
 * Problemi noti — Una lista di problemi noti e funzioni richieste è disponibile in bugzilla.



Altri strumenti

 * TemplateDataEditor — Uno user script che rende il processo di aggiunta TemplateData più facile. Al momento esiste in francese (contiene traduzioni in inglese, italiano, giapponese e coreano) e può essere facilmente tradotto in altre lingue.
 * TemplateData Wizard — Uno strumento che genera TemplateData attraverso un'interfaccia interattiva.
 * Skeleton TemplateData generator — Uno strumento che legge il codice del template, cerca di trovare tutti i parametri richiesti e mostra una documentazione di tutti i parametri già pronta.
 * JSONLint — Uno strumento che permette di convalidare JSON scritto manualmente per aiutarti a trovare errori nella sintassi.
 * Lista di tutti i template con TemplateData in questa wiki