Template:Navigation/doc

From Wikipedia, the free encyclopedia

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 hardcoded page names or URLs.

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

Contents 1 Usage 1.1 Blank 1.2 Parameters 1.2.1 Mandatory 1.2.2 Optional 2 Example 2.1 Code 2.2 Result 3 See also

[edit] Usage

---

To apply this template, you can start by copy-and-pasting the following code and then provide arguments:

[edit] Blank

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

[edit] Parameters

---

[edit] 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 parameter's contents.

body

The material contained by the template, usually a list or list of links. Format is inline.

[edit] Optional

color

Background color of the titlebar. NB Care/consensus needed when using this parameter as multiple navigational templates on one page using different titlebar colors is likely to look unpleasant.

cat

(or "category") The category or categories to which a page sporting the template will become a member.

[edit] Example

---

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

[edit] Result

[edit] See also

v • d • e Root navigational templates
Collapsible using NavFrame	{{Navigation}} · {{Navigation with image}} · {{Dynamic navigation box with image}}
Collapsible using collapsible	{{Dynamic navigation box}}
Grouped items, collapsible using collapsible	{{Navbox generic}}
Non-collapsable	{{NavigationBox}} (Image breaks titlebar; template deprecated? David Kernow (talk) 02:23, 29 November 2006 (UTC))
On Commons	{{NavigationBox}} · {{Dynamic navigation box}} · {{Dynamic navigation box with image}}