Discussioni aiuto:Manuali dei template

Che nome usare?

Potremmo anche chiamarla "Manuali dei template", qui da noi è il termine più usato, lo dicono anche la categoria e lo stesso "man" --Bultro (m) 02:09, 2 giu 2010 (CEST)

Non è da perderci il sonno, però il manuale non è la documentazione di qualcosa. È solo un tipo di documentazione caratterizzato dalla "esposizione di notizie fondamentali" (vedi Treccani). Al momento non ci siamo posti limiti sulla quantità e qualità di informazioni da trattare in questa linea guida. Sono contrario, quindi, per ora, a una semplificazione forzata dell'argomento. --EH¹⁰¹{posta} 12:10, 2 giu 2010 (CEST)

Non è questione di cosa dice la Treccani, ma di quale gergo wikipediano usiamo noi per indicare una cosa. Non c'è "enciclopedicità" sulla Treccani... --Bultro (m) 20:30, 2 giu 2010 (CEST)

Documentazione è sicuramente più corretto e formale, ma qui in fondo tutti li conosciamo come manuali..oltretutto, parere personale, la parola documentazione mi fa venire in mente degli incartamenti cartacei generici, mentre manuale mi evoca proprio l'idea di una guida all'uso di qualcosa di tecnico come un template, ma questo è solo gusto personale :) --Number55★ (dopo il 54, prima del 56) ^{ratami tutto!} 21:36, 2 giu 2010 (CEST)

Amen. Vada per manuale. Ovviamente rimarrà agli atti questo minidibattito, e penso sarà utile, in quanto ci tengo a sottolineare che "il gergo", così come le sensibilità o i criteri, su WIkipedia cambiano. La lingua italiana, pure, ma non ogni due o tre anni. Se si vorrà un giorno o l'altro ricambiare nome, si potrà comunque farlo. Ogni tanto mi capita di leggere discussioni come queste, datate 2005 o 2006. Ciò che sembrava indiscutibile e incontrovertibile come convenzione, uso o consuetudine allora, adesso sembra vecchio e obsoleto in molti casi. Solo ciò che ha solide basi, mi sembra tenda a restare stabile. Nessun problema comunque. --EH¹⁰¹{posta} 11:51, 3 giu 2010 (CEST)

Giusto, se anche ora abbiamo deciso in un modo è ovvio che questo non può e non deve restare obbligatorio per tutti nei prossimi mesi o anni. Tutto resta in discussione com'è giusto che sia :) --Number55★ (dopo il 54, prima del 56) ^{ratami tutto!} 12:09, 3 giu 2010 (CEST)

Osservazione di metodo

Per rendere più "morbida" la linea guida, almeno in una fase di rodaggio, e non incappare in "avvitamenti burocratici", suggerisco laddove possibile di usare un tono "possibilista" e non perentorio. Per esempio:

«Per l'inserimento dei parametri fare riferimento al template "Parametro"»

a me suona meglio come

«Per l'inserimento dei parametri, si può fare riferimento al template "Parametro"»

È una variante minima, ma in un progetto che si basa sul consenso, suppongo che quando si propone inizialmente una linea guida, vada anche consentito a chi dissente un margine di elasticità iniziale. A parer mio, solo dopo una vasta e uniforme applicazione di uno standard, lo si può rendere di fatto semi-obbligatorio, pur nei limiti del consenso per i singoli casi, che ritengo sia comunque sovrano in tutte le decisioni in base ai pilastri. --EH¹⁰¹{posta} 11:58, 3 giu 2010 (CEST)

Si sono d'accordo, ancora non abbiamo deciso nulla di definitivo ed è giusto lasciare come dici te un tono "possibilista". Alla fine di tutto confido si riesca a redarre una guida più o meno obbligatoria almeno per raggiungere l'agognato obbiettivo di uniformazione dei manuali, ma per ora nulla è ancora deciso. Vado a correggere :) --Number55★ (dopo il 54, prima del 56) ^{ratami tutto!} 12:09, 3 giu 2010 (CEST)

Si, evitiamo di dare obblighi, anche perché usare TabellaTemplate ad esempio per {{sf}} sarebbe ridicolo --Bultro (m) 19:10, 3 giu 2010 (CEST)

mh..io sarei dell'idea di metterlo comunque..si magari è esagerato, ma almeno c'è uno standard per tutto..

gli esempi d'uso però quelli si che li mettiamo obbligatori no? --Number55★ (dopo il 54, prima del 56) ^{ratami tutto!} 19:47, 3 giu 2010 (CEST)

