Help:TemplateData/it

 è un modo di organizzare le informazioni concernenti wikitext template e i suoi parametri, affinché l'editor visuale possa recuperarli e visualizzarli nel suo editor di template, facilitando la modifica di pagine che usano quel template. È anche usato altrove in script, strumenti e gadget.

L'estensione TemplateData è installata in tutte le wiki della WMF. Se Hai la tua wiki, allora devi installare Extension:TemplateData.

La sintassi di TemplateData consente agli utenti di scrivere piccole parti di testo strutturato in una pagina di template o di includerlo in tale pagina (esempio, la pagina di documentazione di un template). Una volta che in un template i dati sono strutturati, esso può essere correttamente visualizzato nell'editor visuale. Sebbene possa sembrare difficile, in realtà non è così.

Editor del TemplateData
C'è uno strumento integrato per modificare facilmente TemplateData.

Per usare l'editor di TemplateData, vai alla pagina del template (o alla sotto-pagina di documentazione) e premi "Edit". Comparirà il tasto "", proprio sopra la finestra di edit:

Clicca questo tasto per abilitare l'interfaccia GUI (Graphic User Interface) e modificare TemplateData.

L'editore permette di aggiungere parametri e stabilire gli attributi più comuni. Se la pagina che hai modificato già contiene un blocco di TemplateData, le informazioni già documentate verranno automaticamente visualizzate quando si apre la pagina corretta nell'editor TemplateData. Nel primo box(casella), puoi aggiungere o aggiornare una breve descrizione del modello in testo normale. Successivamente, è possibile utilizzare i pulsanti "Aggiungi parametri suggeriti" e "Aggiungi parametro" per documentare i nomi e gli attributi dei parametri utilizzati dal modello.

Se la pagina del modello è protetta, puoi copiare e incollare il codice del modello nella pagina secondaria, utilizzare il pulsante "Aggiungi parametri suggeriti", copiare il contenuto di TemplateData, modificare la sottopagina per eliminare il codice del modello e quindi incollare il contenuto di TemplateData. Per sapere dove incollare il contenuto di TemplateData all'interno della pagina secondaria, puoi modificare TemplateData senza aggiungere nulla; puoi quindi sostituire i tag e e il loro contenuto incollandovi sopra quelli corretti.

È possibile elencare il nome del parametro, eventuali alias per esso, l'etichetta e la descrizione che verrà visualizzata agli utenti. Puoi anche fornire un esempio su come utilizzare il parametro. L'unico campo obbligatorio è Name (il primo campo in ogni riga), che è dove si registra il nome esatto, case-sensitive (rispettando maiuscole e minuscole) del parametro. Nel menu a discesa "Type", puoi scegliere il tipo di contenuto che il parametro dovrebbe ricevere, come una stringa (per le risposte in testo semplice), la pagina (per i collegamenti ad altre pagine) o le date. Se il template produce un errore se questo parametro è lasciato vuoto, contrassegnarlo come "Required". Se il parametro è comunemente usato o consigliato, contrassegnarlo come "Suggested". Il pulsante "Remove parameter information" cancellerà la voce del parametro da TemplateData.



Quando hai finito di documentare ciascuno dei parametri, fai clic su "Apply" per inserire il TemplateData preformattato nella casella di modifica aperta. Devi comunque salvare la pagina, utilizzando il normale pulsante "Save" sotto la finestra di modifica.

Attenzione: L'editor TemplateData posizionerà TemplateData sulla pagina del template o su una sottopagina della documentazione. Determinare dove verrà aggiunto TemplateData aprendo (modificando) la pagina in cui si desidera posizionare TemplateData. Tuttavia, se più blocchi TemplateData sono posizionati sullo stesso template, verrà utilizzato solo uno di questi blocchi. Se esiste già TemplateData in una pagina, è necessario modificare la pagina in cui è stato precedentemente posizionato TemplateData per evitare la creazione accidentale di più blocchi.

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.

Ubicazione di TemplateData
TemplateData deve trovarsi nella pagina che descrive o essere incorporato in essa. In un template, in genere deve essere racchiuso tra i tag. Nel rendering di una pagina normale, visualizza la documentazione generata automaticamente come mostrato in #Example.

Struttura di TemplateData
La struttura di TemplateData è basata sullo standard JSON. Si noti che tutte le descrizioni in TemplateData devono essere in testo semplice (senza wikitext, senza collegamenti, ecc).

