Template:Navbox/doc

< Template:Navbox
Revision as of 20:04, 11 November 2014 by Ngng (talk | contribs) (better example in documentation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This template is taken from Wikipedia (with some changes), see full documentation on it in wikipedia.

Some highlights:

Please remove the parameters that are left blank.

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

| above      =
| image      =

| group1     =
| list1      =

| group2     =
| list2      =
 ...
| group20    =
| list20     =

| below      =
}}

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 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. Typically it is purely decorative, so it should be coded as [[File:XX.jpg|80px|link=|alt=]].
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 starts at left of box).
listn – text listing wikilinks using a wikilist format.
below – optional text to appear below the group/list section.


Usage example

{{Navbox
| name = Navbox/doc
| title = ''Ratchet & Clank'' series
| state = {{{state|expanded}}}
| listclass = hlist

| group1 = Original series
| list1 = 
* ''[[Ratchet & Clank]]''
* ''[[Ratchet & Clank: Going Commando|Going Commando]]''
* ''[[Ratchet & Clank: Up Your Arsenal|Up Your Arsenal]]''
* ''[[Ratchet: Deadlocked|Deadlocked]]''
* ''[[Ratchet & Clank: Size Matters|Size Matters]]''

| group2 = ''Future'' series
| list2 = 
* ''[http://en.wikipedia.org/wiki/Ratchet_%26_Clank_Future:_Tools_of_Destruction Tools of Destruction]'' (PS3)
* ''[http://en.wikipedia.org/wiki/Ratchet_%26_Clank_Future:_Quest_for_Booty Quest for Booty]'' (PS3)
* ''[http://en.wikipedia.org/wiki/Ratchet_%26_Clank_Future:_A_Crack_in_Time A Crack in Time]'' (PS3)
* ''[http://en.wikipedia.org/wiki/Ratchet_%26_Clank:_Into_the_Nexus Into the Nexus]'' (PS3)

| group3 = Reboot series
| list3 = 
* ''[http://en.wikipedia.org/wiki/Ratchet_%26_Clank_%282015_video_game%29 Ratchet & Clank]'' (PS4)

| group4 = Spin-offs
| list4 = 
* ''[http://en.wikipedia.org/wiki/Ratchet_%26_Clank:_Going_Mobile Going Mobile]'' (Mobile)
* ''[[Secret Agent Clank]]''
* ''[http://en.wikipedia.org/wiki/Ratchet_%26_Clank:_All_4_One All 4 One]'' (PS3)
* ''[http://en.wikipedia.org/wiki/Ratchet_%26_Clank:_Full_Frontal_Assault Full Frontal Assault]'' (PS3, Vita)

| group5 = Related
| list5 = 
* [[Insomniac Games]]
* [[High Impact Games]]
* [[Sanzaru Games]]
}}