Template:Navigation Template/doc

This is the template documentation page for {{Navigation Template}}. It is not intended to be viewed directly. If it uses variables, some links may appear broken. Do not replace these variables with hardcoded page names or URLs.

---

{{Navigation Template/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. 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 directly include a pipe ("|") in the contents as this symbol is used to separate parameters. &amp:#124; or {{!}} can be used in the body to produce a pipe symbol. 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.

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

See also

	collapsible	Image	Groups	Default header color	Style parameter	Example
{{Navigation}}	NavFrame	No	No	#efefef	No	{{OPEC}}
{{Navigation with image}}	NavFrame	Left/right of body	No	#efefef	No	{{Cetaceans}}
{{Dynamic navigation box}}	collapsible	No	No	#ccccff	Yes	{{CSUHeads}}
{{Dynamic navigation box with image}}	NavFrame	Upper left	No	#efefef	No	{{SPDHeads}}
{{Navbox generic}}	collapsible	No	Yes	#ccccff	Yes	{{Dilbert}}
{{Navbox generic with image}}	collapsible	Right-hand side	Yes	#ccccff	Yes
{{NavigationBox}}	No	Right of header+body	No	#ccccff	No	{{EPA}}
{{Navigation no hide}}	No	No	No	#eee	No
{{Commons:NavigationBox}}	No	Right of header+body	No	#ccccff	No
{{Commons:Dynamic navigation box}}	NavFrame	No	No	#ccccff	No
{{Commons:Dynamic navigation box with image}}	NavFrame	Upper left	No	#efefef	No

	CSS class	collapses when†	custom initial state	Nesting
NavFrame	NavFrame	3+ of the same	No	Yes
collapsible	navbox, collapsible	2+ of the same	Yes	No
† For the technically minded, see MediaWiki:Common.js.