Template:Navigation bar/doc

This is a documentation subpage for Template:Navigation bar.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used in MediaWiki:Categoriespagetext.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

This template can only be edited by administrators because it is transcluded onto one or more cascade-protected pages.

This template is a navigational template intended to be used to generate a scrollable navigation "bar", rather than a navigation box, in cases where there are a long list of items with a natural ordering (for example, alphabetical or numerical) that as a box would consume a large amount of vertical space in an article. Navigation bars currently do not appear in printed copies of articles.

When creating a template using this one, please add it to Category:Templates using navigation bars by adding the following code:

<noinclude>[[Category:Templates using navigation bars|{{PAGENAME}}]]&lt;/noinclude>

Usage

{{navigation bar
| color =
| title =
| list =
| category =
}}

Mandatory arguments

title: A title for the navigation bar; may include links
list: Single line of text (no tables, no expanded templates) with links to related articles with no embedded line breaks; links may be separated, for instance, by commas, bullets, or pipe symbols. To use pipe symbols (vertical bars) as a separator, template:! must be used since "|" has meaning within a template invocation. The syntax for displaying a pipe-character is {{!}}. If you want to use several lines simply surround each line with div tags (following example only uses one div).

{{Navigation bar
| title = Sample
| list = <div>
item 1  -  item 2  -  item 3  -  item 4  -   item 5  - 
item 6  -  item 7  -  item 8  -  item 9  -   item 10 - 
item 11 -  item 12 -  item 13 -  item 14 -   item 15 - 
item 16 -  item 17 -  item 18 -  item 19 -   item 20 
</div>
}}

which produces

Sample

item 1 - item 2 - item 3 - item 4 - item 5 - item 6 - item 7 - item 8 - item 9 - item 10 - item 11 - item 12 - item 13 - item 14 - item 15 - item 16 - item 17 - item 18 - item 19 - item 20

Optional arguments

color: The color to use for the title bar. This color parameter defaults to the color shown in the {{{title}}} line above.
category: A category all articles using this template will be added to.

Usage

Mandatory arguments

Optional arguments

See also