Template:Navbox/doc

From Uncyclopedia, the content-free encyclopedia
Jump to navigation Jump to search


See w:Template:Navbox for full documentation.

This template allows a navigational template to be set up relatively quickly by supplying it with one or more lists of links. It comes equipped with default styles that should work for most navigational templates. Changing the default styles is possible, but not recommended. Because Uncyclopedia users value appearance customizability and "looking cool" over practicality in their navboxes, most content navboxes on the site use {{Simple navbox}} instead.

Usage

Please remove the parameters that are left blank.

{{Navbox
| name       = {{subst:PAGENAME}}
| title      =
| listclass  = hlist
| state      = {{{state|}}}

| above      =
| image      =

| group1     =
| list1      =

| group2     =
| list2      =

| group3     =
| list3      =

<!-- ... -->

| below      =
}}<noinclude>
<!-- add a navbox category here -->
</noinclude>

Parameter list

The navbox uses lowercase parameter names, as shown in the box (above). The required name and title will create a one-line box if other parameters are omitted.

Notice "group1" (etc.) is optional, as are sections named "above/below".

The basic and most common parameters are as follows (see below for the full list):

  • name – the name (Wikipedia location) of the template.
  • title – text in the title bar, such as: [[Widget stuff]].
  • listclass – a CSS class for the list cells, usually hlist for horizontal lists. Alternatively, use bodyclass for the whole box.
  • state – controls when a navbox is expanded or collapsed.
  • titlestyle – a CSS style for the title-bar, such as: background: gray;
  • groupstyle – a CSS style for the group-cells, such as: background: #eee;
  • above – text to appear above the group/list section (could be a list of overall wikilinks).
  • image – an optional right-side image, coded as the whole image, such as: [[File:XX.jpg|80px|alt=Alternate text]]
  • imageleft – an optional left-side image (code the same as the "image" parameter).
  • groupn – the left-side text before list-n (if group-n omitted, list-n extends to the left edge of the box, and defaults to text-align:center styling).
  • listn – text listing wikilinks using a wikilist format.
  • below – optional text to appear below the group/list section.

See also