Wikipedia:VisualEditor/TemplateData: differenze tra le versioni
Contenuto cancellato Contenuto aggiunto
→Codice: deprecato |
m aggiungo un po' di padding |
||
| (48 versioni intermedie di 30 utenti non mostrate) | |||
Riga 1:
{{
{{VisualEditor}}
<div style="padding:.4em; background-color:#CDFFCD; background-color:light-dark(#CDFFCD, var(--background-color-neutral, #eaecf0)); color:inherit; overflow:auto">[[File:Gestisci documentazione template.png|thumb|right|216px|Accesso all'interfaccia visuale]] '''Attenzione:''' è ora disponibile una nuova [[#Interfaccia visuale di TemplateData|interfaccia ''visuale'']] per modificare/inserire TemplateData. Vi si accede tramite {{tasto|{{MediaWiki:Templatedata-editbutton}}}} dopo aver cliccato su ''Modifica sorgente'' nella sottopagina che contiene/conterrà i TemplateData (solitamente la sottopagina /TemplateData del template stesso).
</div>
Il '''TemplateData''' è un codice che va implementato nei [[Wikipedia:Template|template]] che vengono utilizzati nelle voci, per permettere al nuovo editor [[WP:VE|VisualEditor]] di capire quali sono i parametri di quel template e di proporre all'utente un'interfaccia grafica semplice e funzionale per l'inserimento dei template. ''Non'' bisogna inventarsi o imparare niente di particolare: è solo una trasposizione diversa di dati già a nostra disposizione, contenuti nei [[Aiuto:Manuali dei template|manuali dei template]]. Peraltro più in basso sono elencati diversi strumenti che fanno la maggior parte del lavoro al posto nostro!
[[File:Moto proprio template senza TD con VE.png|thumb|Template senza TemplateData.]]
[[File:Inclusione template libro con TD con VE.png|thumb|Template con TemplateData.]]
== Vantaggi nell'implementazione del TemplateData ==
{{quote|Passa al lato JSON della forza|[[Utente:Valepert]]}}
Riga 27 ⟶ 25:
== Dove mettere TemplateData ==
Il TemplateData va inserito in
La sottopagina va richiamata nella pagina base del template inserendo il template {{tl|TemplateData}} nella parte compresa tra {{tag|noinclude}}, alla riga dopo {{tl|man}}.
All'inizio della sottopagina va invece inserita la stringa <code><nowiki><noinclude>{{TemplateData sottopagina}}</noinclude></nowiki></code>, che ha anche il compito di includerla nella [[:Categoria:TemplateData]].
In caso la pagina base del template sia [[Wikipedia:Politica di protezione delle pagine|protetta]], la sottopagina "/TemplateData" <u>va comunque creata</u>: sarà infatti possibile richiamarla apponendo temporaneamente la stringa <code><nowiki><includeonly>{{TemplateData}}</includeonly></nowiki></code> nella sottopagina del manuale, prima di {{tag|noinclude}}.
Potrebbe volerci del tempo
== La struttura di TemplateData ==
La struttura di TemplateData è basata sullo standard "[[JavaScript Object Notation|JSON]]"
<pre>
Riga 77 ⟶ 78:
== Codice ==
Passiamo alla spiegazione del codice. Le [[virgolette]], i [[due punti]], le [[Virgola|virgole]] e le [[Parentesi#
*"'''description'''" (descrizione): dopo i due punti, tra le virgolette, si può inserire una breve descrizione del template.
*"'''params'''" (parametri): indica che le sezioni che seguono sono relative a ciascun parametro del template
:*In ogni sottosezione, il primo '''tag''' è quello del nome effettivo del parametro del template "per come è richiamato nel template"
::*"'''label'''" (etichetta): va inserito un titolo idoneo per il parametro che sarà visualizzato dentro l'editor di template di VE per aiutare chi lo modificherà a capire cosa contiene.
::*"'''description'''" (descrizione): descrizione del parametro specifico, non di tutto il template. Se necessario è possibile inserire un breve esempio.
Riga 90 ⟶ 91:
:::*"''wiki-file-name''" per indicare il nome di un file;
:::*"''date''" (data) secondo lo standard [[ISO 8601]] cioè anno-mese-giorno (esempio oggi è: {{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY2}}).
::*"'''required'''" (richiesto): può essere ''true'',
Alla fine di ogni parametro (tranne l'ultimo) si prega di mettere una virgola dopo le virgolette, come mostrato negli esempi e come indicato nel paragrafo più avanti.
Riga 107:
</syntaxhighlight>
===
Per indicare che un parametro è deprecato (cioè non più in uso) si può indicare il tag "'''deprecated'''". Può assumere i valori ''true'' (se un parametro è deprecato) o ''false'' (nel caso contrario). Modificando un template in VisualEditor comparirà un'icona con un punto esclamativo vicino al parametro.
=== Inherits ===
Riga 137 ⟶ 129:
Per evitare di avere parametri indicati con lo stesso nome si consiglia di indicare un nome (''label'') diverso da quello ereditato. I tag indicati, oltre a inherits, sostituiranno quelli ereditati.
=== Predefinito ===
Alcuni template permettono a un parametro di assumere un valore predefinito (''default'') nel caso l'utente non ne specifichi il valore in modo esplicito. Per esempio, il template {{tl|Azienda}} prevede per il parametro <kbd>logo_dimensione</kbd> il valore predefinito "200" (che sta a indicare che il logo verrà visualizzato come immagine da 200px di ampiezza), ma è possibile, in caso di necessità, impostare un valore diverso (es. 150). Per indicare questa informazione in TemplateData si può aggiungere il tag "'''default'''" alle info sul parametro, vedi:
<syntaxhighlight lang="javascript">
"params": {
"logo_dimensione": {
...
"default": "200"
}
</syntaxhighlight>
=== 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 semplicemente aggiungere il valore automatico alle informazioni del parametro:
Dovrai, probabilmente, utilizzare <code>subst:</code> per rendere i valori fissi:
<syntaxhighlight lang="javascript">
"params": {
"data": {
...
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}"
}
</syntaxhighlight>
=== Suggested ===
Riga 165 ⟶ 182:
"3": {
...
} <-- questo è
}
Riga 173 ⟶ 190:
Una volta finito di scrivere il codice bisogna premere "Salva". In caso di errori non sarà possibile salvare! <!-- così non potrete far danni. --> Per trovare l'errore nel codice si può usare il [[#Validazione codice JSON|codice JSON]] oppure scrivere sulla pagina [[Wikipedia:VisualEditor/Commenti|dei feedback su VisualEditor]] per chiedere aiuto.
== Modello vuoto ==
Questo è un modello vuoto, contenente solo i parametri più
<syntaxhighlight lang="javascript">
<templatedata>
{
},
}
},
"paramOrder": [
"1",
"2"
],
"format": ""
}
</templatedata>
Riga 198 ⟶ 220:
== Interfaccia visuale di TemplateData ==
[[File:Gestisci documentazione template.png
[[File:Gestisci documentazione template 3.png|right|border|430px]]
È disponibile un editor visuale di TemplateData direttamente nella pagina di modifica di Wikipedia. Vi si accede tramite il pulsante "Gestisci TemplateData" dopo aver cliccato su Modifica sorgente nella sottopagina che contiene o dovrà contenere i TemplateData, solitamente la sottopagina Template:NOMETEMPLATE/TemplateData
L'editor si presenta come una finestra dove sono presenti i parametri (se ve ne sono già) disposti su più linee, ognuna composta da sette caselle che permettono di impostare i relativi attributi di ogni parametro. Nell'esempio a destra è mostrato l'editor dei TemplateData del template {{Tl|Commons}} che corrisponde alla struttura:
Riga 223 ⟶ 245:
== Altri Editor ==
=== TemplateDataEditor ===
TemplateDataEditor è un semplice [[script]] (scritto in [[JavaScript]]) per "editare visivamente" TemplateData. L'originale è stato scritto per fr.wiki da [[:fr:Utilisateur:Ltrlg/scripts/TemplateDataEditor.js|Ltrlg]], ora disponibile per tutte le wiki.
Riga 259 ⟶ 281:
== Validazione codice JSON ==
Nel caso di un TemplateData particolarmente lungo può essere difficile scovare un errore e quindi capire perché non riusciamo a salvare la pagina. In questo caso può essere utile avere
== I template su cui lavorare ==
Sentitevi liberi di intervenire come volete su questa sezione per organizzare più agevolmente il lavoro. Questi non sono ''tutti'' i template di it.wiki, ma i primi 1000: di questi, i primi 300 sono usati ognuno in almeno diecimila pagine. Ovviamente, concentriamoci su quelli che funzionano soprattutto nel namespace delle voci e in quello Utente! Per valutare da dove iniziare, ci si potrebbe porre queste domande:
Riga 269 ⟶ 291:
Questo dovrebbe aiutarci a restringere inizialmente il campo. Inoltre, si possono momentaneamente saltare i template di navigazione. I link rossi possono essere ignorati. Grazie a Oliver (WMF) per aver generato questo elenco.
{{cassetto inizio
|titolo = Template cui aggiungere TemplateData, in ordine di utilizzo
}}
Quelli non segnati (
{| class="wikitable sortable"
Riga 284 ⟶ 304:
|2||[[Template:Portale]]||{{fatto}}
|-
|3||[[Template:
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|19||[[Template:-]]||{{nonfatto|nessun parametro}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|30||[[Template:Divisione amministrativa/Stemmi]] ||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|31||[[Template:Divisione amministrativa/Voci]] ||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|40||[[Template:Divisione amministrativa/Mappe speciali]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|78||[[Template:Nome disambigua]]||{{Non fatto|usato da Template:Disambigua}} nessun parametro
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|86||[[Template:Immagine commons]]||
|-
|87||[[Template:Str left]]||
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|120||[[Template:Navbox]]||
|-
|121||[[Template:Chiarimento]]||
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|136||[[Template:Naz/BEL]]||{{nonfatto|usato solo da altri template}}
|-
|137||[[Template:Divisione amministrativa/Voci/ITA]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|202||[[Template:Avvisocopyviol]]||{{fatto}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|235||[[Template:License migration announcement]]||
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|281||[[Template:Personaggio]]||{{Fatto}}
|-
|
|-
|
|-
|
|-
|285||[[Template:Divisione amministrativa/Voci/USA]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|295||[[Template:Divisione amministrativa/Stemmi/ESP]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|306||[[Template:Col-2]]||
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|348||[[Template:Marchio]]||{{fatto}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|372||[[Template:Divisione amministrativa/Stemmi/CZE]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|381||[[Template:Divisione amministrativa/Voci/CZE]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|387||[[Template:Videogioco/nomegenere]]||{{nonfatto|usato solo da Template:Videogioco}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|409||[[Template:Divisione amministrativa/Voci/IND]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|453||[[Template:It]]||
|-
|
|-
|
|-
|
|-
|457||[[Template:FIN]]||{{Non fatto}} nessun parametro
|-
|458||[[Template:Tassobox gruppo generico]]||
|-
|
|-
|
|-
|
|-
|462||[[Template:Goal]]||
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|477||[[Template:Squadra di calcio/Coppe del mondo per club]]||{{nonfatto|usato solo da altri template}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|492||[[Template:Squadra di calcio/Supercoppe Italiane]]||{{nonfatto|usato solo da altri template}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|501||[[Template:Playerhistory]]||
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|591||[[Template:Fiume]]||{{fatto}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|605||[[Template:Corpo celeste/Preposizione costellazione]]||{{nonfatto|usato solo da altri template}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|614||[[Template:Divisione amministrativa/Voci/ROU]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|627||[[Template:Divisione amministrativa/Voci/HUN]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|635||[[Template:Divisione amministrativa/Stemmi/CHE]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|648||[[Template:Notecancellazione]]||
|-
|649||[[Template:Recordicona]]||
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|688||[[Template:Prestazione]]||
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|694||[[Template:Divisione amministrativa/Stemmi/AUT]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|695||[[Template:Divisione amministrativa/Voci/AUT]]||{{nonfatto|usato solo da Template:Divisione amministrativa}}
|-
|
|-
|
|-
|698||[[Template:RichiestaCU]]||
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|783||[[Template:Copyright Nintendo]]||
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|791||[[Template:ComuniAmminPrecFine]]||{{Nonfatto}}, in quanto usato solo da un altro template
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|-
|
|}
{{Cassetto fine}}
== Pagine correlate ==
*[[Discussioni_progetto:Coordinamento/Template#Proposta_TemplateData|Coordinamento lavori]] presso il progetto Template
*[[mw:Help:TemplateData/it]]
*{{en}}[[mw:Help:TemplateData/en]]
[[Categoria:VisualEditor|TemplateData]]
| |||