Template:Navigation/doc

From Wikipedia

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.

Contents

[edit] Blank syntax (basic)

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

[edit] Parameters

Deprecated parameter names are given in parentheses.

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

[edit] 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 Template:Nobold 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.

[edit] Example

[edit] Code

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

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

}}

[edit] Result

[edit] See also

Navigation template comparison
view  talk  edit
collapsible Header color Image Groups Style (body)
parameter/s
Example
{{Navigation}} Template:Yes2 NavFrame NavHead Template:No Template:No Template:Yes {{OPEC}}
{{Navigation with image}} Template:Yes2 NavFrame NavHead Template:Yes2 Left/right of body Template:No Template:Yes {{HolmesNovels}}
{{Navigation with columns}} Template:Yes2 NavFrame NavHead Template:No Template:No Template:Yes
{{Dynamic navigation box}} Template:Yes2 collapsible navbox Template:No Template:No Template:Yes {{CSUHeads}}
{{Dynamic navigation box with image}} Template:Yes2 NavFrame NavHead Template:Yes2 Upper left Template:No Template:No {{SlovakPMs}}
{{Navbox generic}} Template:Yes2 collapsible navbox Template:Yes2 Right-hand side Template:Yes Template:Yes {{Dilbert}}
{{NavigationBox}} Template:No navbox Template:Yes2 Right of title+body Template:No Template:No {{EPA}}
{{Commons:NavigationBox}} Template:No #ccccff Template:Yes2 Right of title+body Template:No Template:No
{{Commons:Dynamic navigation box}} Template:Yes2 NavFrame #ccccff Template:No Template:No Template:No
{{Commons:Dynamic navigation box with image}}  Template:Yes2 NavFrame #ccccff Template:Yes2 Upper left Template:No Template: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 Template:No Template:Yes #ccccff 95%
Collapsible table collapsible, navbox 2+ of the same Template:Yes Template:Yes #ccccff 90%

For the technically minded, see Common.css and Common.js.