Predefinição:Aviso/Testes com predefinições/doc

Esta é uma subpágina de documentação para Predefinição:Aviso/Testes com predefinições (Clique na ligação se você quer vê-la diretamente).
Ela contém informações sobre o uso, categorias e outros conteúdos que não são parte da predefinição propriamente dita.

Esta é a predefinição {{Aviso/Testes com predefinições}}.

Ela pode ser colocada nas páginas de teste das predefinições. Ela também detecta quando ela não está em uma destas páginas de testes para que, neste caso, nada seja exibido. Deste modo, ela pode ser deixada no código quando copiada e colada na predefinição principal. (Em geral o aviso é removido quando se faz a colagem a partir do teste para a predefinição principal, mesmo assim esteja atento para o caso em que o parâmetro exibir-fora-dos-testes seja usado, pois então o aviso deve ser copiado juntamente com o restante do código da predefinição. Veja detalhes mais adiante.)

Para aprender mais sobre como usar as páginas de teste das predefinções juntamente com os exemplos para testes, veja Wikilivros:Exemplos para testes‎ .

Exemplo simples

editar
[-- Código da predefinição --]<noinclude>
{{Aviso/Testes com predefinições}}
</noinclude>

Note! O código da predefinição deve começar imediatamente antes e literalmente encostar na marcação <noinclude>. Qualquer espaço em branco ou quebra de linha entre o código da predefinição e a marca <noinclude> pode fazer com que a predefinição renderize espaços ou quebras de linha indesejáveis quando for utilizada.

Páginas de teste e de exemplos com nomes não convencionais

editar

Esta predefinição assume que as páginas de teste utilizam o nome "/Testes", com a todas as letras em minúsculas, exceto a primeira.

Se a página de testes de uma predefinição estiver sob um título diferente, como por exemplo "/Caixa de areia", então você precisará informar o nome correspondente, para que esta predefinição saiba quando ela deve e quando não deve exibir a si mesma. Isto pode ser feito da seguinte maneira:

[-- Código da predefinição --]<noinclude>
{{Aviso/Testes com predefinições|subpágina-de-testes = Caixa de areia}}
</noinclude>

Se a página com os exemplos para testes da predefinição tiver um nome diferente de "/Exemplos para testes", ele poderá ser especificado com o parâmetro subpágina-de-testes:

[-- Código da predefinição --]<noinclude>
{{Aviso/Testes com predefinições|subpágina-de-exemplos = Exemplos}}
</noinclude>

No caso de haver apenas uma página de testes ou página de exemplos para certa predefinição principal, tem-se a opção de simplesmente mover a página de testes para o nome padrão "/Testes", ou a página de exemplos para "/Exemplos para testes". Isto pode ser preferível pois outras predefinições também assumem que os nomes usuais são utilizados, como por exemplo a {{Documentação}}

Exibindo e ocultando outras coisas

editar

O aviso para testes com predefinições pode ajudar também a exibir ou ocultar informações dependendo dele estar ou não na página "/Testes". Eis um exemplo:

[-- Código da predefinição --]<noinclude>
{{Aviso/Testes com predefinições |exibir-nos-testes = Texto a ser exibido na página "/Testes". |exibir-fora-dos-testes = Texto a ser exibido em outras páginas. }} <!-- O texto para todas as páginas vai aqui --> </noinclude>

Exemplo de predefinições protegidas

editar

O parâmetro exibir-fora-dos-testes pode ser usado por exemplo para poder incluir uma predefinição para páginas protegidas diretamente na versão "/Testes" da página. (Veja também a política de proteção de páginas).

Exemplo:

[-- Código da predefinição --]<noinclude>
{{Aviso/Testes com predefinições |exibir-fora-dos-testes = {{Nome da predefinição que indica uma página protegida|alguns parâmetros}} }} </noinclude>

Exemplo de documentação

editar

Algumas predefinições possuem sua documentação na subpágina /doc correspondente e exibem tal documentação em uma caixa (verde) abaixo do código da predefinição. Isto é feito com a inserção da predefinição {{Documentação}}. Veja também Template documentation. Nestes casos, pode-se colocar o aviso da seguinte maneira:

[-- Código da predefinição --]<noinclude>
{{Aviso/Testes com predefinições}} {{Documentação}} <!-- ADICIONE CATEGORIAS E INTERWIKIS NA SUBPÁGINA /doc --> </noinclude>


Super exemplo deluxe

editar

Neste exemplo são exibidos tanto a predefinição para páginas protegidas quanto a documentação disponível na página "/doc":

[-- Código da predefinição --]<noinclude>
{{Aviso/Testes com predefinições |exibir-nos-testes = Texto a ser exibido na página "/Testes". |exibir-fora-dos-testes = {{Nome da predefinição que indica uma página protegida|alguns parâmetros}} }} {{Documentação}} <!-- ADICIONE CATEGORIAS E INTERWIKIS NA SUBPÁGINA /doc --> </noinclude>

Detalhes técnicos

editar

Se houver uma página de testes esta predefinição irá detectar e exibir um link para a página "/Testes".

Esta predefinição categoriza as páginas de teste na categoria:testes de predefinições. Se você não quer que uma página seja categorizada, use esta predefinição da seguinte maneira:

{{Predefinição:Aviso/Testes com predefinições|categoria=}}

Se você quer demonstrar a predefinição por exemplo na página Wikilivros:Predefinições/Manutenção então você precisa fornecer o parâmetro subpágina-de-testes para fazer com que ela seja exibida e deixar o parâmetro categoria vazio para que a página não seja categorizada:

{{Predefinição:Aviso/Testes com predefinições|subpágina-de-testes=Manutenção|categoria=}}

Ver também

editar