mmm io sono per la forza della persuasione e non dell'obbligo. "Fortemente consigliati" direi che è più indicato e aggiungerei pure un "laddove possibile". Ci sono casi, quali per esempio alcuni metatemplate, alcuni template di servizio, o alcuni template ausiliari, dove è pure difficile fare un esempio. --EH¹⁰¹{posta} 15:44, 4 giu 2010 (CEST)

Sisi beh certo, mi sono espresso male, è ovvio che non si obbliga nessuno :) Dici? mi faresti qualche esempio di questi template? --Number55★ (dopo il 54, prima del 56) ^{ratami tutto!} 21:29, 4 giu 2010 (CEST)

alcuni esempi per i quali è inutile o impossibile un esempio:{{Città/AFG}}, {{!}} e molti della categoria:Sottotemplate per esempio. Ce ne sono di cose strane in giro, per cui conviene comunque mantenersi flessibili. --EH¹⁰¹{posta} 01:19, 5 giu 2010 (CEST)

Categorizazzione

Per la categorizzazione dei manuali è più corretto scrivere {{BASEPAGENAME}} o {{PAGENAME}}? Perchè c'è differenza giusto?

PAGENAME comprende anche le sottopagine quindi male non fa. Anche un template in sottopagina potrebbe avere un manuale suo --Bultro (m) 19:10, 3 giu 2010 (CEST)

corretto --Number55★ (dopo il 54, prima del 56) ^{ratami tutto!} 19:47, 3 giu 2010 (CEST)

Parametro vs. Istruzioni per template

Scontro finale. Come anticipato in Discussioni template:TabellaTemplate, al momento abbiamo una incongruenza tra {{Parametro}} e {{Istruzioni per template}} che non richiamano la stessa convenzione di colori per codificare se un parametro è obbligatorio, consigliato, facoltativo. Ancora peggio, però, è il punto se si debba davvero utilizzare un "codice colori" per i parametri, quando tutte le norme sulla accessibilità sconsigliano di farlo (esistono i daltonici). A questo punto penso che non sia un caso che non abbia visto equivalenti nelle altre Wikipedia.
Mia proposta shocking: aboliamo entrambe le convenzioni colore. La obbligatorietà dei parametri venga indicata nel codice con qualcosa tipo: (legenda colori)

{{Infobox esempio
|Param1 = <!-- (O) -->
|Param2 =
|Param3 = <!-- (C) -->
|Param4 =
|Param5 =
}}

Se passasse questa riforma andrebbero modificati i template {{TabellaTemplate}} e {{Parametro}} per recepire la riforma, e magari aiutare nella aggiunta dei simboletti (O) = obbligatorio, (C) = consigliato, ecc. ecc. A prescindere dai due template di servizio, comunque la linea guida su come indicare i parametri obbligatori o facoltativi può e forse deve essere delineata, prima che dilaghi ulteriormente. Pareri ? --EH¹⁰¹{posta} 09:12, 9 giu 2010 (CEST)

Dunque, intato Gvf aveva proposto la, secondo me molto valida, idea dei tooltip. Per i colori, non sono d'accordo sull'abolirli completamente. Uniformarli sicuramente, ma abolirli no, in quanto anche un daltonico, pur non distinguendoli vede le differenze per colori così diversi. Non saprà che tipo di parametro ha davanti finchè non ci passa sopra con il mouse, ma almeno vede che c'è una differenza tra i parametri anzichè vederli tutti monocromatici. Del resto sono contrario al commento al parametro, e cito direttamente Gvf per dare l'idea:

«Personalmente sono contrario alla presenza dei commenti: poi va a finire che vengono copiati, lasciati nelle tabelle nelle voci e gli utenti inesperti vanno a scrivere il valori all'interno del commento con ovvi risultati.»

Riguardo alle due tabelle colori personalmente preferisco quella del template {{Parametro}}, ovvero:

• nero obbligatorio
• verde facoltativo
• blu altamente consigliato
• rosso non obbligatorio ma che accetta solo valori particolari o che da errore se compilato erroneamente.

--Number55★ (dopo il 54, prima del 56) ^{ratami tutto!} 11:23, 9 giu 2010 (CEST)

Ehm, rosso e verde sono proprio la coppia base che i daltonici non riconoscono. Mi spiego meglio: non apprezzano nessuna differenza di tinta o contrasto o altro, sono proprio identici per loro ed è il caso da manuale. Per la scelta dei colori, al limite va usata la accessibility color wheel e poi possiamo riparlarne.

