Template:Navigation/doc

From the Simple English Wikipedia, the free encyclopedia that anyone can change

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

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

Contents 1 Blank 2 Parameters 2.1 Mandatory 2.2 Optional 3 Auto collapse logic 4 Example 4.1 Code 4.2 Result 5 See also

[change] Blank

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

[change] Parameters

[change] 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.

[change] 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.

[change] 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.

See also Wikipedia:NavFrame.

[change] Example

[change] 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]]
}}

[change] Result

[change] See also

Navigation template comparison

view • talk • edit	collapsible	Header color†	Image	Groups	Style (body) parameter/s	Examples
{{Navbox}}	collapsible	navbox	Left/right of body	Yes	Yes	{{USCongress}}, {{Apollo program}}
{{Navbox with columns}}	collapsible	navbox	Left/right of columns	No	Yes	{{Current U.S. Senators}}, {{UK subdivisions}}
† 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	Default header color	Font size
Collapsible tables	collapsible, navbox	2 or more autocollapse on page	Yes	Yes	#ccccff	90%