Exibir código-fonte para Predefinição:Opções de recolhimento/doc

{{Subpágina de documentação}}
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 {{parâmetro|estado}} ou de outro parâmetro equivalente.

Os estados documentados são:
* {{parâmetro|collapsed}} — a predefinição é mostrada recolhida, exceto pela barra de título;
* {{parâmetro|expanded}} — a predefinição é mostrada totalmente expandida;
* {{parâmetro|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">
{{Opções de recolhimento}}
</syntaxhighlight>

Nesse caso, <code>autocollapse</code> é apresentado como o estado padrão.

=== Alterar o estado padrão ===
Use {{parâmetro|padrão}} para indicar o estado inicial usado pela predefinição documentada:

<syntaxhighlight lang="wikitext">
{{Opções de recolhimento|padrão=collapsed}}
</syntaxhighlight>

Os valores aceitos são <code>collapsed</code>, <code>expanded</code> e <code>autocollapse</code>. O valor legado <code>uncollapsed</code> é tratado como equivalente a <code>expanded</code>, 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 {{parâmetro|estado}}, indique-o com {{parâmetro|nome_parâmetro}}:

<syntaxhighlight lang="wikitext">
{{Opções de recolhimento|nome_parâmetro=visibilidade}}
</syntaxhighlight>

=== Predefinições com barra no nome ===
Se o nome da predefinição contiver uma barra (<code>/</code>), use {{parâmetro|sembase|sim}} para que os exemplos exibam corretamente o nome completo:

<syntaxhighlight lang="wikitext">
{{Opções de recolhimento|sembase=sim}}
</syntaxhighlight>

=== Variante do português ===
Se a predefinição documentada aceitar o parâmetro {{parâmetro|lang}} para alternar entre variantes do português, use {{parâmetro|lang-alt}} para indicar a variante alternativa:

* {{parâmetro|lang-alt|pt}} — informa que {{parâmetro|lang|pt}} seleciona o [[português europeu]];
* {{parâmetro|lang-alt|br}} — informa que {{parâmetro|lang|br}} seleciona o [[português brasileiro]].

Por exemplo, se a predefinição usar português brasileiro por padrão e {{parâmetro|lang|pt}} para português europeu:

<syntaxhighlight lang="wikitext">
{{Opções de recolhimento|lang-alt=pt}}
</syntaxhighlight>

Este parâmetro apenas acrescenta a instrução à documentação; a predefinição documentada deve implementar separadamente o parâmetro {{parâmetro|lang}}.

== Outros parâmetros ==
Os parâmetros {{parâmetro|alinhamento}}, {{parâmetro|título_fundo}} e {{parâmetro|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 <code>default</code>, <code>state</code>, <code>parameter_name</code>, <code>nobase</code>, <code>align</code>, <code>title-background</code> e <code>width</code>. Em novas chamadas, prefira os nomes em português.

== Ver também ==
* {{lp|Opções para seções recolhíveis}}
* {{lp|Opções para listas recolhíveis}}

<includeonly>
[[Categoria:!Metapredefinições|Collapsible option]]
[[Categoria:!Predefinições para caixas de navegação]]
</includeonly>