Predefinição:Explicação/doc

Esta é uma subpágina de documentação para Predefinição:Explicação (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.

Uso

Esta predefinição facilita a inclusão de explicações expansíveis nas páginas de um livro.

Um recurso como este é interessante quando os autores desejam escrever um texto que sirva simultaneamente a dois tipos de leitores:

1. Aqueles que já conhecem um pouco sobre o assunto e que por este motivo não precisam ver explicações muito detalhadas sobre cada tópico;
2. Aqueles que estão vendo pela primeira vez o conteúdo abordado, e que por isso necessitam de detalhes sobre alguns trechos.

Um exemplo típico aparece nos livros de matemática (ou de exatas em geral), nos quais costumam aparecer passagens que para uns são "óbvias" mas que para outros não são sequer intuitivas. A predefinição ajudará o autor do texto a satisfazer as necessidades de cada leitor, e até mesmo incentivar que seja feito um exercício mental em algumas passagens do texto.

A seguir são apresentados alguns exemplos de como a predefinição pode ser usada. A predefinição depende do suporte a javascript e folhas de estilos (CSS) para se tornar funcional.

Exemplos

Sintaxe simples

Escrevendo

<texto antes da afirmação>{{Explicação|<afirmação>|<detalhes adicionais>}}<texto depois da afirmação>

ou

<texto antes da afirmação>{{Explicação
|<afirmação>
|<detalhes adicionais>
}}<texto depois da afirmação>

o resultado será este:

<texto antes da afirmação> <afirmação> (justifique) (oculte a explicação) <detalhes adicionais> (se ainda restam dúvidas, deixe uma sugestão para os autores sobre o que pode ser explicado melhor) <texto depois da afirmação>

Sintaxe mais elaborada

É possível redefinir os textos que são usados por padrão. Usando o código

<texto antes da afirmação>{{Explicação
|afirmação = <afirmação>
|mostrar   = <texto da ligação que exibe os detalhes>
|detalhes  = <detalhes adicionais>
|ocultar   = <texto da ligação que oculta os detalhes>
|ajuda     = <texto de ajuda exibido logo depois a explicação>
}}<texto depois da afirmação>

você obtém isto:

<texto antes da afirmação> <afirmação> <texto da ligação que exibe os detalhes> <texto da ligação que oculta os detalhes> <detalhes adicionais> <texto de ajuda exibido logo depois a explicação> <texto depois da afirmação>

A fazer...

• Aprimorar a predefinição usando alguns comandos do tipo {{#ifeq:}}, para permitir que todas as explicações fossem exibidas no caso das páginas que servem de versão para impressão, pois já que na versão impressa não teria como existir a automação, seria melhor exibir tudo.
• Aprimorar o script para que seja exibida uma ligação no topo da página para "mostrar/ocultar todas as explicações".
• Aprimorar o script para que seja possível clicar em qualquer lugar da afirmação para exibir os detalhes adicionais.

Veja também

• Predefinição:Oculto e w:en:Template:Hidden
• MediaWiki:Common.js e MediaWiki:Common.css
• Os testes preliminares feitos na caixa de areia
• Conversa onde esta predefinição foi proposta
• Ajuda:Como criar predefinições