Predefinição:Predefinição obsoleta
Esta predefinição marca uma predefinição como obsoleta, o que significa que seu uso deixou de ser recomendado, embora ela possa continuar funcionando para manter a compatibilidade com páginas antigas.
A marca de {{Predefinição obsoleta}} também pode indicar uma predefinição substituta ou um procedimento alternativo e, quando desejado, rastrear as páginas que ainda utilizam o método obsoleto.
Antes de marcar como obsoleta uma predefinição de uso relevante, recomenda-se discutir a alteração na página de discussão correspondente ou no café dos programadores.
Uso
A chamada a {{Predefinição obsoleta}} deve ser colocada preferencialmente no código da própria predefinição obsoleta. Isso é necessário quando se deseja rastrear suas transclusões. A subpágina /doc pode conter informações mais detalhadas sobre a obsolescência e a migração.
Ao marcar, prefira o uso dos parâmetros nomeados. Eles tornam explícito o significado de cada valor e são especialmente importantes quando o rastreamento das transclusões estiver ativado.
Informe os nomes das predefinições sem o prefixo Predefinição:.
Com uma predefinição substituta
Quando uma predefinição foi substituída diretamente por outra, informe o nome da antiga e da nova:
<noinclude>
{{Predefinição obsoleta
|antiga= Exemplo antigo
|nova = Exemplo novo
}}
</noinclude>
O aviso resultante informa que a predefinição antiga está obsoleta e recomenda o uso da nova. Por exemplo, o código acima produz uma mensagem equivalente a:
- A predefinição
{{Exemplo antigo}}está obsoleta. No lugar dela, favor usar{{Exemplo novo}}.
Sem uma substituta direta
Uma predefinição pode tornar-se obsoleta sem que exista outra predefinição que desempenhe exatamente a mesma função. Nesses casos, informe apenas |antiga= e, se necessário, use |nota= para explicar a situação:
<noinclude>
{{Predefinição obsoleta
|antiga= Predefinição antiga
|nota = Esta predefinição não deve mais ser utilizada por tal e tal motivo.
}}
</noinclude>
Procedimento alternativo
Quando a alternativa não for outra predefinição, o terceiro parâmetro posicional (ou |3=) permite completar diretamente a frase padrão «No lugar dela, favor usar ...»:
{{Pobsoleta|Predefinição antiga||um procedimento alternativo}}
{{Pobsoleta
|antiga = Predefinição antiga
|3 = um procedimento alternativo}}
Use |nota= em vez de |3= quando o texto pretendido não puder ser redigido naturalmente como continuação dessa frase.
Parâmetros posicionais
As formas posicionais anteriores continuam disponíveis por compatibilidade:
{{Pobsoleta|Nova predefinição}}
{{Pobsoleta|Predefinição antiga|Nova predefinição}}
{{Pobsoleta|3=procedimento alternativo}}
Quando apenas o primeiro parâmetro é informado, ele representa a predefinição substituta. Quando o segundo parâmetro também é preenchido, o primeiro passa a representar a predefinição obsoleta e o segundo, a substituta.
Para usos novos, prefira |antiga= e |nova=.
Categorias de rastreamento
Normalmente, a predefinição deve ser colocada entre as tags <noinclude> e </noinclude>. Nesse caso, o aviso aparecerá na página da predefinição obsoleta, mas seus usos não serão rastreados.
<noinclude>
{{Predefinição obsoleta|antiga=Predefinição antiga|nova=Nova predefinição}}
</noinclude>
Para localizar automaticamente as páginas que ainda utilizam a predefinição, coloque a chamada fora de <noinclude>.
Nesse modo, o aviso visual continua aparecendo somente na própria predefinição obsoleta. As páginas que a transcluem são categorizadas silenciosamente em:
- Categoria:!Predefinições que usam predefinições obsoletas, no domínio Predefinição, especificamente;
- Categoria:!Páginas que usam predefinições obsoletas, nos demais domínios.
A própria predefinição obsoleta será incluída em Categoria:!Predefinições obsoletas.
Ao ativar o rastreamento, informe sempre | ou use a forma posicional com os nomes da predefinição antiga e da nova. A forma curta {{Pobsoleta|Nova}} não identifica a predefinição de origem quando é transcluída por outra predefinição.
O parâmetro |semcat=sim suprime a categorização automática. Destina-se principalmente a testes, exemplos e outros casos em que as categorias de manutenção não devam ser adicionadas.
Parâmetros
Marca uma predefinição como obsoleta e, opcionalmente, indica sua substituta e rastreia as páginas que ainda a utilizam.
| Parâmetro | Descrição | Tipo | Estado | |
|---|---|---|---|---|
| Predefinição antiga | antiga | Nome da predefinição obsoleta, sem o prefixo «Predefinição:».
| String | sugerido |
| Nova predefinição | nova | Nome da predefinição substituta, sem o prefixo «Predefinição:».
| String | sugerido |
| Nota | nota | Texto livre acrescentado ao final do aviso. | Conteúdo | opcional |
| Suprimir categorias | semcat | Se preenchido, impede a categorização automática. Útil em testes e exemplos. | Booliano | opcional |
| Primeiro parâmetro posicional | 1 | Substituta quando usado sozinho; se o parâmetro 2 estiver preenchido, indica a predefinição antiga. | String | opcional |
| Segundo parâmetro posicional | 2 | Nome da predefinição substituta. | String | opcional |
| Procedimento substituto | 3 | Texto livre usado após «No lugar dela, favor usar». Tem prioridade sobre os demais modos de indicar a substituição. | Conteúdo | opcional |