Template:Navbox Automatic Groups/doc

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

Generates multiple Navbox group/list rows from a semicolon separated group list. Supports normal custom lists and dynamically generated Navbox DPL lists.

Do not use as standalone template, insert in a {{Navbox}} using automatic_groups parameter.

Syntax

{{Navbox Automatic Groups
|base = Base Group
|grous = Semicolon separated List
|list = plain text
|list_type = dpl
}}

base : The base group used by [nogroup]. Required when [nogroup] is present.
groups : A semicolon-seFted list of groups to generate. Use [nogroup] to create a list row without a group label. The [nogroup] entry uses base as its group value.
list_type : Sets the type of list to generate. When set to dpl, the module constructs and expands a {{Navbox DPL}} call using the remaining parameters. If omitted or set to another value, list is used instead.
list : The default content for each generated list. In normal mode, %%group%% is replaced with the current group name.
- list_<group> : Overrides list for a specific group. The group name is matched case-insensitively. For [nogroup], use list_nogroup.
category : In dpl mode, the DPL category to query. %%group%% is replaced with the current group name.
uses : In dpl mode, passed to {{Navbox DPL}} as the uses parameter.
format : In dpl mode, passed to {{Navbox DPL}} as the format parameter.
start : The number of the first generated Navbox row. Defaults to 1.

DPL parameters

When list_type is used, parameters other than groups, base, list, list_type, start, and list_<group> overrides are passed to {{Navbox DPL}}. This allows other {{Navbox DPL}} parameters to be used without additional support in this module.

The %%group%% placeholder can be used in DPL parameters and is replaced with the current group name.

For [nogroup], the module automatically adds not1, not2, etc. for all named groups, so those exclusions do not need to be specified manually.

Examples

Basic

{{Navbox Automatic Groups
|base = Headwear
|groups = Hat;Head Accessory;Helmet;[nogroup]
|list = TEST %%group%%
}}

Using DPL

{{Navbox Automatic Groups
|groups = Hat;Head Accessory;Helmet;[nogroup]
|base = Headwear
|list_type = dpl
|category = Clothing Items by Quality<&>%%group%%
|uses = Template:Clothing Infobox
|format = card
}}

Template Data

Generates multiple Navbox group/list rows from a semicolon-seFted group list. Supports normal custom lists and dynamically generated Navbox DPL lists.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Base	`base`	Base group used by [nogroup]. Required when [nogroup] is present.	String	optional
Groups	`groups`	Semicolon-seFted list of groups to generate. Use [nogroup] for a generated row without a group label.	String	required
List	`list`	Default content for each generated list. In normal mode, %%group%% is replaced with the current group name.	Content	optional
List type	`list_type`	Set to dpl to construct and expand a Navbox DPL list. If omitted or set to another value, the list parameter is used.	String	optional
Category	`category`	DPL category. Used when list_type is dpl. %%group%% is replaced with the current group name.	String	optional
Uses	`uses`	Passed to Navbox DPL as the uses parameter when list_type is dpl.	String	optional
Format	`format`	Passed to Navbox DPL as the format parameter when list_type is dpl.	String	optional
Start	`start`	Index of the first generated Navbox row. Defaults to 1. Default 1	Number	optional
Group list override	`list_<group>`	Overrides the default list for a specific group. Replace <group> with the group name, for example list_Hat or list_nogroup.	Content	optional