Istruzioni per l'usoLe istruzioni che seguono sono contenute nella sottopagina Template:Template obsoleto/man (modifica · cronologia)
Sandbox: Template:Template obsoleto/Sandbox (modifica · cronologia) · TemplateStyles: Template:Template obsoleto/styles.css (modifica · cronologia) · Tutte le sottopagine: lista
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>…</noinclude>: esso viene categorizzato automaticamente nella categoria Template obsoleti da rimpiazzare oppure in Template obsoleti in archivio.
Sintassi
Sintassi base
((Template obsoleto))
Il risultato è:
Con la sintassi base, il template è automaticamente inserito in Categoria:Template da orfanizzare e cancellare.
Sintassi con indicazione del sostituto
Se è già stato individuato un nuovo template che sostituisca il vecchio, il suo nome senza il prefisso "Template:" deve essere inserito nel primo parametro:
((Template obsoleto|nuovo template))
Il risultato è:
Con questo parametro, il template è automaticamente inserito in Categoria:Template obsoleti da rimpiazzare.
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=sì))
Il risultato è:
Con questo parametro, il template è automaticamente inserito in Categoria:Template obsoleti in 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 è:
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. Tuttavia, se sono necessarie variabili, funzioni parser (come ad esempio #if) o chiamate a moduli Lua, attenzione a Aiuto:Subst#Sostituzione a catena. Fate molte prove prima di dichiararlo sostituibile!
Aggiungere un commento
È anche possibile aggiungere una breve spiegazione direttamente nell'avviso, tramite il parametro |commento:
((Template obsoleto|...|commento=bla bla bla))
Il risultato è:
Il parametro |commento può essere apposto indipendentemente dalla sintassi scelta (è, ad esempio, compatibile con |archivio).