Template:Navigation/doc

This is the template documentation page for Template:Navigation. This page is not necessarily 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/doc}} is a generic navigational template.

Blank syntax (basic)

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

Parameters

Deprecated parameter names are given in parentheses.

Mandatory

name

(or templateName) The name of the template, which is needed for the "v · t · e" (i.e. "view · talk · edit") links to work properly on 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. Format is inline.

Optional

titlestyle

Style/s to apply to titlebar; usually a background color (i.e. titlestyle = background:color).
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.

bodystyle or style

Any CSS styling to add to the body, e.g. "text-align:left;" to left-align the body's content in place of its default center alignment.

category

The category or categories to which a page transcluding the template will become a member. Place <includeonly> ...... </includeonly> either side of the category or categories to ensure the template itself isn't made a member. Use of this parameter is discouraged; when editing a page on which the template is transcluded, no mention of the category or categories added by this parameter is apparent.

Example

Code

{{Navigation
|name  = {{subst:PAGENAME}}
|title = [[Countries of the world|Countries]] of [[Central Asia]]
|body  =

[[Afghanistan]]{{·}} [[Kazakhstan]]{{·}} [[Kyrgyzstan]]{{·}} [[Mongolia]]{{·}} [[Russia]]{{·}} 
[[Tajikistan]]{{·}} [[Turkmenistan]]{{·}} [[Uzbekistan]]

}}

Result

Countries of Central Asia

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

See also

Navigation template comparison

	collapsible	Header color†	Image	Groups	Style (body) parameter/s	Example
{{Navigation}}	NavFrame	NavHead	No	No	Yes	{{OPEC}}
{{Navigation with image}}	NavFrame	NavHead	Left/right of body	No	Yes	{{HolmesNovels}}
{{Navigation with columns}}	NavFrame	NavHead	No	No	Yes
{{Dynamic navigation box}}	collapsible	navbox	No	No	Yes	{{CSUHeads}}
{{Dynamic navigation box with image}}	NavFrame	NavHead	Upper left	No	No	{{SlovakPMs}}
{{Navbox generic}}	collapsible	navbox	Right-hand side	Yes	Yes	{{Dilbert}}
{{NavigationBox}}	No	navbox	Right of title+body	No	No	{{EPA}}
{{Commons:NavigationBox}}	No	#ccccff	Right of title+body	No	No
{{Commons:Dynamic navigation box}}	NavFrame	#ccccff	No	No	No
{{Commons:Dynamic navigation box with image}}	NavFrame	#ccccff	Upper left	No	No
† The background color for the header or title is inherited from the class listed below. The templates have titlestyle parameters that can be used to override the default.

Collapsible attributes

Type	CSS classes	Collapses when	Custom initial state	Nesting	Header color	Font size
NavFrame div	NavFrame, NavHead, NavContent	3+ of the same	No	Yes	#ccccff	95%
Collapsible table	collapsible, navbox	2+ of the same	Yes	Yes	#ccccff	90%
For the technically minded, see Common.css and Common.js.