Editing Template:Navbox Automatic Groups/doc

{{Documentation/Header}}
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 {{T|Navbox}} using {{F|automatic_groups}} parameter.

==Syntax==
{{T|Navbox Automatic Groups|v1=base=Base Group|v2=grous=Semicolon separated List|v3=list=plain text|v4=list_type|v5=|v6=|v7=|v8=|block=1}}
* {{F|base}} : The base group used by {{F|[nogroup]}}. Required when {{F|[nogroup]}} is present.
* {{F|groups}} : A semicolon-seFted list of groups to generate. Use {{F|[nogroup]}} to create a list row without a group label. The {{F|[nogroup]}} entry uses {{F|base}} as its group value.
* {{F|list_type}} : Sets the type of list to generate. When set to {{F|dpl}}, the module constructs and expands a {{t|Navbox DPL}} call using the remaining parameters. If omitted or set to another value, {{F|list}} is used instead.
* {{F|list}} : The default content for each generated list. In normal mode, {{F|%%group%%}} is replaced with the current group name.
** {{F|list_<group>}} : Overrides {{F|list}} for a specific group. The group name is matched case-insensitively. For {{F|[nogroup]}}, use {{F|list_nogroup}}.
* {{F|category}} : In {{F|dpl}} mode, the DPL category to query. {{F|%%group%%}} is replaced with the current group name.
* {{F|uses}} : In {{F|dpl}} mode, passed to {{t|Navbox DPL}} as the {{F|uses}} parameter.
* {{F|format}} : In {{F|dpl}} mode, passed to {{t|Navbox DPL}} as the {{F|format}} parameter.
* {{F|start}} : The number of the first generated Navbox row. Defaults to {{F|1}}.

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

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

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

==Examples==
===Basic===
{{T|Navbox Automatic Groups|p1=base=Headwear|p2=groups=Hat;Head Accessory;Helmet;[nogroup]|p3=list=TEST %%group%%|block=1}}

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

===Using DPL===
{{T|Navbox Automatic Groups|p1=groups=Hat;Head Accessory;Helmet;[nogroup]|p2=base=Headwear|p3=list_type=dpl|p4=category=Clothing Items by Quality<&>%%group%%|p5=uses=Template:Clothing Infobox|p6=format=card|block=1}}

{{Navbox
|title = Test
|automatic_groups = {{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==
<!--
Edit the Template Data through the "MANAGE TEMPLATEDATA" button at the top left
--><templatedata>
{
	"params": {
		"groups": {
			"label": "Groups",
			"description": "Semicolon-seFted list of groups to generate. Use [nogroup] for a generated row without a group label.",
			"required": true,
			"type": "string"
		},
		"base": {
			"label": "Base",
			"description": "Base group used by [nogroup]. Required when [nogroup] is present.",
			"type": "string"
		},
		"list": {
			"label": "List",
			"description": "Default content for each generated list. In normal mode, %%group%% is replaced with the current group name.",
			"type": "content"
		},
		"list_type": {
			"label": "List type",
			"description": "Set to dpl to construct and expand a Navbox DPL list. If omitted or set to another value, the list parameter is used.",
			"type": "string"
		},
		"category": {
			"label": "Category",
			"description": "DPL category. Used when list_type is dpl. %%group%% is replaced with the current group name.",
			"type": "string"
		},
		"uses": {
			"label": "Uses",
			"description": "Passed to Navbox DPL as the uses parameter when list_type is dpl.",
			"type": "string"
		},
		"format": {
			"label": "Format",
			"description": "Passed to Navbox DPL as the format parameter when list_type is dpl.",
			"type": "string"
		},
		"start": {
			"label": "Start",
			"description": "Index of the first generated Navbox row. Defaults to 1.",
			"type": "number",
			"default": "1"
		},
		"list_<group>": {
			"label": "Group list override",
			"description": "Overrides the default list for a specific group. Replace <group> with the group name, for example list_Hat or list_nogroup.",
			"type": "content"
		}
	},
	"description": "Generates multiple Navbox group/list rows from a semicolon-seFted group list. Supports normal custom lists and dynamically generated Navbox DPL lists.",
	"paramOrder": [
		"base",
		"groups",
		"list",
		"list_type",
		"category",
		"uses",
		"format",
		"start",
		"list_<group>"
	],
	"format": "block"
}
</templatedata>