La prima cosa da fare è digitare un paio di tag, ovunque nella sottopagina della documentazione del template, in questo modo:

Questo dice al software che ogni cosa tra i due tag è TemplateData, e dovrebbe essere referenziata quando viene usato il template.

Esempio
Le descrizioni all'interno di TemplateData seguono un layout standard; supponiamo che tu abbia un template chiamato "Commons" per il collegamento a una categoria di Commons su un argomento. Ci vuole un parametro obbligatorio: il nome della categoria su Commons. Il TemplateData sarebbe simile a questo:

Questo lo visualizza, nel template, così:

{   "description": "Un template per il collegamento a una categoria di Commons su un articolo", "params": { "1": {           "label": "Categoria principale", "description": "La categoria di Commons che desideri collegare.", "default": "Category:CommonsRoot", "type": "string", "required": true }   } }

Descrizione e parametri
Una volta che hai finito, premi "Save". 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 bit di informazione è racchiuso tra virgolette (ad eccezione di  e  ) e separato dal bit successivo da una virgola (a meno che non sia l'ultimo).

Formati personalizzati
Quando modifichi le stringhe del formato personalizzato nell'editor TemplateData puoi digitare  o premere il tasto invio per rappresentare una nuova riga; in entrambi i casi verrà visualizzato come   nel campo di immissione.

{| class="wikitable" ! style="width:25%" | Obiettivo ! Formato stringa ! Uscita ogni template sulla propria linea
 * + Esempi di formati che puoi utilizzare
 * Formattazione in linea
 * Blocca la formattazione
 * Nessuno spazio prima del nome del parametro,
 * Blocca la formattazione
 * Nessuno spazio prima del nome del parametro,
 * Blocca la formattazione
 * Nessuno spazio prima del nome del parametro,
 * Nessuno spazio prima del nome del parametro,
 * Nessuno spazio prima del nome del parametro,
 * Nessuno spazio prima del nome del parametro,
 * Identa (per esprimere al meglio la struttura del codice) ogni parametro
 * Allinea tutti i nomi dei parametri a una determinata lunghezza
 * Allinea tutti i nomi dei parametri a una determinata lunghezza
 * Allinea tutti i nomi dei parametri a una determinata lunghezza
 * Allinea tutti i nomi dei parametri a una determinata lunghezza
 * Allinea tutti i nomi dei parametri a una determinata lunghezza
 * Inserire caratteri di pipe alla fine della riga precedente
 * Stile in linea con più spazi, devono essere all'inizio di ogni riga
 * Stile in linea con più spazi, devono essere all'inizio di ogni riga
 * Stile in linea con più spazi, devono essere all'inizio di ogni riga
 * Stile in linea con più spazi, devono essere all'inizio di ogni riga
 * Stile in linea con più spazi, devono essere all'inizio di ogni riga
 * Il template all'inizio di una riga, parametri allineati-identati, caratteri pipe della riga precedente
 * si può anche scrivere come  o.
 * si può anche scrivere come  o.

Per aggiungere questa informazione a TemplateData, semplicemente bisogna aggiungere gli alias all'informazione del parametro:

Valore automatico
È possibile specificare un "autovalue" per un parametro. Quando gli utenti aggiungono il template a una pagina wikipedia, questo valore verrà aggiunto automaticamente. Ad esempio, molti template di pulizia devono avere sempre la data; se si specifica un autovalore per il parametro data del modello, la data verrà compilata automaticamente.

To add this information to TemplateData, simply add the autovalue to the parameter's information. You will probably want to use the prefix  with the values to make them 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:

Parametri associativi
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.

Syntax Error in JSON / Bad JSON format
Due to a long standing bug, users using the old wikitext editor are able to save pages which have certain types of invalid JSON, such as duplicate keys or trailing commas (details: ). However if you attempt to save this page in a Javascript based editor, such as VisualEditor or the 2017 Wikitext editor, you will see an error message "Syntax error in JSON," as the Javascript parser is stricter and doesn't allow invalid JSON. Additionally, if you attempt to open up such invalid JSON with the Template Data GUI editor, you will see the error message, "Bad JSON format." To fix these errors, you can enter the JSON block into an external JSON validator, such as https://jsonlint.com/, and it will highlight the problematic commas and keys so they can be removed.

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