Template:Navbox documentation

Template documentation

{{navdoc}}

This template does not display in the mobile view of Wikipedia; it is desktop only. See Template:Navbox visibility for a brief 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.

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

Template transclusions

Transclusion maintenance
Check completeness of transclusions

The above documentation is transcluded from Template:Navbox documentation/doc.
Editors can experiment in this template's sandbox and testcases pages.
Subpages of this template.

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

This template is used on approximately 43,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[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.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.