Predefinição:Ambox/doc

Esta é a metapredefinição ([A]rticle [m]essage [box], em português, Caixa de mensagem para artigos).

Ela é utilizada para construir predefinições de caixa de mensagem para artigos tal como . Ela oferece bastantes cores diferentes, utiliza imagens padrão caso nenhum parâmetro seja dado, e tem algumas outras funcionalidades.

Parâmetros comuns

A caixa abaixo exibe os parâmetros mais comuns que são aceites por . O propósito de cada é descrito abaixo.

{{ambox
| nome  =
| subst = <includeonly>{{subst:substcheck}}</includeonly>
| pequena = {{{pequena|}}}
| tipo  =
| imagem =
| secção  = {{{1|}}}
| problema =
| discussão  = {{{discussão|}}}
| conserto   =
| data  = {{{data|}}}
| cat   =
| todos   =
}}

nome

O parâmetro nome (alternativamente name) especifica o nome da predefinição, sem o prefixo de espaço nominal Predefinição. Por exemplo especifica |nome=Sem fontes.

É recomendado que o parâmetro seja atualizado se a predefinição for movida. O propósito deste parâmetro é duplo:

• Se substituída incorretamente, permite que a metapredefinição notifique o nome da predefinição que tenha sido substituída, que pode ajudar outras(os) editoras(es) a consertar o problema.
• Permite que a predefinição tenha uma exibição mais útil em sua página de predefinição, por exemplo para exibir a data mesmo quando não especificada, e aplicar categorização da própria predefinição.

subst

O parâmetro subst permite que a predefinição detete se a predefinição foi substituída incorretamente, e dá um aviso apropriado. Também adicionará tais páginas a Categoria:!Páginas com predefinições substituídas incorretamente.

pequena

Recomenda-se que o parâmetro pequena (alternativamente pequeno e small) seja passado pela predefinição, visto que isto fará com que editoras(es) utilizem o formato pequeno ao especificar |pequena=esquerda num artigo:

Do contrário o formato padrão será produzido:

Outras variações:

• Para predefinições que não se espera ser jamais pequenas, especifique |pequena=não ou não passe o parâmetro pequena sequer.
• Para predefinições que se espera ser sempre pequenas, apenas especifique |pequena=esquerda.
• Para predefinições que se espera ser pequenas por padrão, tente |pequena={{{pequena|esquerda}}}. Isto permitirá que um(a) editor(a) sobreponha ao utilizar |pequena=não num artigo.

Veja § secção, abaixo, para informação sobre como limitar exibição de |pequena= a casos quando a predefinição estiver a ser utilizada para uma secção em vez de todo o artigo (recomendado, para prevenir exibição inconsistente em topo de artigo).

tipo

O parâmetro tipo (alternativamente type) define a cor da barra esquerda, e a imagem que é utilizada por padrão. O tipo é escolhido não por estética mas é baseado no tipo de problema que a predefinição descreve. Os sete tipos disponíveis e suas imagens padrão são apresentadas abaixo.

A predefinição utiliza |tipo=notícia por padrão se nenhum parâmetro tipo é dado.

imagem

Pode escolher uma imagem específica para utilizar para a predefinição ao utilizar o parâmetro imagem (alternativamente image). Imagens são especificadas ao utilizar a sintaxe padrão para inserir ficheiros na Wikipédia (veja Ajuda:Guia de edição/Como usar imagens § Como incluir em um artigo a imagem já localizada no Wikimedia Commons.) Larguras de 40-50px são típicas. Por exemplo:

• especifica |imagem=[[Imagem:Emblem-scales.svg|40px]] e parece-se assim:

• especifica |imagem=[[Ficheiro:Question book.svg|40px]] e parece-se assim:

Por favor note:

