Wikipedia:VisualEditor/TemplateData: differenze tra le versioni

Versione delle 10:47, 22 gen 2018

Versione attuale delle 23:54, 6 mag 2025

(28 versioni intermedie di 16 utenti non mostrate)

Riga 1:

{{Abbreviazioniabbreviazioni|WP:TD}}

{{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 o /man del template stesso).

</div>

{| style="background:#CDFFCD"

| [[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 o /man del template stesso).

|}

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!

Riga 11 ⟶ 9:

[[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 unaun'apposita [[Aiuto:Sottopagina|sottopagina]] del template, chiamata <kbd>Template:NOMETEMPLATE/TemplateData</kbd>, adcome per esempio [[Template:Azienda/TemplateData]].

La sottopagina va richiamata nella pagina base del template, inserendo il template {{tl|TemplateData}} nella parte compresa tra '''<nowiki><{{tag|noinclude></noinclude></nowiki>'''}}, alla riga dopo {{tl|man}}.

All'inizio della sottopagina va invece inseritoinserita la stringa <kbdcode><nowiki><noinclude>{{TemplateData sottopagina}}</noinclude></nowiki></kbdcode>, che ha anche il compito tra l'altro di far comparire la sottopaginaincluderla 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}}.

All'inizio della sottopagina va invece inserito <kbd><nowiki><noinclude>{{TemplateData sottopagina}}</noinclude></nowiki></kbd>, che ha il compito tra l'altro di far comparire la sottopagina nella [[:Categoria:TemplateData]].

Nel caso la pagina base del template è [[Wikipedia:Politica di protezione delle pagine|protetta]], è possibile scrivere temporaneamente il codice di TemplateData nella sottopagina del manuale chiamata <kbd>Template:NOMETEMPLATE/man</kbd> prima di <nowiki><noinclude></noinclude></nowiki>. Se il template e il relativo TemplateData sono pesanti, il caricamento in VisualEditor saràrisulterà lento,. perPer questo si consiglia di scrivere TemplateData in una sottopagina a parte. Se il TemplateData è stato scrittorichiamato neldal manuale (perchèperché il template è protetto e non si hanno i permessi per modificarlo) si consiglia di indicareindicarlo nella pagina di discussione del template, dicosì [[Aiuto:Sposta|spostare]]che ilun codiceamministratore nellaprovveda sottopaginaa appropriata,spostare compitoil chetemplate verrà svolto da un amministratore{{tl|TemplateData}}.

Potrebbe volerci del tempo, (anche molte ore,) prima che il template risulti effettivamente aggiornato e quindi correttamente visibile e utilizzabile con VisualEditor. Per bypassareforzarne l'attesaaggiornamento si può effettuare un [[Aiuto:Modifica#Modifiche fittizie|null edit]] sul template stesso.

== La struttura di TemplateData ==

La struttura di TemplateData è basata sullo standard "[[JavaScript Object Notation|JSON]]", ed è abbastanza semplice. La prima cosa da fare è inserire un paio di tag <nowiki><templatedata></nowiki> in un punto del manuale del template che abbiamo scelto,questo cosìmodo:

<pre>

Riga 77 ⟶ 78:

== Codice ==

Passiamo alla spiegazione del codice. Le [[virgolette]], i [[due punti]], le [[Virgola|virgole]] e le [[Parentesi#Le_parentesi_graffeLe parentesi graffe|parentesi graffe]] sono elementi importanti del codice di TemplateData e sono da '''non''' modificare. Se si vuolevogliono inserire le virgolette nella descrizione del template (o di un parametro) è necessario scrivere ogni virgoletta preceduta da ununa [[backslashbarra rovesciata]], esempio <code>\"testo\"</code>.

*"'''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, da non modificare.

:*In ogni sottosezione, il primo '''tag''' è quello del nome effettivo del parametro del template "per come è richiamato nel template",: se il parametro si chiama <code>titolo=</code>, il tag sarà "titolo" (se si chiama <code>anno=</code>, il tag sarà "anno", ecc.). NelNei casi in casocui i parametri del template non hanno un nome ma sono riconosciuti per la loro posizione nel template (vedi per esempio [[Template:Santiebeati]]), si devono indicare i numeri ("1", "2", ecc.) come nell'esempio del paragrafo precedente (dove l'unico parametro di template:Commons è <code>"1"</code>). NelIn caso non ci siano parametri vedi più avanti.

::*"'''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'', (se la presenza di quel parametro è obbligatoria in quel template), o ''false'' (nel caso contrario (''false'' è il valore di default).

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 143 ⟶ 144:

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 emplicementesemplicemente aggiungere il valore automatico alle informazioni del parametro:

Dovrai, probabilmente, utilizzare <code>subst:</code> per rendere i valori fissi:

Riga 189 ⟶ 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ù comuniutilizzati, per aggiungere TemplateData "fatti a mano" ancora più facilmente!

<syntaxhighlight lang="javascript">

<templatedata>

{

"description": "",

"params": {

"1": {

"label": "",

"description": "",

"type": "",

"required":

},

},

"2": {

"label": "",

"description": "",

"type": "",

"required":

}

}

},

}

"paramOrder": [

"1",

"2"

],

"format": ""

}

</templatedata>

Riga 214 ⟶ 220:

== Interfaccia visuale di TemplateData ==

[[File:Gestisci documentazione template.png|left|130px]]

