Template:Navbox documentation/doc

This is a documentation subpage for Template:Navbox documentation.
It may contain usage information, categories and other content that is not part of the original template page.

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.

Shortcut

{{navdoc}}

Redirect

{{Navbox doc}}

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.

Elements

This template uses the following single elements: {{Template display}}, {{Collapsible option}}, {{Navbox visibility}} and {{Check completeness of transclusions}}.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Navbox documentation in articles based on its TemplateData.

TemplateData for Navbox documentation

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

Template parameters
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