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
This template's initial visibility currently defaults to autocollapse
, 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:
{{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.
Templates using the classes class=navbox
({{navbox}}) or class=nomobile
({{sidebar}}) are not displayed on the mobile web site of English Wikipedia. Mobile page views account for approximately 66% of all page views (90-day average as of January 2024[update]).
TemplateData
A navigational box that can be placed at the bottom of articles.
Parameter | Description | Type | Status | |
---|---|---|---|---|
State | state | The initial visibility of the navbox
| String | suggested |
Template transclusions
Transclusion maintenance |
---|
Check completeness of transclusions |
This template is used on approximately 38,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This is a wrapper for {{Collapsible option}} to provide a semblance of documentation for navbox templates. See that template for further guidance. The {{Collapsible option}} template can be suppressed with |stateless=yes
.
TemplateData
TemplateData for Navbox documentation
This is a wrapper for {{Collapsible option}} to provide a semblance of documentation for navbox templates.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Hatnotes | hatnotes | Hatnotes to appear above the template banners
| Content | optional |
Top content | intro or 2 | Template shortcuts/redirects, High-use template, templatestyles, usage, etc. (put below {{Template display|nomobile}}) | Content | optional |
Content | 3 | TemplateData, See also, etc. (below {{collapsible option}}) | Content | optional |
State | state or 1 | The default initial state of the template. Set to either: (1) expanded, (2) collapsed, or (3) autocollapse
| Unknown | 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 |
nobase | nobase | Pass through to {{Collapsible option}} to disable BASEPAGENAME detection. Use it when the template's name contain a forward slash, which can break basepage-subpage distinction. | Boolean | optional |