[[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 o eccezionalmente Template:NOMETEMPLATE/man.

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 239 ⟶ 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 275 ⟶ 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 undei ''tool'' per validare il codice. ÈSono disponibiledisponibili all'indirizzoagli indirizzi [http://jsonlint.com/ JSONLint] e [https://www.jsonformatting.com/ JSON Formatter] .

== 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 285 ⟶ 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.

Esiste anche una pagina con una lista dove è possibile inserire i template ai quali è stato aggiunto il TemplateData: [[Wikipedia:VisualEditor/TemplateData/Template completati]].

{{cassetto inizio

|titolo = Template cui aggiungere TemplateData, in ordine di utilizzo

}}

Quelli non segnati (nèné con "fatto" nèné "non fatto") sono da considerare come '''da fare'''. Per quelli "protetti" (indicati con "in corso") che non hanno il /man,manuale (oppure non è editabile,) è richiesto l'intervento di un admin.

{| class="wikitable sortable"

Riga 660 ⟶ 664:

|182||[[Template:Corpo celeste/Calcolato]]||{{nonfatto|usato solo da altri template}}

|-

|183||[[Template:Non firmato]]||{{fatto}}

|-

|184||[[Template:Naz/ZAF]]||{{nonfatto|usato solo da altri template}}

Riga 666 ⟶ 670:

|185||[[Template:Naz/FIN]]||{{nonfatto|usato solo da altri template}}

|-

|186||[[Template:Demografia]]||{{fatto}}

|-

|187||[[Template:PD-Utente]]||

Riga 702 ⟶ 706:

|203||[[Template:Cancellazione/avvisoutente]]||{{nonfatto|usato solo da altri template}}

|-

|204||[[Template:Cita]]||{{fatto}}

|-

|205||[[Template:Naz/NOR]]||{{nonfatto|usato solo da altri template}}

Riga 1 216 ⟶ 1 220:

|460||[[Template:GRC]]||{{nonfatto|nessun parametro}}

|-

|461||[[Template:BloccoInfinito]]||{{fatto}}

|-

|462||[[Template:Goal]]||

Riga 1 406 ⟶ 1 410:

|555||[[Template:AggNaz/Italia]]||{{nonfatto|usato solo da altri template}}

|-

|556||[[Template:Infobox stazioneStazione ferroviaria]]||{{fatto}}

|-

|557||[[Template:Nf]]||{{Non fatto|va nella pagina di discussione}}

Riga 1 464 ⟶ 1 468:

|584||[[Template:Naz/Russia]]||{{nonfatto|usato solo da altri template}}

|-

|585||[[Template:Infobox conflittoConflitto]]||{{fatto}}

|-

|586||[[Template:Commento]]||

Riga 1 476 ⟶ 1 480:

|590||[[Template:Coll]]||{{Fatto}}

|-

|591||[[Template:Infobox fiumeFiume]]||{{fatto}}

|-

|592||[[Template:HRV]]||{{nonfatto|nessun parametro}}

Riga 1 610 ⟶ 1 614:

|657||[[Template:Naz/CIV]]||{{nonfatto|usato solo da altri template}}

|-

|658||[[Template:Infobox aeromobileAeromobile/colore]]||{{nonfatto|usato solo da Template:Infobox aeromobileAeromobile}}

|-

|659||[[Template:Infobox aeromobile]]||{{Fatto}}

|-

|660||[[Template:Naz/GHA]]||{{nonfatto|usato solo da altri template}}

Riga 1 622 ⟶ 1 626:

|663||[[Template:StagioniTV/Elenco]]||{{nonfatto|usato solo da Template:StagioniTV}}

|-

|664||[[Template:Torneo-tennis- semifinali 3-3]]||

|-

|665||[[Template:MEX]]||{{nonfatto|nessun parametro}}

Riga 1 698 ⟶ 1 702:

|701||[[Template:BGR]]||{{nonfatto|nessun parametro}}

|-

|702||[[Template:Infobox isola/Categorie]]||{{nonfatto|usato solo da Template:Infobox isola}}

|-

|703||[[Template:Infobox isolaIsola]]||{{Fatto}}

|-

|704||[[Template:Naz/QAT]]||{{nonfatto|usato solo da altri template}}

Riga 1 730 ⟶ 1 734:

|717||[[Template:User]]||{{nonfatto|redirect a Template:Utente}}

|-

|718||[[Template:StagioniTV]]||{{fatto}}

|-

|719||[[Template:StagioniTV/Nomealt]]||{{nonfatto|usato solo da Template:StagioniTV}}

Riga 1 794 ⟶ 1 798:

|749||[[Template:Problematico/segnalazione]]||

|-

|750||[[Template:Infobox stazioneStazione della metropolitana]]||{{Fatto}}

|-

|751||[[Template:Problematico]]||

Riga 1 962 ⟶ 1 966:

|833||[[Template:Evento olimpico]]||{{fatto}}

|-

|834||[[Template:IPcondiviso]]||{{Nonfattofatto}}, in quanto usato solo nelle pagine di discussione utente

|-

|835||[[Template:NFLS]]||{{Fatto}}

Riga 1 974 ⟶ 1 978:

{{Cassetto fine}}

== Pagine correlate ==

*[[Discussioni_progetto:Coordinamento/Template#Proposta_TemplateData|Coordinamento lavori]] presso il progetto Template

*[[mw:Help:TemplateData/it]]