Template:Navigation/doc

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

{{Navigation/doc}} is a generic navigational template.

Blank

{{Navigation
| name  = {{subst:PAGENAME}}
| title = 
| body  = 
}}

Parameters

Mandatory

name (or templateName): The name of the template, which is needed for the "view · talk · edit" links to work properly on all of the pages where the template is used on. You can enter {{subst:PAGENAME}} for this value as a shortcut.
title (or header): Text that appears centered in the titlebar (the top bar). Usually this is the template's topic, i.e. a succinct description of the body contents.
body: The material contained by the template, usually a list or list of links. Use | to separate links. It is not possible to include a pipe ("|") in the contents as this symbol is used to separate parameters. Format is inline.

Optional

color: Header color. Default is #efefef. Use of this parameter is discouraged. Where it is used, care and consensus are needed as multiple navigational templates on one page with different titlebar colors will probably look unpleasant.
cat (or category): The category or categories to which a page sporting the template will become a member.

Auto collapse logic

A navbox will start out collapsed if there are 4 or more tables on the same page that is implemented with NavFrame. For the technical minded, see MediaWiki:Common.js.

Example

Code

{{Navigation
| name  = {{subst:PAGENAME}}
| title = [[Countries of the world|Countries]] of [[Central Asia]]
| cat   = [[Category:Central Asian countries]]<noinclude>[[Category:Asian navigational boxes|{{PAGENAME}}]] [[Category:Continental navigation templates|{{PAGENAME}}]]</noinclude>
| body  =
[[Afghanistan]]{{·}}
[[Kazakhstan]]{{·}}
[[Kyrgyzstan]]{{·}}
[[Mongolia]]{{·}}
[[Russia]]{{·}}
[[Tajikistan]]{{·}}
[[Turkmenistan]]{{·}}
[[Uzbekistan]]
}}

Result

Countries of Central Asia

Afghanistan · Kazakhstan · Kyrgyzstan · Mongolia · Russia · Tajikistan · Turkmenistan · Uzbekistan

Related pages

Navigation templates comparison
view talk edit	Collapsible	Header color	Image	Groups	Style (body) parameter/s	Examples
{{Navbox}}	collapsible	navbox	Left/right of body	Yes	Yes	{{Solar System}} {{Governance of Greater London}}
{{Navbox with collapsible groups}}	collapsible	navbox	Left/right of body and/or in each list	Yes	Yes	{{Tetrapodomorpha}}
{{Navbox with columns}}	collapsible	navbox	Left/right of columns	No	Yes	{{Current U.S. Senators}} {{Historical regions of the Czech Republic}}

Collapsible attributes
Type	CSS classes	JavaScript	Collapses when	Custom initial state	Nesting
Collapsible tables	collapsible	Defined in Common.js	2 or more autocollapse on page	Yes	Yes