Template:Navbox documentation

Template documentation[view] [edit] [history] [purge]

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

How to manage this template's initial visibility

To manage this template's visibility when it first appears, add the parameter:

|state=collapsed to show the template in its collapsed state, i.e. hidden apart from its titlebar – e.g. {{Navbox documentation |state=collapsed}}

|state=expanded to show the template in its expanded state, i.e. fully visible – e.g. {{Navbox documentation |state=expanded}}

|state=autocollapse to show the template in its collapsed state but only if there is another template of the same type on the page – e.g. {{Navbox documentation |state=autocollapse}}

Unless set otherwise (see the |state= parameter in the template's code), the template's default state is autocollapse.

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 65% of all page views (90-day average as of May 2023 ).

TemplateData

A navigational box that can be placed at the bottom of articles.

Template parameters[Edit template data]

Parameter		Description	Type	Status
State	state	The initial visibility of the navbox Suggested values collapsed expanded autocollapse	String	suggested

The above documentation is transcluded from Template:Navbox documentation. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.

Template documentation[view] [edit] [history] [purge]

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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Navbox documentation

This is a wrapper for {{Collapsible option}} to provide a semblance of documentation for navbox templates.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Hatnotes	hatnotes	Hatnotes to appear above the template banners Example {{For|xyz|abc}}	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 Suggested values expanded collapsed autocollapse Default autocollapse	Unknown	suggested
Template	template	To call the template anything other than {{PAGENAME}} within the documentation Auto value {{PAGENAME}}	String	optional
Stateless	stateless	Hides the {{Collapsible option}} transclusion for when the navbox doesn't support a state. Example yes Auto value no	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

The above documentation is transcluded from Template:Navbox documentation/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.