Template:Navbox documentation

File:Test Template Info-Icon - Version (2).svg 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

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:

• <syntaxhighlight lang="wikitext" inline="1">{{Navbox documentation|state=collapsed}}</syntaxhighlight> will show the template collapsed, i.e. hidden apart from its title bar.
• <syntaxhighlight lang="wikitext" inline="1">{{Navbox documentation|state=expanded}}</syntaxhighlight> will show the template expanded, i.e. fully visible.

Templates using the classes class=navbox ({{navbox}}) or class=nomobile ({{sidebar}}) are not displayed in article space on the mobile web site of English Wikipedia. Mobile page views account for approximately 68% of all page views (90-day average as of September 2024). 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/watch phab:T124168 for further discussion.

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. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.

File:Test Template Info-Icon - Version (2).svg 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.

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. (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.