Template documentation | This template does not display in the mobile view of Wikipedia; it is desktop only. Read the documentation for an explanation. |
This is a navigational template created using {{navbox}}. It can be transcluded on pages by placing {{Navbox documentation}} below the standard article appendices.
This template's initial visibility currently defaults to autocollapse, meaning that if there is another collapsible item on the page (anavbox, 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:
{{Navbox documentation|state=collapsed}} will show the template collapsed, i.e. hidden apart from its title bar.{{Navbox documentation|state=expanded}} will show the template expanded, i.e. fully visible.A navigational box that can be placed at the bottom of articles.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| State | state | The initial visibility of the navbox
| Unknown | suggested |
Template documentation | The stuff in the box above is the documentation that this template produces. This is the documentation for {{Navbox documentation}}, i.e. the documentation for the documentation. |
This is a wrapper for {{Collapsible option}} to provide a semblance of documentation for navbox templates. The {{Collapsible option}} template can be suppressed with |stateless=yes.
 | This template is used on approximately 37,000 pages and changes may be widely noticed. Test changes in the template's /sandboxor/testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{Collapsible option}} is a utility template provides a standardised message for transclusionontemplate documentaion 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 {{documentation subpage}}.
The |state= parameter used to manage collapsible templates need not always be named explicitly, i.e. {{Template name|state}} can be the same as {{Template name|state=state}}, if the template is coded that way. To indicate this in the {{Collapsible option}} 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 autocollapse, meaning that if there is another collapsible item on the page (anavbox, 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:
{{Navbox documentation|state=collapsed}} will show the template collapsed, i.e. hidden apart from its title bar.{{Navbox documentation|state=expanded}} will show the template expanded, i.e. fully visible.This possibility is enabled by including:
{{{1|}}} as part of a collapsible template's |state= parameter – for instance, as |state={{{state|{{{1|}}}}}}or|state={{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}, etc.<noinclude>,<includeonly>as part of a collapsible template's state argument – for instance, as |state={{{state<includeonly>|collapsed</includeonly>}}}
If, however, the template includes collapsible sections within itself (e.g. {{Navbox with collapsible groups}}), 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.
To change the default state {{Collapsible option}} uses, add the parameter |default=collapsedor|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. (For more information, see Wikipedia:Manual of Style § Scrolling lists and collapsible content.) This option is permissible in navboxes, which are not part of the article content per se.
If the template name given to {{Collapsible option}} 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 {{PAGENAME}} rather than the default {{BASEPAGENAME}} is used to display it).
This is a wrapper for {{Collapsible option}} to provide a semblance of documentation for navbox templates.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Top content | 2 | Hatnotes, Usage, etc. (above {{collapsible option}} but below {{Template display|nomobile}}) | Content | optional |
| Content | 3 | TemplateData, See also, etc. (below {{collapsible option}}) | Content | optional |
| State | state 1 | Set to either: (1) expand, (2) collapse, or (3) autocollapse
| Boolean | suggested |
| Template | template | To call the template anything other than {{PAGENAME}} within the documentation
| String | optional |
| Stateless | stateless | Hides the {{Collapsible option}} transclusion for when the navbox doesn't support a state.
| Unknown | optional |