Template:Navigation/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for Template:Navigation (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.
The template {{Navigation/doc}} is deprecated. Please use {{Navigation}} instead.
This usage is deprecated. Please replace it with {{tdeprecated|Navigation/doc|Navigation}}.
The template {{Navigation}} is deprecated. Please use {{Navbox}} instead.

{{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 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.

[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

v • d • e
Countries of Central Asia

[edit] 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}}, {{Solar System}}
{{Navbox with columns}} collapsible navbox Left/right of columns No Yes {{Current U.S. Senators}}, {{Czech lands}}
{{Navbox with collapsible groups}} collapsible navbox Left/right of body and/or in each list Yes Yes {{University of Michigan}}, {{Scouting}}
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