Template:Template obsoleto/man
Il template di avviso oggetto del presente manuale ha lo scopo di segnalare che il template dove a propria volta viene apposto non deve più essere utilizzato, normalmente perché sostituito da un altro più aggiornato.
L'avviso va inserito nella pagina del template da dichiarare obsoleto, tra tag <noinclude>: esso viene categorizzato automaticamente nella categoria Template obsoleti da rimpiazzare oppure in Template obsoleti in archivio.
Sintassi
Sintassi base
{{Template obsoleto}}
Il risultato è:
Questo template è obsoleto. Per favore, non usarlo. |
Sintassi con indicazione del sostituto
Se è già stato individuato un nuovo template che sostituisca il vecchio, il suo nome senza il prefisso "Template:" va indicato come parametro:
{{Template obsoleto|nuovo template}}
Il risultato è:
Questo template è obsoleto. Per favore, usa {{nuovo template}} al suo posto. |
Esigenze d'archivio
A partire dal momento in cui un template viene bollato come obsoleto, va considerato da rimpiazzare (con un template o altro) o, quanto meno, da orfanizzare e eliminare. Se il template, per motivi di archivio, non va rimpiazzato nelle pagine in cui è già presente, è necessario aggiungere il parametro |archivio con un qualunque valore non nullo:
{{Template obsoleto|...|archivio=si}}
Il risultato è:
Questo template è obsoleto. Per favore, non usarlo. Va mantenuto solo nelle vecchie pagine in archivio. |
Aggiungere un commento
È anche possibile aggiungere una breve spiegazione direttamente nell'avviso, tramite il parametro |commento:
{{Template obsoleto|...|commento=bla bla bla}}
Il risultato è:
Questo template è obsoleto. Per favore, non usarlo. Commento: bla bla bla
Va rimpiazzato e, quando orfano, va messo in cancellazione immediata (criterio 19). |
Il parametro |commento può essere apposto indipendentemente dalla sintassi scelta (è, ad esempio, compatibile con |archivio).
Template da substare
Talvolta si può riformare il template in modo che semplicemente sostituendolo si ottenga il template suo successore. Se è sufficiente sostituire il template per ottenere il template nuovo, usa il parametro |subst= con un qualunque valore non nullo:
{{Template obsoleto|...|subst=si}}
Il risultato è:
Questo template è obsoleto. Per favore, non usarlo. Commento: bla bla bla N.B. Questo template è stato indicato come da sostituire per ottenere il template aggiornato.
Va rimpiazzato e, quando orfano, va messo in cancellazione immediata (criterio 19). |
Con questo parametro, il template è automaticamente inserito in Categoria:Template da sostituire, seguita da bot che periodicamente sostituiscono i template.
Per rendere sostituibile il vecchio template, il suo codice dev'essere rimpiazzato con un richiamo al nuovo template, ma se sono necessarie variabili e funzioni (come ad esempio #if) attenzione a Aiuto:Subst#Sostituzione a catena. Fate molte prove prima di dichiararlo sostituibile!
Template Template obsoleto di it.wiki: il materiale ivi presente è stato rielaborato in senso cattolico e integrato