Template:Navbox 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.
Initial visibility: currently defaults to autocollapse
To set this template's initial visibility, the |state=
parameter may be used:
|state=collapsed
:{{Navbox documentation|state=collapsed}}
to show the template collapsed, i.e., hidden apart from its title bar|state=expanded
:{{Navbox documentation|state=expanded}}
to show the template expanded, i.e., fully visible|state=autocollapse
:{{Navbox documentation|state=autocollapse}}
If the |state=
parameter in the template on this page is not set, the template's initial visibility is taken from the |default=
parameter in the Collapsible option template. For the template on this page, that currently evaluates to autocollapse
.
Explanation
This is a wrapper for {{Collapsible option}} to provide a semblance of documentation for navbox templates.
This template is used on approximately 108,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
{{Collapsible option}}
provides a standardised message for transclusion on the pages of collapsible templates whose collapsibility may be managed by the parameter |state=
.
It may be used on either the template page itself (wrapped within <noinclude>...</noinclude>
tags) or on the template's {{documentation subpage}}
.
Indicating optional use of state name
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):
Initial visibility: currently defaults to autocollapse
To set this template's initial visibility, the |state=
parameter may be used:
|state=collapsed
:{{Navbox documentation|state=collapsed}}
to show the template collapsed, i.e., hidden apart from its title bar|state=expanded
:{{Navbox documentation|state=expanded}}
to show the template expanded, i.e., fully visible|state=autocollapse
:{{Navbox documentation|state=autocollapse}}
If the |state=
parameter in the template on this page is not set, the template's initial visibility is taken from the |default=
parameter in the Collapsible option template. For the template on this page, that currently evaluates to autocollapse
.
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'sstate
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.
Changing the default state
To change the default state {{Collapsible option}}
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. This option is permissible in navboxes, which are not part of the article content per se.
Slashes and the nobase parameter
If the template name given to {{Collapsible option}}
</nowiki> 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).
See also
- {{Navbox documentation}}
{{Collapsible lists option}}
{{Collapsible sections option}}
- Help:Collapsing
TemplateData
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 |