Template:Navbox documentation
Template documentation | This template does not display in the mobile view of Bharatpedia; 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
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.
Templates using the classes class=navbox ({{navbox}}) or class=nomobile ({{sidebar}}) are not displayed on the mobile web site of English Bharatpedia. 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 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/watch phab:T124168 for further discussion.
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 39,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.
Transclusion count updated automatically (see documentation). |
Error: no shortcuts were specified and the |msg= parameter was not set.
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 contains a forward slash, which can break basepage-subpage distinction. | Boolean | optional |