Help:TemplateData
 |
Nota: Quando modifichi questa pagina, acconsenti a pubblicare il tuo contributo con licenza CC0. Vedi le pagine di aiuto sul dominio pubblico per maggiori informazioni. | |
TemplateData è 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 template, 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 Extension:TemplateData.
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 "Modifica"/"Modifica sorgente" 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 VisualEditor, 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. È stato definito Editor di wikitesto 2017. Questo ha portato per la prima volta le caratteristiche di TemplateData nell'editing dei sorgenti.
Nel marzo 2018, Sam Wilson ha sviluppato TemplateWizard, un'estensione dell'editor di template con interfaccia grafica per l'editor di sorgenti predefinito di Wikimedia, WikiEditor (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 {{Documentation}} 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 "
Documentazione del template" sarà seguita da collegamenti come [visualizza], [modifica], [cronologia] e [cancella].
- Nei template con sottopagine di documentazione, l'intestazione "
- Alcune pagine di template hanno mantenuto queste informazioni nella pagina principale del template. È possibile individuarlo in queste pagine cercando un'occorrenza di
{{Documentation|content=tra i tag<noinclude>.
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 "{{Documentation|" e "|content=" e poi avrà aggiunto il contenuto dopo "|content=".
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 "Modifica"/"Modifica sorgente" nella pagina principale del template; cercare i tag <noinclude> e il loro contenuto (di solito in fondo).
Il risultato finale dovrebbe apparire più o meno così:
<noinclude>
{{Documentation|content=
== Utilizzo ==
Informazione sull'utilizzo.
== Altri esempi di intestazioni ==
Altri esempi di contenuti
[[Category:Example category]]
[[Category:Example category 2]]
}}
</noinclude>
È possibile che contenga già TemplateData. In tal caso, il risultato finale apparirà più o meno così:
<noinclude>
{{Documentation|content=
...
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Parametro esempio",
"description": "Descrizione parametro esempio",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Selezionare tutto ciò che si trova dopo "|content=" e prima di "</noinclude>" e copiarlo negli appunti o salvarlo in un documento temporaneo. Eliminare "|content=", lasciando solo quanto segue:
<noinclude>
{{Documentation}}
</noinclude>
Salvare la pagina del 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 {{Documentation subpage}}, aggiungerlo all'inizio della nuova pagina. Si possono anche aggiungere altri template, come {{Purge button}} oppure {{Purge}} (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 <includeonly> in modo che si applichino solo alla pagina principale del template:
<includeonly>
[[Category:Example category]]
[[Category:Example category 2]]
</includeonly>
Molti wiki hanno un template {{Sandbox other}}.
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:
<includeonly>{{sandbox other||
[[Category:Example category]]
[[Category:Example category 2]]
}}</includeonly>
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 <templatedata> seguito da un array tra parentesi graffe: {}).
In alternativa, l'estensione TemplateData può anche eseguire questo controllo. Fare clic su "Modifica" oppure "Modifica sorgente" 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:
- Attenzione: esiste già un blocco dati del modello nella relativa pagina "[[Template:Templatename/doc]]".
oppure
- Attenzione: esiste già un blocco dati del modello nella relativa pagina "[[Template:Templatename]]".
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 ".svg){kind=icon}
Template documentation" (o simile), oppure, se si è già nella pagina /doc, fare clic su "Modifica" o "Modifica sorgente" 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 "Modifica"/"Modifica sorgente" nella pagina principale del template e cercare i tag <templatedata>, racchiusi all'interno dei tag <noinclude>.
Il risultato finale dovrebbe apparire più o meno così:
<noinclude>
{{Documentation}}
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "Parametro esempio",
"description": "Descrizione parametro esempio",
"type": "string"
}
}
}
</templatedata>
</noinclude>
Tagliare dal codice solo i tag <templatedata> 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 #Metodi 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 "Modifica" o "Modifica sorgente" 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 "Modifica" o "Modifica sorgente".
Dopo aver fatto clic su "Modifica" o "Modifica sorgente", si vedrà un pulsante sopra l'area di modifica e il titolo della pagina che dice "Modifica dati del modello".
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.
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 esistono dati del template di lingua, l'interfaccia offrirà agli utenti solo la lingua del wiki, ma gli utenti possono fare clic su "Aggiungi lingua" 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 "Applica"; i due tipi principali sono
"inline"(su una riga) e"block"(su nuove righe). Questo parametro e i suoi effetti sono descritti qui.
- Se l'utente sceglie "Personalizzato", può inserire il wikitesto sotto "Stringa in formato personalizzato" secondo le regole descritte qui, in modo da creare un layout personalizzato per il template quando l'utente clicca su "Applica".
- Il quarto elemento configura i parametri di un modello. Se i parametri sono già stati definiti nei dati del modello, quest'area li visualizza in un elenco. Se il codice sorgente del modello specifica parametri per i quali non esistono dati del modello, si può vedere un pulsante con l'etichetta "Aggiungi 2 parametri suggeriti". L'editor estrae questi suggerimenti dal codice sorgente del modello cercando
{{{parametername}}}o{{{parametername|}}}. Facendo clic su "Aggiungi 2 parametri suggeriti" si aggiungono questi parametri utilizzando i nomi definiti nel codice sorgente. In alto apparirà anche un avviso verde, ad esempio "2 nuovi parametri sono stati importati: nomi dei parametri.". - In fondo alla finestra è presente il pulsante "Aggiungi parametro". 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.
Tutte queste caratteristiche e i loro effetti sono descritti nella sezione #Within a parameter's name.
- Facendo clic su "Rimuovi il parametro di informazione" si elimina il parametro e tutte le sue informazioni dal TemplateData. Non è possibile recuperare o annullare questa operazione nel TemplateData, a meno che non si faccia clic su "X". È possibile annullare qualsiasi modifica apportata dopo aver fatto clic su "Applica" premendo Ctrl+Z.
- Uscendo dall'editor di TemplateData dopo aver apportato le modifiche, viene richiesto di confermare l'eliminazione delle modifiche.
Al termine, fare clic su "Applica".
Questo inserirà automaticamente il TemplateData in fondo alla pagina, prima del tag </noinclude>; 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 "Applica".
L'editor TemplateData crea un parametro "paramOrder" in fondo al TemplateData (o lo aggiorna se esiste già).
"paramOrder" contiene i parametri correnti di TemplateData nell'ordine in cui sono stati visualizzati dall'editor di TemplateData.
È possibile modificare il "paramOrder" trascinando i parametri verso l'alto e verso il basso nell'editor TemplateData utilizzando le tre barre orizzontali a sinistra.
"paramOrder" e i suoi effetti sono descritti qui.
Dopo di che, fare clic su "Salva" 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 "parameter": "value".
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.
- Se si aggiungono i TemplateData nella pagina principale di un template (sconsigliato; vedere #Prior checks), bisogna assicurarsi di inserirli all'interno dei tag
<noinclude>...</noinclude>.
Fare clic su "Modifica" o "Modifica sorgente" nella rispettiva pagina, quindi spostarsi nel punto della pagina in cui si intende aggiungere TemplateData e scrivere un'intestazione: "TemplateData".
Molti wiki hanno un template {{TemplateData header}} che aggiunge un breve avviso relativo ai TemplateData. Se il vostro wiki ce l'ha, aggiungetelo dopo l'intestazione.
Per iniziare ad aggiungere TemplateData, digitare un tag <templatedata> di apertura e di chiusura e una coppia di parentesi graffe su nuove righe, con una riga vuota tra di esse:
<templatedata>
{
}
</templatedata>
Quindi, aggiungere un rientro sulla riga vuota tra le due parentesi graffe e iniziare ad aggiungere i parametri. I dettagli dei parametri si trovano in #Parametri del templateData. La maggior parte di essi sono opzionali; alcuni sono altamente raccomandati.
I parametri possono essere in qualsiasi ordine, ma quello che segue è l'ordine più conforme alla documentazione di TemplateData e che rende il contenuto più facile da usare per i redattori:
<templatedata>
{
"description": "",
"format": "",
"params": {
"parameter1": {
"aliases": ["",""]
"label": "",
"description": "",
"type": ""
}
},
"paramOrder": [
""
]
}
</templatedata>
Assicurarsi che i parametri, per esempio nell'oggetto "params", rimangano all'interno di quell'oggetto; altrimenti si verificherà un errore "Proprietà "propertyname" non prevista." quando si cercherà di salvare.
Esempio
Ecco alcuni esempi di TemplateData per un ipotetico template di pulizia. Questo template visualizzerebbe un avviso e posizionerebbe la pagina in una categoria datata in base al mese e all'anno inseriti. L'avviso potrebbe anche contenere un link a una sezione della pagina di discussione. Il TemplateData avrebbe un aspetto simile a questo:
<templatedata>
{
"description": "Utilizza questo template per indicare che un articolo ha bisogno di pulizia.",
"format": "inline",
"params": {
"date": {
"label": "Mese e anno",
"description": "Il mese e l'anno in cui il template è stato aggiunto",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"example": "gennaio 2013",
"suggested": true
},
"reason": {
"aliases": ["1"],
"label": "Motivo",
"description": "Il motivo per cui l'articolo ha bisogno di pulizia",
"type": "string"
},
"talk": {
"aliases": ["talksection"],
"label": "Sezione pagina di discussione",
"description": "La sezione della pagina di discussione contenente la discussione pertinente",
"type": "string"
}
},
"paramOrder": [
"date",
"reason",
"talk"
]
}
</templatedata>
La documentazione corrispondente di TemplateData viene visualizzata come segue:
Utilizza questo template per indicare che un articolo ha bisogno di pulizia.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Mese e anno | data | Il mese e l'anno in cui il template è stato aggiunto
| String | suggested |
| Motivo | motivo 1 | Il motivo per cui l'articolo ha bisogno di pulizia | String | optional |
| Sezione pagina di discussione | discussione talksection | La sezione della pagina di discussione contenente la discussione pertinente | String | optional |
Descrizione e parametri
Tutti i parametri TemplateData disponibili sono elencati di seguito con una descrizione e un esempio. Sono anche elencati in modo più dettagliato in Extension:TemplateData#Format.
- Queste informazioni sono aggiornate a novembre 2021 e possono cambiare se vengono aggiunti nuovi parametri o se le interfacce di modifica dei modelli vengono aggiornate per supportare i parametri esistenti o trattare alcuni parametri in modo diverso.
- Il markup Wiki non funziona nelle descrizioni o nelle etichette. Si tratta esclusivamente di stringhe di testo semplice.
- Le nuove righe ("
\n") nelle descrizioni, nelle etichette, negli esempi o nelle impostazioni predefinite non vengono visualizzate in nessuno degli editor principali (TemplateWizard, VisualEditor o l'editor wikitext 2017), anche se vengono visualizzate nella documentazione autogenerata di TemplateData. Vengono sostituiti da una stringa nulla nei moduli di input e da uno spazio altrove.
| Parametro | Descrizione | Esempio |
|---|---|---|
| description |
Il primo tag è un Effetti Nella pagina di documentazione del template, la descrizione verrà visualizzata in testo semplice sotto il sottotitolo "Dati del template per [nome del template]". In tutti gli editor principali (VisualEditor, Editor di wikitesto 2017 e Estensione:WikiEditor con TemplateWizard), la descrizione si presenta in due istanze principali:
Nell'editor VisualEditor e nell'editor wikitesto 2017, la descrizione viene troncata a circa 50 caratteri sotto ogni suggerimento di ricerca, seguita da un "...", ma l'intera descrizione viene visualizzata nella finestra principale dell'editor di template. Entrambi sono mostrati in testo grigio. Nella finestra principale dell'editor di template, le descrizioni più lunghe di quattro righe (circa 540 caratteri) sono dotate di una barra di scorrimento separata e sono visualizzate in testo nero. Se non specificato Se il parametro descrizione non esiste o non è specificato, nella documentazione di TemplateData verrà visualizzato il testo "Nessuna descrizione." sotto il sottotitolo "Dati del template per [nome del template]". Inoltre:
|
"description": "Un template per il collegamento a una categoria di Commons su un articolo",
|
| format |
Il prossimo è Questo parametro non è richiesto, ma è fortemente consigliato. The default behavior when this parameter is not provided is preserving the existing formatting for existing parameters, or inline formatting for newly added parameters and templates. Effetti In linea: ( Una volta inserito, il template disporrà il suo wikitesto su una singola riga senza spazi bianchi tra gli elementi, in questo modo:
Block: ( Una volta inserito, il modello distribuirà i suoi parametri su una nuova riga, con spazi singoli tra ogni elemento, in questo modo: {{Foo
| bar = baz
| longparameter = quux
}}
Formattazione personalizzata: In alternativa, se il parametro è impostato su una stringa personalizzata di wikitesto, secondo le regole elencate in #Formati personalizzati, il template mostrerà il seguente avviso di preferenza nella sua documentazione TemplateData: |
"format": "inline"
|
| params |
L'oggetto Dovrebbe contenere il nome di ogni parametro, seguito da un insieme di sottoparametri TemplateData elencati in #Nome del parametro. Se ci sono più parametri, inserire una virgola tra ogni oggetto parametro, ma non aggiungerne una dopo l'ultima parentesi graffa (vedere l'esempio). |
"params": {
"parameter1": {
... // Info parametro
}, // virgola qui
"parameter2": {
... // info parametro
}, // e qui
"parameter3": {
... // info parametro
} // ma non qui
}
|
| paramOrder |
L'oggetto Come utilizzarlo Aggiungete il parametro Non è necessario che i parametri siano su nuove righe (possono essere scritti come Si consiglia di inserire È necessario includere tutti i parametri menzionati nel TemplateData, altrimenti verrà visualizzato un errore "Proprietà obbligatoria "properlyname" non trovata.typo". Se non specificato Senza Con altri parametri Nell'editor wikitesto 2010 con TemplateWizard:
In VisualEditor e nell'editor wikitesto 2017, |
"paramOrder": [
"date",
"reason",
"talk"
]
|
Con parametri
| Parametro | Descrizione | Esempio |
|---|---|---|
| Nome del parametro |
L'unico elemento di primo livello dell'oggetto Per esempio, nel codice sorgente di un template Si possono vedere anche parametri denominati
Nota: un utente può ancora forzare l'uso di Come utilizzarlo Ciascuno di questi oggetti "Nome del parametro" dovrebbe contenere tutte le informazioni sul parametro, sotto forma di più parametri TemplateData. Questi sono elencati nella successiva sezione, Within a parameter's name. |
"1": { // nome del parametro
... // informazione sul parametro va qui
}
|
Con i nomi dei parametri
| Parametro | Descrizione | Esempio |
|---|---|---|
| aliases |
Il parametro opzionale
oppure
Ciò significa che se l'utente inserisce uno di questi parametri con un valore, essi eseguiranno la stessa funzione. Letteralmente, si traduce in "Valore di parameter1. Se il parametro1 non esiste o non ha un valore: valore di parameter2". Nel secondo caso, significa anche: "Se parameter2 non esiste o non ha valore: nessun valore". Per inserire il parametro |
"aliases": ["1", "talk", "talksection"],
|
| inherits |
Per utilizzare questo parametro, digitare |
"params": {
"argomento1": {
"label": "Argomento",
"description": "Un argomento citato in questa pagina di disambiguazione",
"type": "string"
},
"argomento2": {
"inherits": "argomento1"
},
"argomento3": {
"inherits": "argomento1",
"label" : "A different label"
}
}
|
| label |
Il parametro |
"label": "Mese e anno",
|
| description |
Qui, |
"description": "Il mese e l'anno in cui il template è stato aggiunto",
|
| type |
Vedere la sezione #Type parameter. |
|
| default |
Alcuni parametri del template hanno un valore predefinito, che viene utilizzato a meno che non venga sovrascritto dall'utente.
L'elemento Effetti In tutti gli editor principali (VisualEditor, l'editor wikitesto 2017 e l'editor wikitesto 2010 con TemplateWizard), il testo Con altri parametri In tutti gli editor principali (VisualEditor, l'editor wikitesto 2017 e l'editor wikitesto 2010 con TemplateWizard), se viene specificato |
"default": "Category:CommonsRoot",
|
| autovalue |
Un parametro può essere assegnato a Questo valore può essere sovrascritto dall'utente nell'editor del template. Con altri parametri In tutti gli editor principali (VisualEditor, editor wikitesto 2017 e editor wikitesto 2010 con TemplateWizard), |
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
|
| example |
Il parametro Effetti In tutti gli editor principali (VisualEditor, l'editor wikitesto 2017 e l'editor wikitesto 2010 con TemplateWizard), questa proprietà viene visualizzata sotto la descrizione del parametro (e sotto il testo Con altri parametri In tutti gli editor principali (VisualEditor, l'editor wikitesto 2017 e l'editor wikitesto 2010 con TemplateWizard), |
"example": "January 2013",
|
| required |
Dopo abbiamo Determina se la compilazione del parametro dato è obbligatoria per il modello. Effetti Questo stato ha diversi effetti in VisualEditor e l'Editor di wikitesto 2017
Nell'In Estensione:WikiEditor con Aiuto:Estensione:TemplateWizard, come negli altri editor, il parametro viene visualizzato automaticamente quando l'utente inserisce il modello, ma il parametro non può essere rimosso con questo o con altri editor. Inoltre, non visualizza "Il campo è obbligatorio." nella descrizione del parametro, ma lo elenca a lato sotto "Parametri obbligatori". A parte ciò, si comporta generalmente come negli altri editor, tranne che per il fatto che il prompt dice che l'input non "corrisponde al formato previsto". Con altri parametri In VisualEditor e nell'editor wikitesto 2017, lo stato |
"required": true
|
| suggested |
Il parametro Utilizzare Effetti In VisualEditor e in Editor di wikitesto 2017, fa sì che il parametro venga visualizzato automaticamente quando l'utente inserisce un template. Se il parametro ha un valore automatico, questo sarà automaticamente presente anche nella casella di immissione del parametro. Non ha altri effetti e non mostra alcun testo o avviso aggiuntivo. In Estensione:WikiEditor con TemplateWizard, non inserisce automaticamente il parametro nel template, ma lo fa elencare a lato sotto "Suggested parameters". L'utente può quindi fare clic su un "+" accanto al parametro per aggiungerlo al modello. Con altri parametri Lo stato |
"suggested": true
|
| deprecated |
Infine, c'è Si tratta di uno stato per i parametri che non dovrebbero più essere utilizzati, ma che per il momento esistono ancora. Ciò potrebbe essere dovuto al fatto che gli usi del template vengono spostati da un set di parametri a un altro. Effetti L'effetto di questo parametro in VisualEditor e nell'editor wikitestot 2017 è che un punto esclamativo grigio appare accanto all'etichetta del parametro quando viene inserito, e nel tooltip informativo del parametro, il testo grigio e corsivo "Il campo è obsoleto. motivo di deprecazione" è mostrato sotto la descrizione del parametro. Non influisce sulla funzionalità o sull'usabilità del parametro e non mostra alcun avviso aggiuntivo. Nonostante possa accettare una stringa, a partire da gennaio 2020 nessuno dei principali editor (VisualEditor, l'editor wikitesto 2017 o l'editor wikitesto 2010) mostra agli utenti il contenuto della stringa.
L'immissione di una stringa ha lo stesso effetto di Nell'editor wikitesto 2010 con TemplateWizard, impostare questo valore come Con altri parametri Se si imposta sia questo che Se si imposta sia questo che Nell'editor di wikitesto 2010 con TemplateWizard, |
"deprecated": "Utilizzare invece publicationDate."
|
| suggested values |
La proprietà di parametro
Altri tipi (file, page, template, user, date, boolean, URL) non sono attualmente supportati perché hanno già funzionalità speciali nel VisualEditor, come il completamento automatico, che interferirebbe con il menu a discesa per i valori suggeriti nel VisualEditor. Modificare TemplateData come JSON in wikitesto Per aggiungere valori suggeriti a qualsiasi tipo di parametro, aggiungere la nuova proprietà "suggestedvalues" al parametro in JSON. L'attributo “suggestedvalues” deve essere un elenco di stringhe. Modificare un TemplateData con il TemplateData Editor
Effects Una volta aggiunti i valori a TemplateData, il VisualEditor li visualizzerà in una casella combinata (un menu a tendina in cui gli utenti possono anche inserire un valore personalizzato) per i tipi di parametri sopra elencati. L'utente seleziona il valore desiderato facendo clic su di esso. Se l'elenco dei valori è lungo, ad esempio un elenco di stati di un paese, l'utente può iniziare a digitare nel campo e l'elenco verrà filtrato per mostrare solo i valori che contengono il testo digitato. Per modificare un valore inserito, l'utente deve semplicemente cancellare il campo e l'elenco a discesa completo apparirà di nuovo. Se l'utente ha bisogno di un valore non incluso nell'elenco (ad esempio, "messaggio in bottiglia"), può digitarlo manualmente. |
"suggestedvalues": [
"Quotidiano",
"Libro",
"Giornale",
"Rivista"
]
|
Nota: se né "required", "suggested" oppure "deprecated" sono impostati come true per un parametro, il suo stato sarà indicato come "optional" nella documentazione di TemplateData.
Una volta terminato, premere "Salva". Se hai commesso errori, non ti consente di salvare (che è fastidioso, ma significa che non si danneggia nulla). In caso di errori, spiegate nella pagina di feedback cosa stavate cercando di fare e saremo felici di aiutarvi.
Si noti che se si sta abusando di un template hack per generare dinamicamente TemplateData, non è possibile verificare la presenza di errori prima del salvataggio.
Si noti che ogni elemento di informazione è racchiusa tra virgolette (eccetto true e false) e separato dall'elemento successivo da una virgola (a meno che non sia l'ultima).
Parametro "Type"
Il parametro "type" serve a segnalare all'editor di template la natura del valore di un parametro.
In alcuni casi, gli editor di template sono stati programmati per modificare l'interfaccia utente di un determinato parametro in base al valore di TemplateData, ad esempio per consentire all'utente di inserire solo valori validi che corrispondono al tipo specificato.
Questo parametro non ha alcun effetto funzionale sul parametro del template o sul suo valore; controlla solo il modo in cui gli editor dei template vedono e trattano il parametro in modalità di modifica.
Come utilizzarlo
Si utilizza aggiungendo il parametro "type", seguito da due punti e uno spazio, quindi aggiungendo uno dei valori elencati nella tabella seguente tra virgolette.
Esempio:
"type": "string",
Effetti
A febbraio 2020, solo 5 dei 13 valori dei tipi hanno effetti visibili in VisualEditor e nell'editor wikitext 2017, mentre 8 hanno effetti visibili in TemplateWizard.
È probabile che gli effetti di alcuni valori cambino man mano che gli editor di template vengono aggiornati per supportarli. Uno di questi sforzi per VisualEditor e l'editor wikitext 2017 è tracciato nel task T55613 di Phabricator. Uno sforzo simile per far sì che TemplateWizard supporti il valore booleano è tracciato in T200664.
Gli effetti attualmente noti sono elencati di seguito.
| Valore | Descrizione | |
|---|---|---|
| unknown |
Il valore Effetti In tutti gli editor principali (VisualEditor, l'editor wikitesto 2017 e l'editor wikitesto 2010 con TemplateWizard), | |
| string |
Il valore Effetti In tutti gli editor principali (VisualEditor, l'editor wikitesto 2017 e l'editor wikitesto 2010 con TemplateWizard), | |
| line |
Il valore Effetti
| |
| content |
Il valore Effetti
| |
| unbalanced-wikitext |
Il valore Effetti
| |
| wiki-page-name |
Il valore Effetti In tutti gli editor principali (VisualEditor, l'editor wikitext 2017 e l'editor wikitesto 2010 con TemplateWizard), | |
| wiki-file-name |
Il valore Effetti
| |
| wiki-template-name |
Il valore Effetti In tutti gli editor principali (VisualEditor, l'editor wikitesto 2017 e l'editor wikitesto 2010 con TemplateWizard), | |
| wiki-user-name |
Il valore di Effetti In tutti gli editor principali (VisualEditor, l'editor wikitesto 2017 e l'editor wikitesto 2010 con TemplateWizard), | |
| number |
Il valore Effetti
Con altri parametri
| |
| boolean |
Il valore Effetti A febbraio 2020, nessuno dei principali editor Wikimedia (VisualEditor, l'editor wikitesto 2017 o l'editor wikitesto 2010 con TemplateWizard) fa uso di questo valore. Non ha effetti visibili. Con la casella di controllo | |
| date |
Il valore Effetti
Con altri parametri
| |
| url |
Il valore Effetti
Con altri parametri
| |
Formati personalizzati
Quando si modifica il valore "format", si creano formati personalizzati inserendo una serie di simboli wikitesto utilizzando alcune regole predefinite.
{{- inizio del template_- contenuto (e.g., stringa, intero o parametro). Questo trattino basso serve a indicare la lunghezza minima di un valore in caratteri e può essere ripetuto, come_______. Se questa lunghezza non viene raggiunta, i caratteri rimanenti vengono riempiti di spazi. Può essere usato per allineare tutti i segni di uguale a una posizione specifica dopo un parametro (se usato con\nper le nuove righe).|- barra verticale (separa i parametri)=- segno uguale (precedere il valore del parametro)\no premendo il tasto invio - nuova riga (questo verrà visualizzato come↵nel campo di immissione)\nper rientrare le nuove righe)}}- fine del template
Il wikitesto deve soddisfare almeno il minimo di {{_|_=_}}, altrimenti si verificherà un errore di stringa di formato non valida.
| Obiettivo | Formato stringa | Uscita |
|---|---|---|
| Formattazione in linea | {{_|_=_}} inline
|
{{Foo|bar=baz|longparameter=quux}}{{Bar}}
|
| Formattazione in blocco | {{_\n| _ = _\n}} block
|
{{Foo
| bar = baz
| longparameter = quux
}}{{Bar}}
|
| Nessuno spazio prima del nome del parametro, ogni template sulla propria linea | \n{{_\n|_ = _\n}}\n
|
{{Foo
|bar = baz
|longparameter = quux
}}
{{Bar}}
|
| Identa (per esprimere al meglio la struttura del codice) ogni parametro | {{_\n |_ = _\n}}
|
{{Foo
|bar = baz
|longparameter = quux
}}{{Bar}}
|
| Allinea tutti i nomi dei parametri a una determinata lunghezza | {{_\n|_______________ = _\n}}\n |
{{Foo
|bar = baz
|longparameter = quux
|veryverylongparameter = bat
}}
{{Bar}}
|
| Inserire caratteri di pipe alla fine della riga precedente | {{_|\n _______________ = _}}
|
{{Foo|
bar = baz|
longparameter = quux}}{{Bar}}
|
| Stile in linea con più spazi, devono essere all'inizio di ogni riga | \n{{_ | _ = _}}
|
{{Foo | bar = baz | longparameter = quux}}
{{Bar }}
|
| Il template all'inizio di una riga, parametri allineati-identati, caratteri pipe della riga precedente | \n{{_ |\n _______________ = _}}
|
{{Foo |
bar = baz |
longparameter = quux}}
{{Bar}}
|
Modello vuoto
Puoi copiare il seguente modello vuoto per aggiungere TemplateData ad un template. Contiene solo i parametri più comuni.
<templatedata>
{
"description": "",
"params": {
"1": {
"label": "",
"description": "",
"type": ""
},
"2": {
"label": "",
"description": "",
"type": ""
}
}
}
</templatedata>
Errori
Errore di sintassi in JSON. / Formato JSON errato
Questi errori si verificano quando si salvano TemplateData, di solito modificati manualmente, con codice JSON non valido (chiavi/parametri duplicati, virgole mancanti o in ritardo, ecc.) in VisualEditor o nell'editor wikitesto 2017.
"Errore di sintassi in JSON." appare in VisualEditor e nell'editor wikitesto 2017; "Bad JSON format" appare quando si modifica nell'editor GUI di TemplateData.
Questi errori possono essere difficili da individuare e si presentano in forme troppo diverse per essere elencate. Il modo migliore per evitarli è modificare i dati dei template esclusivamente con l'editor TemplateData; il modo migliore per individuarli una volta che si sono verificati è usare un validatore JSON esterno, come JSONLint, che evidenzierà gli errori e aiuterà a correggerli.
L'editor wikitesto 2010 non controlla i JSON non validi a causa di un vecchio bug non risolto (task T128029). Le pagine che contengono JSON non validi possono lanciare messaggi allarmanti del tipo "Errore interno". Per risolvere questi errori, la cosa migliore è usare un validatore JSON (vedere sopra).
Proprietà obbligatoria "paramOrder[numero]" non trovata.
Questo errore si verifica se in "params" si indica un parametro che non è indicato in "paramOrder".
Il numero tra le parentesi quadre si riferisce al parametro in "paramOrder" che manca. Si riferisce al suo ordine nella sequenza, ma è uno in meno della sua posizione effettiva, poiché "paramOrder" è un array; 0 è il primo, 1 è il secondo, ecc.
"params": {
"date": { ...
},
"reason": { ...
},
"talk": { ... // <-- Questo parametro non è indicato in "paramOrder", ma dovrebbe esserlo.
}
},
"paramOrder": [
"date",
"reason"
]
// Errore: La proprietà richiesta "paramOrder[2]" non è stata trovata.
Errore: La proprietà richiesta ""params"" non è stata trovata.
In alternativa, è possibile rimuovere l'oggetto "paramOrder" per eliminare l'errore.
Valore non valido per la proprietà "paramOrder[numero]".
L'errore si verifica se in "paramOrder" si indica un parametro che non è indicato in "params".
Il numero tra le parentesi quadre si riferisce al parametro in "paramOrder" che non dovrebbe essere presente. Si riferisce al suo ordine nella sequenza, ma è uno in meno della sua posizione effettiva, poiché "paramOrder" è un array; 0 è il primo, 1 è il secondo, ecc.
"params": {
"date": { ...
},
"talk": { ...
}
},
"paramOrder": [
"date",
"reason", // <-- Questo parametro non è indicato in "params", ma dovrebbe esserlo.
"talk"
]
// Errore: Valore non valido per la proprietà "paramOrder[1]".
Per risolvere questo problema, assicurarsi che tutti i parametri indicati in "paramOrder" siano elencati in "params".
In alternativa, è possibile rimuovere l'oggetto "paramOrder" per eliminare l'errore.
La proprietà "params.parametername.required" dovrebbe essere di tipo "boolean".
L'errore si verifica se si mettono le virgolette intorno al valore di "required" o "suggested".
"suggested": "true" // <-- Queste virgolette non dovrebbero essere qui.
Si tratta di valori booleani, non di stringhe, quindi non necessitano di virgolette.
Per risolvere il problema, rimuovere le virgolette intorno ai valori true o false per questi parametri.
La proprietà "format" è prevista ...
Se il parametro "format" esiste ma il suo valore non è "inline", "block" o una stringa di formato valida, verrà visualizzato il messaggio di errore "Proprietà "format" dovrebbe essere "inline", "block" o una stringa di formato valido.".
"format": "notinline"
// Errore : La proprietà "format" deve essere "inline", "block" o una stringa di formato valida.
Per risolvere questo problema, assicurarsi che il valore dopo "format": sia uguale a "inline" o "block" e che non ci siano errori di ortografia. In alternativa, se si tratta di wikitesto, assicurarsi che contenga almeno {{_|_=_}} e che non ci siano errori nella sintassi che normalmente farebbero fallire un template, come segni di uguale duplicati o parentesi graffe mancanti o duplicate; vedere la sezione #Formati personalizzati per la sintassi dei formati personalizzati.
In alternativa, è possibile rimuovere il parametro "format" per eliminare l'errore.
Proprietà "parametername" non prevista.
Questo errore si verifica se si dichiara un parametro che non esiste in TemplateData. Ciò è probabilmente dovuto a errori di ortografia.
<templatedata>
{
"description": "",
"format": "inline",
"params": {
"1": {
"label": "",
"descriptino": "", // <-- errore ortografico
"type": ""
}
}
}
</templatedata>
Si verifica anche se si indica un parametro in un oggetto TemplateData che non è un parametro di quell'oggetto. Ciò può essere dovuto a errori di ortografia, oppure si può aver scritto il parametro di un oggetto TemplateData sotto un altro oggetto a cui non appartiene.
Ad esempio, si potrebbe aver scritto il parametro "label" sotto l'oggetto radice TemplateData, invece che all'interno di "params":
<templatedata>
{
"description": "",
"format": "inline",
"label": "", // <-- parametro posizionato in modo errato
"params": {
"1": { // ↓ it should be in here
"description": "",
"type": ""
}
}
}
</templatedata>
In alternativa, se il parametro inatteso si trova sotto un parametro del template all'interno di "params", si vedrà il suo nome dopo "params.parametername" nell'errore.
Per risolvere questo problema, assicurarsi che non ci siano errori di ortografia nei nomi dei parametri e che i parametri siano nella loro posizione corretta. Inoltre, assicurarsi di non indicare parametri che non esistono per un oggetto TemplateData. È possibile verificare quali parametri esistono per un oggetto nella sezione #ParametriTemplateData.
Proprietà obbligatoria "params" non trovata.
Questo errore si verifica se non esiste un oggetto "params" nel TemplateData.
Si tratta di un oggetto necessario, in quanto contiene tutti i dettagli di ogni parametro; per risolvere questo errore, assicurarsi che sia stato aggiunto e che non ci siano errori di ortografia.
Vedere la sezione precedente su come aggiungere il parametro "params".
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.
Altri strumenti
- Aiuto:Estensione:TemplateWizard
- Una finestra di dialogo della barra degli strumenti per l'inserimento del wikitesto del template tramite un modulo costruito da TemplateData.
- TemplateData Wizard
- Uno strumento che genera TemplateData attraverso un'interfaccia interattiva.
- Skeleton TemplateData generator
- Uno strumento che legge il wikicodice sorgente di un template, cerca di trovare tutti i parametri utilizzati e produce un documento scheletrico con i parametri elencati.
- JSONLint
- Uno strumento che consente di convalidare JSON scritto manualmente per aiutare nell'individuazione degli errori nella sintassi.
- Elenco di tutti i template con TemplateData su questo wiki
- Con dewiki template TemplateData i dati del template vengono mostrati in un riquadro e il template viene aggiunto a una categoria di template con dati di template
- https://query.wikidata.org/ e Query Helper