வார்ப்புரு:Navbox documentation

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

This template does not display in the mobile view of Wikipedia; 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}}
- shows the template collapsed to the title bar if there is a {{navbar}}, a {{sidebar}}, or some other table on the page with the collapsible attribute
- shows the template in its expanded state if there are no other collapsible items on the page

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 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^[update]). 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 வார்ப்புரு:Navbox documentation.
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 many 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