Template:Navbox/doc

This is the documentation page for Navbox. It contains usage information, categories, and other content not part of the original template page.
Main	Documentation	Draft	Usage

This template uses Module:Navbox, a script written in Lua.

This template uses CSS found at MediaWiki:Gadget-Navbox.css.

Template that creates a standard navigation box.

• For full documentation: RANGER navboxes
• For the full list of supported parameters: Template:Navbox

Syntax

{{Navbox
|title = 
|striped = even
|editlinks = off
|group1 = 
|list1 = 
|group2 = 
|list2 = 
}}

Examples

Multiple subgroups

{{Navbox
|title = Items
|striped = even
|editlinks = off
|above = Some items are restricted to specific classes; see Classes for more information.
|below = Update 1.2
|below_class = align-right

|group1 = Consumables
|list1 =
* Health Potion
* Mana Potion

|group2 = Weapons
|group2.1 = Swords
|list2.1 =
* Wooden Sword
* Rusted Sword
* Steel Sword
|group2.2 = Bows
|list2.2 =
* Shortbow
* Crossbow
* Longbow
}}

Items

Some items are restricted to specific classes; see Classes for more information.

Consumables

• Health Potion
• Mana Potion

Weapons

Swords

• Wooden Sword
• Rusted Sword
• Steel Sword

Bows

• Shortbow
• Crossbow
• Longbow

Update 1.2

Multiple expands/collapses in a single container

{{Navbox
|title = Items
|striped = even
|editlinks = off

|header1 = Consumables
|header1.1 = Potions
|list1.1 =
* Revitalizing Potion
* Teleport Potion
|group1.1.1 = Health
|list1.1.1 =
* Health Potion
* Large Health Potion
* Elixir of Healing
|group1.1.2 = Mana
|list1.1.2 =
* Mana Potion
* Large Mana Potion
* Elixir of Magic
|header1.2 = Scrolls
|list1.2 =
* Scroll of Poison

|header3 = Weapons
|state3 = collapsed
|group3 = Swords
|list3 =
* Wooden Sword
* Rusted Sword
* Steel Sword
|group4 = Bows
|list4 =
* Shortbow
* Crossbow
* Longbow
|group5 = Staves
|list5 =
* Basic Staff
* Wizard's Staff
}}

Items

Consumables

Potions

• Revitalizing Potion
• Teleport Potion

Health

• Health Potion
• Large Health Potion
• Elixir of Healing

Mana

• Mana Potion
• Large Mana Potion
• Elixir of Magic

Scrolls

• Scroll of Poison

Weapons

Swords

• Wooden Sword
• Rusted Sword
• Steel Sword

Bows

• Shortbow
• Crossbow
• Longbow

Staves

• Basic Staff
• Wizard's Staff

Template Data

Template that creates a standard navigation box.

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
Title	title	Text that appears at the top of the navbox.	String	suggested
Striped	striped evenodd	Controls if the navbox rows should have zebra striping on even or odd rows, making it easier for users to distinguish two rows apart from each other. If sections are used, each section resets the even/odd counter. Example y, yes, on, striped, event, swap, odd	String	suggested
Edit Link	editlinks	Controls if an edit icon should be displayed at the top-left of the navbox, making it easier for users to interact with the template itself. Example off, no	String	optional
State	state collapsible	Controls if a navbox should be expanded or collapsed when the page loads. This only affects the whole navbox; if sections are used, they are treated differently. Default expanded Example expanded, collapsed, off, no, plain	String	optional
Header n	headern header1 header2 header3	Text that appears at the top of the section, where n is any positive integer.	Unbalanced wikitext	optional
Group n	groupn group1 group2 group3	Text label for a list, which appears on the left on desktop or at the top on mobile, where n is any positive integer.	Unbalanced wikitext	optional
List n	listn list1 list2 list3	A wikitext list, where n is any positive integer.	Unbalanced wikitext	optional
Group n.x	groupn.x group1.1 group1.2 group2.1.1	Text label for sub-lists that appear under groupn, groupn.x, etc.	Unbalanced wikitext	optional
List n.x	listn.x list1.1 list1.2 list2.1.1	Wikitext sub-lists.	Unbalanced wikitext	optional