Per quanto riguarda i commenti, dissento dal parere di Gvf. Personalmente penso sia il classico rischio di "buttare il bambino con l'acqua sporca": a fronte di un "possibile potenziale errore" commesso da un utente imbranato, si perde una comodità per tutti gli altri. Se l'utente inesperto si mette a scrivere nel commento, salvando scoprirà che quanto ha fatto non ha avuto effetto e si correggerà. La prova ? Fin quando qualcuno non mi porta un po' di esempi di voci nella quali ci sono dati abbandonati nel commento del parametro, chiaramente messi da chi non si rendeva contro di cosa faceva, non cambierò idea. Ho letteralmente lavorato stimo su migliaia di infobox con commenti su it.wiki e en.wiki: non ho mai visto un errore del genere. Non mi priverei della comodità di avere alcuni campi già precompilati o guidati, per aiutare gli imbranati irrecuperabili, non in grado di distinguere un commento da testo. Parere personale ovviamente. --EH¹⁰¹{posta} 12:17, 9 giu 2010 (CEST)

Vada per i commenti, esteticamente non mi piacciono ma in fondo se ritieni seriamente che non siano un danno non vedo perchè toglierli.

Per i colori ho provato a cercare una soluzione qui :) --Number55★ (dopo il 54, prima del 56) ^{ratami tutto!} 16:28, 9 giu 2010 (CEST)

Dobbiamo proprio discutere la stessa cosa in due posti? --Bultro (m) 20:00, 9 giu 2010 (CEST)

No infatti, direi di continuare qua. Ho segnalato la discussione sul wikipediano :) --Number55★ (dopo il 54, prima del 56) ^{ratami tutto!} 00:46, 12 giu 2010 (CEST)

Ho aggiunto le tooltip come nell'esempio di Gvf (male non fanno in ogni caso). Per me è sufficiente per la questione leggibilità --Bultro (m) 14:32, 12 giu 2010 (CEST)

@EH101: ti posso assicurare che in moltissimi casi i principianti mettono i dati dentro i commenti e li lasciano li. Questo succede sopratutto nei casi in cui nei commenti c'è un dato di esempio. E comunque andiamo ad aggiungere alle pagine byte fondalmentalmente inutili visto che sono una ripetizione del manuale del template. Se proprio si vuol aggiungere qualcosa coi commenti piuttosto metterei prima del codice del template un richiamo alla pagina del manuale. Gvf 14:44, 12 giu 2010 (CEST)

Ho sistemato il mio template. Ora può funzionare sia come spiegazione dei parametri, sia per mostrare gli esempi, con a sinistra codice e destra esempio. Resta però il fatto che bisogna fare un uso massiccio di <nowiki> per ogni riga di parametro. Volendo si potrebbe creare un mini template apposito, per esempio {{Parametroesempio}}, che funziona in linea di massima come {{Parametro}} ma evita di mettere il <br> subito dopo il simbolo di uguale. Non lo so...così com'è ora come template per gli esempi d'uso è inutile: ci vogliono molti più caratteri così che a fare un esempio normalmente. Ditemi voi..

Ditemi anche cosa ne pensate dei codici colori alternativi per daltonici che ho studiato (qui)--Number55★ (dopo il 54, prima del 56) ^{ratami tutto!} 18:53, 12 giu 2010 (CEST)

Gvf: l'idea è infatti di metterci commenti e non dati, e senza esagerare. Non confondiamoci con i template gonfi di commenti che vennero piazzati anni fa dai bot. Ne ho usato qualcuno in Template:Luogo fittizio ad esempio.

Number55: ma non possiamo semplicemente mettere l'esempio di fianco a un normale TabellaTemplate, più o meno così?

Bla luogo fittizio
Creazione
Ideatore	Bla
Apparizioni	Bla
Caratteristiche immaginarie
Tipo	Bla

(legenda colori)

{{Luogo fittizio
|nome =
|tipo =
|ideatore =
|opere =
}}

L'unica cosa che manca è poter dare un valore ai parametri.

Quanto ai colori, non mi sembra il caso di usare colori poco intuitivi, confondendo il 99,99% degli utenti, per il bene del 0,01% --Bultro (m) 20:10, 12 giu 2010 (CEST)

