Wikipedia:VisualEditor/TemplateData: differenze tra le versioni

Versione delle 20:43, 12 ott 2018

Versione delle 21:17, 12 ott 2018

Riga 11:

[[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 36:

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

== La struttura di TemplateData ==

La struttura di TemplateData è basata sullo standard "[[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, così:

Riga 77:

== 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 un [[backslash]], 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:

:::*"''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 189:

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

<syntaxhighlight lang="javascript">

Riga 197:

"params": {

"1": {

"label": "",

"label": "",

"description": "",

"type": "",

"description": "",

"required":

"type": "",

"required":

},

"2": {

"label": "",

"label": "",

"description": "",

"type": "",

"description": "",

"required":

"type": "",

"required":

}

}

Riga 239 ⟶ 247:

== 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 277 ⟶ 285:

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 un ''tool'' per validare il codice. È disponibile all'indirizzo [http://jsonlint.com/ JSONLint].

== 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 1 974 ⟶ 1 982:

{{Cassetto fine}}

== Pagine correlate ==

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

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