[edit] [history] [purge] Documentation Template documentation

This documentation is transcluded from Template:Navbox/doc.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardizes the title and contents of the box. In general, it SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardize certain attributes of all navigation boxes, for example, their colors and other CSS attributes. While at the moment the template is simple, in the future it could be extended to add other features. Using this template now allows changes like this to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
 | name    = mandatory — name of the template
 | state   = uncollapsed, collapsed, plain, autocollapse (default)
 | title   = mandatory — template header
 | tstyle  = optional — style of header; i.e. color, background-color, etc.
 | gtitleN = optional — title of N-th group of items
 | styleN  = optional — style; i.e. line-height, font-size, etc.
 | groupN  = mandatory — list of items
}}
  • Groups: Currently, the maximum number of groups allowed is 15.
    • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
  • Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
  • Group style: Style may also be customized to each group in: style1, style2, style3, ... up to styleN.
  • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
  • Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
  • Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}) in place of actual pipes between items, otherwise the template will ignore text after the first pipe.
  • Bullets: It is highly recommended that Template:* ({{*}}) be used instead. This adds a bullet () instead of a pipe.

States

  • Uncollapsed (default): Forces the navbox to be displayed.
    • All of the navboxes in this documentation are in the uncollapsed state.
  • Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
  • Plain: Causes the navbox to not be collapsible at all.

Sub-groups

  • For larger navboxes, it may be necessary to include sub-groups within a particular group of items. This template allows the creation of sub-groups within {{navbox}}, provided that certain parameters are included:
    • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = Yes). This enables the template to differentiate between the nested and the parent navbox.
    • The parent navbox group (i.e. group2 in the example below) requires the style parameter (style2 = padding:0). This fixes the "padding" bug that occurs when sub-groups are used.

Syntax

{{navbox
 | name    =
 | state   = 
 | title   =
 | gtitle1 =
 | group1  =
 | gtitle2 =  
 | style2  = padding:0 (mandatory)
 | group2  = 
   {{navbox
   | subgroup = Yes (mandatory)
   | gtitle1  = 
   | group1   =
   | gtitle2  = 
   | group2   = 
   }}
}}

Examples

Use of style; without group title

{{navbox
 | name    = Title
 | title   = Title
 | style1  = text-align:center
 | group1  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
}}

produces:

Multiple groups

{{navbox
 | name    = Title
 | title   = Title
 | gtitle1 = Group1
 | group1  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
 | gtitle2 = Group2
 | group2  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
 | gtitle3 = Group3
 | group3  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link) 
 | gtitle4 = Group4
 | group4  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
 | gtitle5 = Group5
 | group5  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
}}

produces:


Sub-groups

{{navbox
 | name    = Title
 | title   = Title
 | gtitle1 = Group1
 | group1  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
 | gtitle2 = Group2
 | group2  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
 | gtitle3 = Group3
 | group3  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
 | gtitle4 = Group4
 | style4  = padding:0
 | group4  =
   {{navbox
   | subgroup = Yes
   | gtitle1  = Group1
   | group1   = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
   | gtitle2  = Group2
   | group2   = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
   | gtitle3  = Group3
   | group3   = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
   }}
 | gtitle5 = Group5
 | group5  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
 | gtitle6 = Group6
 | group6  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
}}

produces:

Collapsed navbox

{{navbox
 | name    = Title
 | state   = collapsed
 | title   = Title
 | style1  = text-align:center
 | group1  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
}}

produces:

Plain navbox with Tnavbar

{{navbox
 | name    = Title
 | state   = plain
 | title   = Title
 | style1  = text-align:center
 | group1  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
}}

produces:

Plain navbox without Tnavbar

{{navbox
 | state   = collapsed
 | title   = Title
 | style1  = text-align:center
 | group1  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
}}

produces:

Navbox with title style

{{navbox
 | name    = Title
 | title   = Title
 | tstyle  = color:green
 | style1  = text-align:center
 | group1  = Item1 (link) {{*}} Item2 (link) {{*}} Item3 (link) {{*}} Item4 (link) {{*}} Item5 (link)
}}

produces: