![]() | This template doesnot display in the mobile view of Wikipedia; it isdesktop only. SeeTemplate:Navbox visibility for a brief explanation. |
This is anavigational template created using{{navbox}}. It can betranscluded on pages by placing{{Navbox documentation}}
below thestandard article appendices.
This template'sinitial visibility currently defaults toautocollapse
, meaning that if there is another collapsible item on the page (anavbox, sidebar, ortable 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 classesclass=navbox
({{navbox}}) orclass=nomobile
({{sidebar}}) are not displayed in article space on themobile web site of English Wikipedia. Mobile page views account for approximately 68% of all page views (90-day average as of September 2024[update]). Briefly, these templates are not included in articles because 1) they are not well designed for mobile, and 2) they significantly increase page sizes—bad for mobile downloads—in a way that is not useful for the mobile use case. You can review/watchphab:T124168 for further discussion.
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 |
Transclusion maintenance |
---|
Check completeness of transclusions |
![]() | This template is used onapproximately 43,000 pages and changes may be widely noticed. Test changes in the template's/sandbox or/testcases subpages, or in your ownuser subpage. Consider discussing changes on thetalk 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
.
This template uses the following single elements:{{Template display}},{{Collapsible option}},{{Navbox visibility}} and{{Check completeness of transclusions}}.
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 contains a forward slash, which can break basepage-subpage distinction. | Boolean | optional |