View source for Template:Navbox generic/doc

<noinclude>{{note|This is a documentation subpage for [[Template:Navbox generic]]}}<hr></noinclude>

=Template documentation=
This template allows creation Navbox, to facilitate navigation between related articles. So instead of adding list of see also links, we place Navbox template that can be updated in from a central place.

==Blank template==
<pre>{{Navbox 
|name       =
|title      =  

|group1     =  
|list1      =   
|group2     =  
|list2      =   
... 
|group20    =  
|list20     =   

|below      =  
</pre>

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

:<code>name -</code> the name of the template.
:<code>title -</code> text in the title bar, such as: <nowiki>[[Widget stuff]]</nowiki>.
:<code>state - </code> controls when a navbox is expanded or collapsed.

:<code>image - </code>an optional right-side image, coded as the whole image.<code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|90px|link=|alt=]]</nowiki></code>.

:<code>above - </code>text to appear above the group/list section (could be a list of overall wikilinks).
:<code>group<sub>n</sub> - </code>the left-side text before list-n (if group-n omitted, list-n starts at left of box).
:<code>list<sub>n</sub> - </code>text listing wikilinks, often separated by middot templates, such as: [<font/>[A]]<code>{<font/>{·}}</code> [<font/>[B]]
:<code>below - </code>optional text to appear below the group/list section.


==Additional Parameter==
:<code>titlestyle - </code>a CSS style for the title-bar, such as: <code>background:gray;</code>
:<code>groupstyle - </code>a CSS style for the group-cells, such as: <code>background:#eee;</code>
:<code>oddstyle</code> , <code>evenstyle - </code> Applies to odd/even list numbers.  Overrules styles defined by ''liststyle''.
:<code>list<sub>n</sub>style - </code>

:<code>abovestyle - </code>
:<code>bodystyle  - </code>
:<code>imagestyle - </code>
:<code>belowstyle - </code>



:; ''state''<nowiki>*</nowiki> <span style="font-weight:normal;">[<code>autocollapse, uncollapsed, collapsed, plain, off</code>]</span>
:* Defaults to <code>autocollapse</code>. A navbox with <code>autocollapse</code> will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the navbox will be expanded. For the technically minded, see [[MediaWiki:Common.js]].
:* If set to <code>collapsed</code>, the navbox will always start out in a collapsed state.
:* If set to <code>plain</code>, the navbox will always be expanded with no [hide] link on the right<!-- ,and the title will remain centered (by using padding to offset the <small>v • d • e</small> links).-->


== Examples ==
===Simple Example===
{{Navbox generic
|name = Navbox_generic/doc
|state = uncollapsed
|title = Simple Example
|group1 = Group1
|list1 = List1
|group2 = Group2
|list2 = List2
|group3 = Group3
|list3 = List3
}}
<pre>{{Navbox generic
|name = Navbox_generic/doc
|title = Simple Example
|group1 = Group1
|list1 = List1
|group2 = Group2
|list2 = List2
|group3 = Group3
|list3 = List3
}}</pre>

===Styles Example===
{{Navbox generic
|name = Navbox_generic/doc
|image = [[File:No image.jpg|100px|link=|alt=]]
|state = uncollapsed
|title = Styles Example

| group-style = width:100px; background-color:#ddd;
| odd-style  = background-color:#F2F2F2;

|group1 = Group1
|list1 = List1
|group2 = Group2
|list2 = List2
|group3 = Group3
|list3 = List3
}}
<pre>{{Navbox generic
|name = Navbox_generic/doc
|image = [[File:No image.jpg|100px|link=|alt=]]
|title = Styles Example

| group-style = width:100px; background-color:#ddd;
| odd-style  = background-color:#F2F2F2;

|group1 = Group1
|list1 = List1
|group2 = Group2
|list2 = List2
|group3 = Group3
|list3 = List3
}}</pre>

===Subgroups example===
This example shows how subgroups can be used.  

{{Navbox generic
|name = Navbox_generic/doc
|image = [[File:No image.jpg|100px|link=|alt=]]
|state = uncollapsed
|title = Multiple Subgroup Example
|above = Above
|below = Below

|group1 = Group1
|list1 = List1
|group2 = Group2
|list2 = 
 {{Navbox subgroup
  |evenodd = swap
  |group1 = Group2.1
  |list1 = List1
  |group2 = Group2.2
  |list2 = List2
  |group3 = Group2.3
  |list3 = List3
 }}

|group3 = Group3
|list3 = List3

|group4 = Group4
|list4 = 
 {{Navbox subgroup
  |evenodd = swap
  |group1 = Group4.1
  |list1 = List1
  |group2 = Group4.2
  |list2 = List2
  |group3 = Group4.3
  |list3 = List3
 }}
}}

<pre>{{Navbox generic
|name = Navbox_generic/doc
|image = [[File:No image.jpg|100px|link=|alt=]]
|state = uncollapsed
|title = Multiple Subgroup Example
|above = Above
|below = Below

|group1 = Group1
|list1 = List1
|group2 = Group2
|list2 = 
 {{Navbox subgroup
  |evenodd = swap
  |group1 = Group2.1
  |list1 = List1
  |group2 = Group2.2
  |list2 = List2
  |group3 = Group2.3
  |list3 = List3
 }}

|group3 = Group3
|list3 = List3

|group4 = Group4
|list4 = 
 {{Navbox subgroup
  |evenodd = swap
  |group1 = Group4.1
  |list1 = List1
  |group2 = Group4.2
  |list2 = List2
  |group3 = Group4.3
  |list3 = List3
 }}
}}</pre>


==See also==
* [[w:Template:Navbox|Wikipedia Navbox Template]], for additional refernce and documentation, Note that while this template was updated to have similar functionality and be more consistent with the Wikipidea sintax, they aren't exactly the same.


<noinclude>{{EnWP|Template:Navbox/doc|small=yes}}
<noinclude>[[Category:Navigational templates]]</noinclude>
</noinclude>