Bultro, è quello che sto cercando di fare ;) Per la spiegazione da una parte i parametri e dall'altra la spiegazione; per gli esempi da una parte i parametri con i valori e dall'altra il risultato (ad esempio). Sono dell'idea che siano necessari tutti e due, quindi (salvo casi eccezionali) tabella di spiegazione dei parametri ed esempio di utilizzo fortemente consigliati :)

Per i colori, ormai che l'abbiamo tirato in ballo vediamo di trovare una soluzione :) I tooltip sono secondo me un'ottima idea, per i colori non so più che pensare. L'hai visto come gli attuali colori sono visti dai daltonici? È un casino...--Number55★ (dopo il 54, prima del 56) ^{ratami tutto!} 21:28, 12 giu 2010 (CEST)

Mi riferivo al come farlo: proprio con il semplice codice che ho inserito sopra. Non c'è bisogno di cose complicate.--Bultro (m) 13:56, 13 giu 2010 (CEST)

I colori e il template di istruzioni ridondante

Informo che, almeno dai manuali dei template dei quali conosco l'uso, ho intenzione di procedere a rimuovere il template {{Istruzioni per template}} che illustra il codice colori. I colori per parametri obbligatori, facoltativi o altro, mi sembrano ben lungi dallo stabilizzarsi e penso che un passo indietro sia utile. Se siete d'accordo "orfanizziamo" il template "istruzioni per template" in modo più radicale, per mantenere in un'unica discussione la messa a punto della "codifica colori". --EH¹⁰¹{posta} 09:36, 23 giu 2010 (CEST)

Sono d'accordo, tanto alla fine usiamo sempre la legenda colori di {{Parametro}}, sulla quale sono studiati pure i tooltip di Gvf --Number55★ (dopo il 54, prima del 56) 11:55, 23 giu 2010 (CEST)

+1 e penso che si possa togliere il wikibozza, la pagina dice cose ormai scontate e non dà obblighi --Bultro (m) 12:58, 23 giu 2010 (CEST)

Nuovo template {{TabellaTemplate}}

In realtà non è nuovo, ripropongo quello che avevo studiato. Cerchiamo di completarlo e, se piace, vedere di sostituirlo all'attuale {{TabellaTemplate}} :) --Number55★ (dopo il 54, prima del 56) ^{No alla legge bavaglio che limita Wikipedia} 12:35, 6 lug 2010 (CEST)

tl

non so se è giusto indicare la forma {{nome}} nell'elenco dei template correlati. Di solito si preferisce Template:Nome (forse per uniformità con gli altri tipi di pagine correlate... è stato fatto così anche in questa stessa pagina!)--Bultro (m) 20:05, 6 lug 2010 (CEST)

Dici? Non so, a me piace il Template:tl, anche se forse effettivamente indicando Template: si capisce subito che è un template anche per i neofiti...vorrei sentire qualche altro parere, ma mi va bene anche l'uso di Template:Nome :) --Number55★ (dopo il 54, prima del 56) ^{No alla legge bavaglio che limita Wikipedia} 23:16, 6 lug 2010 (CEST)

Io in genere sono favorevole ai niubbi, ma forse alla fine quando uno arriva qui è bene che abbia capito cosa è un template e forse la forma così potrebbe aiutare a memorizzare il nome. Comunque adesso mi guardo tutta la pagina e se ne discute ancora--Pierpao.lo (listening) 00:10, 11 nov 2010 (CET)

Mah, forse preferirei Template:Nome. --Azrael 00:25, 11 nov 2010 (CET)

Anche io ho cambiato idea meglio il collegamento classico. Come era scritto più volte nella pagina i template sono ostici e già non è banale capire che sono comunque una pagina da includere se gli diamo anche un link diverso... Poi visto che si parla di manuali che i link siano un invito a visitarli e non a copiaincollarli senza leggerli.--Pierpao.lo (listening) 02:08, 11 nov 2010 (CET)

Wikipedia:Voci correlate, che è la policy iù vicina a questo argomento, dice chiaramente "Devono essere impostate come wikilink, ossia devono essere incluse in doppie parentesi quadre. Il nome completo delle voci non deve essere nascosto, nemmeno se queste contengono parentesi o namespace;" --Uno nessuno e 100000 (msg) 08:38, 12 nov 2010 (CET)

Ricerca del consenso per la policy

Si discute e si cerca consenso sulla promulgazione di questa linea guida al Bar Template

--Number55★ (dopo il 54, prima del 56) 10:27, 16 set 2010 (CEST)

Come si presenta una pagina di template