• Se nenhuma imagem é especificada então a imagem padrão correspondente ao tipo e utilizada. (Veja #tipo acima.)
• Se |imagem=nenhuma (alternativamente none) é especificada, então nenhuma imagem é utilizada e o texto utiliza toda a área da caixa de mensagem.
• Se um um ícone é puramente decorativa e também no domínio público, acessibilidade pode ser melhorada ao suprimir o link à página de ficheiro ao adicionar "|link=|alt=".

secção

(Alternativamente seção e sect) Muitas predefinições de mensagem para adtigos começam com o texto Este artigo ... e é frequentemente desejável que estas palavras mudem para Esta secção ... se a predefinição for antes utilizada numa predefinição. O valor deste parâmetro substituirá as palavras "Este artigo". Várias possibilidades para uso incluem: |secção=Esta lista, |secção=Esta tabela, |secção=Este material "Em cultura popular", etc.

Se utilizar esta funcionalidade, lembre-se de remover as primeiras duas palavras ("Este artigo") do texto da predefinição, do contrário será duplicado.

Uma maneira comum de facilitar esta funcionalidade é passar |secção={{{1|}}}. Isto permitirá que editoras(es) digitem Esta secção, por exemplo, como o primeiro parâmetro sem nome da predefinição para alterar as palavras. Uma outra abordagem é passar |secção={{{secção|{{{seção|}}}}}} para prover um valor com nome. Uma outra é utilizar {{Yesno}} para analisar sintaticamente o valor, e passar |secção=Esta secção se verdadeiro.

Estas abordagens podem ser combinadas, e isto é recomendado. O seguinte código pronto-para-usar:

| secção = {{#ifeq:{{yesno|def=|1={{{secção|{{{seção}}}}}} }}|yes|Esta secção|{{{secção|{{{seção|{{{1|}}}}}}}}} }}

ativa o seguinte:

• Qualquer valor positivo que {{Yesno}} possa detetar será usado com o parâmetro com nome na predefinição baseada em ambox para ter "Esta secção" em vez de "Este artigo": |secção=s, |secção=Verdadeiro, etc. É recomendado para permitir tanto |secção= como |seção= para que editoras(es) não tenham de adivinhar qual funcionará. O código de exemplo acima faz-lhe isto a si.
• Qualquer outro valor passado, de qualquer maneira, substituirá Este artigo: |Esta secção e suas subsecções, |1=Esta lista, |secção=Esta secção, |seção=Esta tabela, etc.

É recomendável também restringir uso do parâmetro |pequena= para que feita contingente à predefinição ser aplicada a uma secção (ou o que seja) em vez de todo o artigo, para prevenir a versão pequena da predefinição de ser usada no topo do artigo onde seria inconsistente com outros banners de reciclagem/disputa de largura de artigo:

| pequena = {{#if:{{{secção|{{{seção|{{{1|}}}}}}}}}|{{#if:{{{pequena|{{{esquerda|}}}}}}|esquerda}} }}

(Neste caso, qualquer valor de |pequena= ou |esquerda= irá disparar a exibição pequena e esquerda, contanto que algum valor de |secção= ou um de seus aliases nessa predefinição também tenha sido provido.) Este código pode copiado e colado e usado com o bloco de código acima.

problema e conserto

O parâmetro problema (alternativamente issue) é utilizado para descrever o problema com o artigo. Tente mantê-lo curto e direito ao ponto (aproximadamente 10-20 palavras) e lembre-se de incluir um link a uma política ou recomendação.

O parâmetro conserto (alternativamente fix) contém algum texto que descreve o que é suposto fazer para melhorar o artigo. Pode ser mais longo que o texto em problema, mas não se recomenda ter mais de duas orações.

Quando a predefinição está em sua forma compacta (quando posta dentro de ou forma pequena (quando utilizando |pequena=esquerda), o problema é o único texto que será exibido.

discussão

Allgumas predefinições de mensagem para artigos incluem um link à página de discussão, e permitem que um(a) editor(a) especifique um cabeçalho de secção para ligar-se diretamente à secção relevante. Para alcançar esta funcionalidade, simplesmente passe o parâmetro discussão (alternativamente talk), i.e. |discussão={{{discussão|}}}

Este parâmetro pode então ser utilizado por um(a) editor(a) como segue:

• |discussão=CABEÇALHO DE SECÇÃO – o link irá apontar à secção especificada na página de discussão do artigo, e.g. |discussão=Foo
• |discussão=NOME DA PÁGINA COMPLETO – a predefinição irá ligar-se à página especificada (que poderá incluir uma âncora de secção), e.g. |discussão=Discussão:Banana#Foo

Notas:

• Quando este parâmetro é utilizado por uma predefinição, o link da página de discussão aparecerá na própria predefinição (para demonstrar a funcionalidade) mas isto será exibido somente em artigos se o parâmetro for realmente definido.
• Para que tenha a certeza de que haja sempre um link à página de discussão, pode utilizar |discussão={{{discussão|#}}}.
• Se a página de discussão não existir, não haverá qualquer link, independentemente do valor do parâmetro.

data

Passar o parâmetro data (alternativamente date) à metapredefinição significa que a data que o artigo for marcado pode ser especificada por um(a) editor(a) (ou mais comummente um bot). Isto será exibido depois da mensagem numa fonte mais pequena.

info

Este parâmetro é para especificar informação adicional. Tudo o que adicionar aqui aparecerá após a data, e não será exibido se a predefinição estiver a ser embrulhada em .

avisoderemoção

Se especificar |avisoderemoção=sim (alternativamente aviso_de_remoção, aviso-de-remoção, avisoremoção, aviso_remoção, aviso-remoção ou removalnotice), então o seguinte aviso será exibido após a data e após o texto info:

• Saiba como e quando remover esta mensagem de predefinição.

Isto não será exibido se a predefinição estiver embrulhada em .

cat

Este parâmetro define uma categoria de reciclagem mensal. Se |cat=CATEGORIA então:

• artigos serão postos em Categoria:CATEGORIA desde DATA se |data=DATA for especificada.
• artigos serão postos em Categoria:CATEGORIA se a data não for especificada.

Por exemplo, {{Contextualizar}} especifica |cat=!Artigos sem contextualização e assim um artigo com a predefinição {{Contextualizar|data=junho de 2010}} será posta em Categoria:!Artigos sem contextualização desde janeiro de 2010.

O parâmetro cat não deve ser linkado, nem deve o prefixo Categoria: ser usado.

todos

O parâmetro todos (alternativamente all) define uma categoria em que todos os artigos devem ser postos.

O parâmetro todos não deve ser linkado, nem deve o prefixo Categoria: ser usado.

Outros parâmetros

A caixa Todos os parâmetros exibe todos os possíveis parâmetros para esta predefinição. Contudo, não é recomendado copiar isto, porque nunca será necessário utilizar todos os parâmetros simultaneamente.

Todos os parâmetros

{{ambox | nome = | subst = <includeonly>{{subst:substcheck}}</includeonly> | pequena = {{{pequena|}}} | tipo = | imagem = | imagemdireita = | imagempequena = | imagemdireitapequena = | class = | style = | textstyle = | secção = {{{1|}}} | problema = | discussão = {{{discussão|}}} | conserto = | data = {{{data|}}} | texto = | textopequeno = | plainlinks = não | avisoderemoção = | cat = | todos = | cat2 = | todos2 = | cat3 = | todos3 = }}<noinclude> {{Documentação}} </noinclude>

imagemdireita

(Alternativamente imagem-direita, imagem_direita e rightimage) Uma imagem no lado direito da caixa de mensagem pode ser especificada ao usar este parâmetro. A sintaxe é a mesma para o parâmetro "imagem", exceto que o padrão é nenhuma imagem.

imagempequena and imagemdireitapequena

(Alternativamente imagem-pequena, imagem_pequena e smallimage, e imagem-direita-pequena, imagem_pequena_direita e smallimageright, respetivamente) Imagens para a caixa de formato pequeno podem ser especificadas ao utilizar estes parâmetros. Elas não terão efeito a menos que |pequena=esquerda seja especificada.

class

(Alternativamente classe) Classes CSS personalizadas para aplicar a caixa. Se adicionar múltiplas classes, elas devem ser separadas por espaços.

style e textstyle

(Alternativamente estilo, e estilo-texto) Valores CSS opcionais podem ser definidos, sem aspas " " mas com ponto e vírgulas finais ;.

• style especifica o texto usado pela tabela de caixa de texto inteira.
• textstyle está relacionado à célula de texto.

texto e textopequeno

(Alternativamente texto-pequeno, texto_pequeno e smalltext) Em vez de especificar o problema e o conserto é possível utilizar o parâmetro texto.

Texto personalizado para o formato pequeno pode ser definido ao utilizar textopequeno.

plainlinks

Normalmente na Wikipédia, ligações externas possuem um ícone ao lado delas, assim: Example.com. Entretanto, em caixas de mensagem, o ícone de seta é suprimido por padrão, assim: Example.com. Para ter o estilo normal da ligação externa com o ícone de seta, use |plainlinks=não.

cat2, cat3, todos2 e todos3

• cat2 e cat3 proveem categorias mensais adicionais; veja § cat.
• all2 e all3 proveem categorias adicionais em que todos artigos são postos, assim como § todos.

Notas técnicas

• Devido as propriedades do Minerva, essa predefinição pode não ser exibida corretamente em ambientes mobile se utilizada em domínios diferentes do domínio principal.
• Esta metapredefinição usa as classes CSS de ambox em Predefinição:Ambox/styles.css. As classes também podem ser usadas diretamentes numa wikitable se funcionalidade especial for necessária.
• Se precisa de utilizar carateres especiais no parâmetro de texto, então precisa de os escapar assim:

{{ambox
| texto  = <div>
Sinal de igual = e uma colchete de início e fim { } funcionam bem como estão.
Mas eis um pipe &#124; e duas colchetes finais <nowiki>}}</nowiki>.
E agora um pipe e colchetes finais <nowiki>|}}</nowiki>.
</div>
}}

• As tags <div> que rodeiam o texto no exemplo acima não são geralmente necessárias. Mas se o texto contém quebras de linha então às vezes temos espaçamento de linha estranhas. Isto acontece especialmente ao utilizar listas de pontilhadas verticais. Então use as tags div para ajeitar isso.
• Esta predefinição utiliza classes CSS em Predefinição:Ambox/styles.css para a maioria de seus loooks, o que a torna completamente personalizável.
• Esta predefinição chama Módulo:Message box que possui a maioria do código para {{Ambox}}, enquanto {{Ambox}} em si faz preprocessamento de parâmetro.
• Internamente, esta metapredefinição utiliza markup HTML em vez de wikimarkup para o código de tabela. Essa é a maneira usual de como metapredefinições são feitas, já que wikimarkup possui muitos contras. Por exemplo, ela torna o uso de parser functions e alguns carateres especiais em parâmetros muito mais difícil.
• As imagens padrão para esta predefinição estão em formato png em vez de svg. A principal razão é que alguns web browsers mais antigos têm problemas com plano de fundo transparente que MediaWiki renderiza para imagens svg, As imagens png aqui tem cor de plano de fundo optimizado a mão para que elas possuam um visual bom em todos os browsers. Note que ícones svg somente possuem um visual um tanto mau nos browsers mais antigos, então esta optimização manual somente vale a pena para ícones utilizados muito amplamente.
• Para mais detalhes técnicos veja a página de discussão os links Veja também abaixo. Visto que esta predefinição funciona quase exatamente como {{Tmbox}}, {{Imbox}}, {{Cmbox}} e {{Ombox}} suas páginas de discussão e páginas relacionadas também podem conter mais detalhes.

Ver também

Existem várias metapredefinições, na família mbox:

• {{ambox}} – Caixas de mensagem para artigo.
• {{asbox}} – Caixas de mensagem para esboços.
• {{tmbox}} – Caixas de mensagem para página de discussão.
• {{imbox}} – Caixas de mensagem para página de imagem.
• {{cmbox}} – Caixas de mensagem para categoria .
• {{ombox}} – Caixas de mensagem para outras páginas.
• {{mbox}} – Tem detecção de nomes para caixas de mensagem, que são usadas em vários tipos de páginas e assim precisamos para alterar o estilo dependendo de, em qual página eles serão utilizados.

Metapredefinições estreitamente relacionados:

• {{fmbox}} – Caixas de mensagem para cabeçalho e rodapé.
• {{dmbox}} – Caixas de mensagem para desambiguação e definir índice.