Predefinição:Opções de recolhimento/doc

{{#invoke:Message box|mbox}} Esta predefinição é uma metapredefinição usada na documentação de predefinições recolhíveis. Ela gera uma mensagem padronizada que explica como alterar a visibilidade inicial por meio do parâmetro <syntaxhighlight lang="wikitext" inline style="display: none;" />|estado= ou de outro parâmetro equivalente.

Os estados documentados são:

• <syntaxhighlight lang="wikitext" inline style="display: none;" />|collapsed= — a predefinição é mostrada recolhida, exceto pela barra de título;
• <syntaxhighlight lang="wikitext" inline style="display: none;" />|expanded= — a predefinição é mostrada totalmente expandida;
• <syntaxhighlight lang="wikitext" inline style="display: none;" />|autocollapse= — a predefinição é recolhida quando há outro item recolhível na página; caso contrário, permanece expandida.

Para mais informações sobre caixas de navegação e conteúdo recolhível, consulte Wikipédia:Predefinição de navegação e Ajuda:Expandir.

Uso

Normalmente, esta predefinição deve ser colocada na subpágina de documentação da predefinição recolhível:

<syntaxhighlight lang="wikitext"> A visibilidade inicial desta predefinição atualmente é definida como <code class="tpl-pval__code" style=" ">{{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source=⊗ϑautocollapse⊗ϑ| | |count=}}|#|#|count=}}|*|*|count=}}|:|:|count=}}|⊗ϑ||count=}}, o que significa que se houver outro item recolhível na página (uma caixa de navegação, barra lateral ou uma tabela com o atributo recolhível), ela ficará recolhida, exceto pela barra de título; caso contrário, ficará totalmente visível.

Para alterar a visibilidade inicial desta predefinição, use o parâmetro <syntaxhighlight lang="wikitext" inline style="display: none;" />|estado=:

• <syntaxhighlight lang="wikitext" inline="1">{{Opções de recolhimento|estado=collapsed}}</syntaxhighlight> mostrará a predefinição recolhida, ou seja, escondida exceto pela barra de título.
• <syntaxhighlight lang="wikitext" inline="1">{{Opções de recolhimento|estado=expanded}}</syntaxhighlight> mostrará a predefinição expandida, ou seja, totalmente visível.

</syntaxhighlight>

Nesse caso, autocollapse é apresentado como o estado padrão.

Alterar o estado padrão

Use <syntaxhighlight lang="wikitext" inline style="display: none;" />|padrão= para indicar o estado inicial usado pela predefinição documentada:

<syntaxhighlight lang="wikitext"> A visibilidade inicial desta predefinição atualmente é definida como <code class="tpl-pval__code" style=" ">{{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source=⊗ϑcollapsed⊗ϑ| | |count=}}|#|#|count=}}|*|*|count=}}|:|:|count=}}|⊗ϑ||count=}}, o que significa que ela ficará recolhida, exceto pela barra de título.

Para alterar a visibilidade inicial desta predefinição, use o parâmetro <syntaxhighlight lang="wikitext" inline style="display: none;" />|estado=:

• <syntaxhighlight lang="wikitext" inline="1">{{Opções de recolhimento|estado=expanded}}</syntaxhighlight> mostrará a predefinição expandida, ou seja, totalmente visível.
• <syntaxhighlight lang="wikitext" inline="1">{{Opções de recolhimento|estado=autocollapse}}</syntaxhighlight> fará a predefinição ser recolhida automaticamente, ou seja, se houver outro item recolhível na página (uma caixa de navegação, barra lateral ou uma tabela com o atributo recolhível), ela ficará recolhida, exceto pela barra de título; caso contrário, ficará totalmente visível.

</syntaxhighlight>

Os valores aceitos são collapsed, expanded e autocollapse. O valor legado uncollapsed é tratado como equivalente a expanded, mas não deve ser usado em código novo.

Nome do parâmetro

Se a predefinição documentada usar outro parâmetro em vez de <syntaxhighlight lang="wikitext" inline style="display: none;" />|estado=, indique-o com <syntaxhighlight lang="wikitext" inline style="display: none;" />|nome_parâmetro=:

<syntaxhighlight lang="wikitext"> A visibilidade inicial desta predefinição atualmente é definida como <code class="tpl-pval__code" style=" ">{{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source=⊗ϑautocollapse⊗ϑ| | |count=}}|#|#|count=}}|*|*|count=}}|:|:|count=}}|⊗ϑ||count=}}, o que significa que se houver outro item recolhível na página (uma caixa de navegação, barra lateral ou uma tabela com o atributo recolhível), ela ficará recolhida, exceto pela barra de título; caso contrário, ficará totalmente visível.

Para alterar a visibilidade inicial desta predefinição, use o parâmetro <syntaxhighlight lang="wikitext" inline style="display: none;" />|visibilidade=:

• <syntaxhighlight lang="wikitext" inline="1">{{Opções de recolhimento|visibilidade=collapsed}}</syntaxhighlight> mostrará a predefinição recolhida, ou seja, escondida exceto pela barra de título.
• <syntaxhighlight lang="wikitext" inline="1">{{Opções de recolhimento|visibilidade=expanded}}</syntaxhighlight> mostrará a predefinição expandida, ou seja, totalmente visível.

</syntaxhighlight>

Predefinições com barra no nome

Se o nome da predefinição contiver uma barra (/), use <syntaxhighlight lang="wikitext" inline style="display: none;" />|sembase=sim para que os exemplos exibam corretamente o nome completo:

<syntaxhighlight lang="wikitext"> A visibilidade inicial desta predefinição atualmente é definida como <code class="tpl-pval__code" style=" ">{{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source=⊗ϑautocollapse⊗ϑ| | |count=}}|#|#|count=}}|*|*|count=}}|:|:|count=}}|⊗ϑ||count=}}, o que significa que se houver outro item recolhível na página (uma caixa de navegação, barra lateral ou uma tabela com o atributo recolhível), ela ficará recolhida, exceto pela barra de título; caso contrário, ficará totalmente visível.

Para alterar a visibilidade inicial desta predefinição, use o parâmetro <syntaxhighlight lang="wikitext" inline style="display: none;" />|estado=:

• <syntaxhighlight lang="wikitext" inline="1">{{Opções de recolhimento/doc|estado=collapsed}}</syntaxhighlight> mostrará a predefinição recolhida, ou seja, escondida exceto pela barra de título.
• <syntaxhighlight lang="wikitext" inline="1">{{Opções de recolhimento/doc|estado=expanded}}</syntaxhighlight> mostrará a predefinição expandida, ou seja, totalmente visível.

</syntaxhighlight>

Variante do português

Se a predefinição documentada aceitar o parâmetro <syntaxhighlight lang="wikitext" inline style="display: none;" />|lang= para alternar entre variantes do português, use <syntaxhighlight lang="wikitext" inline style="display: none;" />|lang-alt= para indicar a variante alternativa:

• <syntaxhighlight lang="wikitext" inline style="display: none;" />|lang-alt=pt — informa que <syntaxhighlight lang="wikitext" inline style="display: none;" />|lang=pt seleciona o português europeu;
• <syntaxhighlight lang="wikitext" inline style="display: none;" />|lang-alt=br — informa que <syntaxhighlight lang="wikitext" inline style="display: none;" />|lang=br seleciona o português brasileiro.

Por exemplo, se a predefinição usar português brasileiro por padrão e <syntaxhighlight lang="wikitext" inline style="display: none;" />|lang=pt para português europeu:

<syntaxhighlight lang="wikitext"> A visibilidade inicial desta predefinição atualmente é definida como <code class="tpl-pval__code" style=" ">{{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source={{safesubst:#invoke:String|replace|source=⊗ϑautocollapse⊗ϑ| | |count=}}|#|#|count=}}|*|*|count=}}|:|:|count=}}|⊗ϑ||count=}}, o que significa que se houver outro item recolhível na página (uma caixa de navegação, barra lateral ou uma tabela com o atributo recolhível), ela ficará recolhida, exceto pela barra de título; caso contrário, ficará totalmente visível.

Para alterar a visibilidade inicial desta predefinição, use o parâmetro <syntaxhighlight lang="wikitext" inline style="display: none;" />|estado=:

• <syntaxhighlight lang="wikitext" inline="1">{{Opções de recolhimento|estado=collapsed}}</syntaxhighlight> mostrará a predefinição recolhida, ou seja, escondida exceto pela barra de título.
• <syntaxhighlight lang="wikitext" inline="1">{{Opções de recolhimento|estado=expanded}}</syntaxhighlight> mostrará a predefinição expandida, ou seja, totalmente visível.

Para usar português europeu, indique o parâmetro <syntaxhighlight lang="wikitext" inline style="display: none;" />|lang=pt. </syntaxhighlight>

Este parâmetro apenas acrescenta a instrução à documentação; a predefinição documentada deve implementar separadamente o parâmetro <syntaxhighlight lang="wikitext" inline style="display: none;" />|lang=.

Outros parâmetros

Os parâmetros <syntaxhighlight lang="wikitext" inline style="display: none;" />|alinhamento=, <syntaxhighlight lang="wikitext" inline style="display: none;" />|título_fundo= e <syntaxhighlight lang="wikitext" inline style="display: none;" />|largura= fazem a mensagem mencionar opções adicionais da predefinição documentada. Só devem ser usados quando essa predefinição realmente oferecer os parâmetros correspondentes.

Por compatibilidade com chamadas antigas ou importadas, também são aceitos os aliases em inglês default, state, parameter_name, nobase, align, title-background e width. Em novas chamadas, prefira os nomes em português.

Ver também

• {{Opções para seções recolhíveis}}
• {{Opções para listas recolhíveis}}