Vorrei che rifletteste su una questione che avevo posto diverso tempo fa. Normalmente, un template viene presentato con se stesso in testa. Per capire cosa dico, guardate la versione di {{template obsoleto}} di tempo fa: eccola. Guardate la versione attuale. Nel caso di obsoleto, di primo acchito mi sembra di capire che il template è esso stesso obsoleto. La resa grafica andrebbe sempre inserita in una sezione standard, il cui titolo non lasci dubbi. È facile capire che il giorno che {{template obsoleto}} verrà sostituito da, mettiamo, {{obsoleto}}, quest'ultimo andrà messo in testa al primo, con il risultato che le nostre menti saranno messe a dura prova. Detto in due parole: l'inizio di una pagina di template dev'essere il man, non la resa grafica. Questo genere di paradosso l'ho visto anche a proposito di altri template, per cui se il solo esempio di obsoleto non convince, sono pronto a cercare altri casi. Infine, torno a segnalare questa griglia base degli spagnoli. --Pequod76^(talk) 18:00, 21 ott 2010 (CEST)

Ci sono però alcune considerazioni da fare. I template bloccati, hanno bloccato il contenuto (la resa grafica), mentre hanno libero il manuale. Non tutti i template, poi, hanno una resa grafica simile ad un avviso. Gli infobox, per esempio, non hanno nessuna controindicazione nel far precedere la "resa grafica", in realtà un aiuto al debugging, al manuale. Non ne farei una linea guida, il divieto di presentare la resa grafica e rimandare tutto ad esempi a fondo pagina del manuale: il debugging è importante. --EH¹⁰¹{posta} 22:19, 21 ott 2010 (CEST)

Io preferisco che si veda la resa grafica. Chiarisce subito chi è il soggetto, e in genere non fa il minimo problema. Si nasconda in casi particolari come Template_obsoleto se si ritiene necessario (io comunque non lo ritengo necessario, se uno è sveglio almeno al livello di mia nonna capisce subito la situazione) --Bultro (m) 23:34, 21 ott 2010 (CEST)

Naturalmente mi riferisco solo ai tmp d'avviso e, in genere, a tutti quelli che si presentano come un banner et similia. Non dico di non presentare la "resa grafica" ma di collocarla opportunamente. Se non erro, il principale ostacolo era l'inclusione, la sua collocazione. Credo che per "obsoleto" risolsi spostando tutto al man. Perdonatemi, non ricordo bene. Se mi capita di trovare un caso clamoroso, ve lo indico. L'ultimo lo notai su enW e mi risulta un po' ostico rintracciarlo. Certamente voi vi rendete conto meglio dei retroscena tecnici di queste scelte. Il mio è più un feedback sul piano "pedagogico", di "interfaccia": anche se ci si fa l'abitudine, questa di posporre il man la trovo una prassi non proprio esaltante. Grazie e buone cose! --Pequod76^(talk) 16:33, 22 ott 2010 (CEST)

Io son d'accordo con Bultro. Anche perchè è meno facile gestire i template inseriti nel man, talvolta è necessario substarli onde evitare errate categorizzazioni.--LikeLifer (msg) 22:33, 19 gen 2012 (CET)

Sbozzo

Ho iniziato a sbozzare, sempre che qualche patroller troppo diligente non riannulli di nuovo, se va bene continuo domani altrimenti rollbaccate. Grazie--Pierpao.lo (listening) 00:26, 11 nov 2010 (CET) In effetti avevo infilato più strafalcioni del solito. Se ne è rimasto qualcuno causa l'ora tarda scusate--Pierpao.lo (listening) 01:32, 11 nov 2010 (CET)

Io avrei qualche remora sull'utilizzo di <code> nella sezione degli esempi d'uso. Io di solito utilizzo <pre>. Vedi ad esempio Template:Provincia canadese/man o Template:Federazione sportiva/man. -- Sannita - L'admin (a piede) libero 21:53, 14 dic 2010 (CET)

In effetti sono diffuse entrambi metodi. Più che decidere per uno fisso direi di lasciare la possibilità di scelta, tanto nessuno dei due metodi reca danno alla leggibilità. --Number55★ (dopo il 54, prima del 56) 10:52, 10 apr 2011 (CEST)

Invece si... <pre> può fare casino, e lo si vede in questa stessa pagina, almeno a risoluzione 1024x768 (che non è certo rara): l'esempio di codice si sovrappone all'esempio di risultato. Meglio sconsigliarlo. Inoltre si può usare {{TabellaTemplate}} anche per gli esempi --Bultro (m) 16:12, 11 apr 2011 (CEST)