Template:Collapsible option/doc

Template:Tlx is a utility template that provides a standardised message for transclusion on template documentation pages for templates whose collapsibility may be managed by the parameter |state=.

It can be used on either the template page itself (wrapped within <noinclude>...</noinclude> tags), but it is almost always better to place it in the template's Template:Tlx.

Indicating optional use of Template:Samp name

The |state= parameter used to manage collapsible templates need not always be named explicitly, i.e. Template:Tnull can be the same as Template:Tnull, if the template is coded that way. To indicate this in the Template:Tnull message, add the parameter |statename=optional. This modifies the message so that it reads (if it were used for itself):

This template's initial visibility currently defaults to Template:Param value, meaning that if there is another collapsible item on the page (a navbox, sidebar, or table with the collapsible attribute), it is hidden apart from its title bar; if not, it is fully visible.

To change this template's initial visibility, the |state= parameter may be used:

• {{Collapsible option|state=collapsed}} will show the template collapsed, i.e. hidden apart from its title bar.
• {{Collapsible option|state=expanded}} will show the template expanded, i.e. fully visible.

Template:Sandbox otherTemplate:Template other

This possibility is enabled by including:

• {{{1|}}} as part of a collapsible template's |state= parameterTemplate:Spaced ndashfor instance, as |state={{{state|{{{1|}}}}}} or |state={{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}, etc.
• <noinclude>,<includeonly>as part of a collapsible template's state argumentTemplate:Spaced ndashfor instance, as |state={{{state<includeonly>|collapsed</includeonly>}}}

If, however, the template includes collapsible sections within itself (e.g. Template:Tlx), then enabling this possibility may introduce ambiguity as regards what is to be collapsed or expanded. In those instances, therefore, the requirement to use |state= should be retained.

Changing the default state

To change the default state Template:Tnull uses, add the parameter |default=collapsed or |default=expanded accordingly. To restore the default, remove any |default= previously included.

The |default=collapsed option must not be used in main article content in mainspace, e.g. to hide tables of information, or to cram extraneous details into infoboxes. Template:Crossref This option Template:Em permissible in navboxes, which are not part of the article content .

Slashes and the Template:Samp parameter

If the template name given to Template:Tnull includes a forward-slash (virgule) character – / – then the parameter |nobase= (set to on, true, etc.) will need to be added so that the name is displayed correctly (i.e., so that Template:Tlc rather than the default Template:Tlc is used to display it).

See also

• Template:Tl, which includes this template
• Template:Tl
• Template:Tl
• Collapsing tables and more