View source for Template:BadgeInfobox/doc

{{template|BadgeInfobox}} is the infobox for badges.

==Usage==
Infoboxes should be used at the beginning of the page, before any introductory text.

===Parameters===
All parameters are case sensitive.

{| class="wikitable" style="background: #e5f1ec; margin:auto"
|- 
! style="background: #d1e5d9" | Parameter
! style="background: #d1e5d9" | Allowed values
! style="background: #d1e5d9" | Notes
|-
|! name
| ''String''
| The name of the badge in English
|-
| jname
| ''String''
| The name of the badge in Japanese
|-
| jtrans
| ''String''
| The translation of the Japanese name
|-
| color
| ''[[Help:Color templates|Color template]] name''
| The color of the background elements of the infobox, usually the dominant type of the Gym the badge belongs to
|-
| image
| ''Filename''
| The name of the image to use for this badge, if the default <code>&lt;name&gt;.png</code> is not adequate
|-
| size
| ''Filesize''
| The size to set the image to
|-
| caption
| ''String''
| A caption for the image
|-
| giver
| ''String''
| The name of the person who gives this badge. Only works if there's only one giver, and if their article title is exactly their name; otherwise, use <code>&lt;givers&gt;</code>
|-
| givers
| ''Wikitext''
| Overrides the giver parameter to input any wikitext for the Givers data
|-
| cap
| ''String''
| The maximum level of Pokémon that will obey the player after obtaining this badge
|-
| move
| ''String''
| The name of the field move that can be used outside of battle after obtaining this badge; if there is no such move, do not use this field
|-
| tmhm
| ''String''
| The name of the HM or TM that grants the field move
|-
| fieldmove
| ''Wikitext''
| Custom wikitext for the Field move data, if a single field move and HM/TM is not adequate
|-
| stat
| <code>Attack</code> • <code>Defense</code> • <code>Special Attack</code> • <code>Special Defense</code> • <code>Speed</code>
| The stat(s) that is increased upon obtaining this badge; if no stat is increased, do not use this parameter
|-
| prev
| ''String''
| The manual link to the badge that comes before this one. The order can usually be seen on Trainer Cards. If this is the first badge, do not use this parameter
|-
| next
| ''String''
| The manual link to the badge that comes after this one. The order can usually be seen on Trainer Cards. If this is the last badge, do not use this parameter
|}

===TemplateData===
<templatedata>
{
	"params": {
		"name": {
			"label": "Badge name",
			"description": "The name of the badge in English",
			"type": "line",
			"required": true
		},
		"jname": {
			"label": "Badge name (JP)",
			"description": "The name of the badge in Japanese",
			"type": "string",
			"required": true
		},
		"jtrans": {
			"label": "Translated name",
			"description": "The translation of the Japanese name",
			"type": "string",
			"required": true
		},
		"image": {
			"label": "Image",
			"description": "The name of the image to use for this badge, if the default <name>.png is not adequate",
			"type": "wiki-file-name",
			"default": "<name>.png",
			"suggested": true
		},
		"size": {
			"label": "Image size",
			"description": "The size to set the image to",
			"type": "line",
			"default": "100px"
		},
		"caption": {
			"label": "Image caption",
			"description": "A caption for the image",
			"type": "string",
			"suggested": true
		},
		"givers": {
			"label": "Custom givers",
			"description": "Overrides the giver parameter to input any wikitext for the Givers data",
			"type": "string"
		},
		"giver": {
			"label": "Giver",
			"description": "The name of the person who gives this badge. Only works if there's only one giver, and if their article title is exactly their name; otherwise, use <givers>",
			"type": "line",
			"suggested": true
		},
		"cap": {
			"label": "Obedience cap",
			"description": "The maximum level of Pokémon that will obey the player after obtaining this badge",
			"type": "string",
			"suggestedvalues": [
				"No change",
				"Lv. 20",
				"Lv. 30",
				"Lv. 40",
				"Lv. 50",
				"Lv. 60",
				"Lv. 70",
				"Lv. 80",
				"Lv. 90",
				"Lv. 100"
			],
			"default": "Lv. 100",
			"required": true
		},
		"fieldmove": {
			"label": "Custom field move",
			"description": "Custom wikitext for the Field move data, if a single field move and HM/TM is not adequate",
			"type": "string",
			"default": "{{m|<move>}} ([[<tmhm>]])"
		},
		"move": {
			"label": "Field move",
			"description": "The name of the field move that can be used outside of battle after obtaining this badge; if there is no such move, do not use this field",
			"type": "string",
			"suggestedvalues": [
				"Cut",
				"Defog",
				"Dive",
				"Flash",
				"Fly",
				"Rock Climb",
				"Rock Smash",
				"Strength",
				"Surf",
				"Waterfall",
				"Whirlpool"
			],
			"suggested": true
		},
		"stat": {
			"label": "Increased stats",
			"description": "The stat(s) that is increased upon obtaining this badge; if no stat is increased, do not use this parameter",
			"type": "line",
			"suggestedvalues": [
				"Attack",
				"Defense",
				"Special Attack, Special Defense",
				"Speed"
			],
			"suggested": true
		},
		"tmhm": {
			"label": "HM/TM",
			"description": "The name of the HM or TM that grants the field move",
			"type": "string",
			"suggested": true
		},
		"prev": {
			"label": "Previous badge",
			"description": "The link to the badge that comes before this one. The order can usually be seen on Trainer Cards. If this is the first badge, do not use this parameter",
			"type": "line",
			"suggested": true
		},
		"next": {
			"label": "Next badge",
			"description": "The link to the badge that comes after this one. The order can usually be seen on Trainer Cards. If this is the last badge, do not use this parameter",
			"type": "line",
			"suggested": true
		},
		"color": {
			"label": "Background color",
			"description": "The color of the background elements of the infobox, usually the dominant type of the Gym the badge belongs to",
			"type": "line",
			"suggestedvalues": [
				"Bug",
				"Dark",
				"Dragon",
				"Electric",
				"Fairy",
				"Fighting",
				"Fire",
				"Flying",
				"Ghost",
				"Grass",
				"Ground",
				"Ice",
				"Normal",
				"Poison",
				"Psychic",
				"Rock",
				"Steel",
				"Water"
			],
			"required": true
		}
	},
	"description": "Displays basic information about a badge",
	"paramOrder": [
		"name",
		"jname",
		"jtrans",
		"color",
		"image",
		"size",
		"caption",
		"giver",
		"givers",
		"cap",
		"move",
		"tmhm",
		"fieldmove",
		"stat",
		"prev",
		"next"
	],
	"format": "block"
}
</templatedata>

==Examples==
{{BadgeInfobox
|name=Boulder Badge
|jname=グレーバッジ
|jtrans=Gray Badge
|color=rock
|giver=Brock
|move=Flash
|tmhm=HM05
|cap=Lv. 20{{sup/7|PE}}
|stat=Attack{{sup/1|RGBY}}{{sup/3|FRLG}}
|next=[[Cascade Badge]]
}}
<pre>
{{BadgeInfobox
|name=Boulder Badge
|jname=グレーバッジ
|jtrans=Gray Badge
|color=rock
|giver=Brock
|move=Flash
|tmhm=HM05
|cap=Lv. 20{{sup/7|PE}}
|stat=Attack{{sup/1|RGBY}}{{sup/3|FRLG}}
|next=[[Cascade Badge]]
}}
</pre>
{{-}}
{{BadgeInfobox
|name=Basic Badge
|jname=ベーシックバッジ
|jtrans=Basic Badge
|color=normal
|givers=[[Lenora]]{{sup/5|BW}}<br>[[Cheren]]{{sup/5|B2W2}}
|cap=Lv. 30{{sup/5|BW}}<br>Lv. 20{{sup/5|B2W2}}
|prev=[[Trio Badge]]{{sup/5|BW}}
|next=[[Insect Badge]]{{sup/5|BW}}<br>[[Toxic Badge]]{{sup/5|B2W2}}
}}
<pre>
{{BadgeInfobox
|name=Basic Badge
|jname=ベーシックバッジ
|jtrans=Basic Badge
|color=normal
|givers=[[Lenora]]{{sup/5|BW}}<br>[[Cheren]]{{sup/5|B2W2}}
|cap=Lv. 30{{sup/5|BW}}<br>Lv. 20{{sup/5|B2W2}}
|prev=[[Trio Badge]]{{sup/5|BW}}
|next=[[Insect Badge]]{{sup/5|BW}}<br>[[Toxic Badge]]{{sup/5|B2W2}}
}}
</pre>
{{-}}
{{BadgeInfobox
|name=Star Badge
|jname=ダンバッジ
|jtrans=Team Badge
|image=SVbadge StarfallStreet Fighting.png
|color=fighting
|giver=Eri
|cap=No change
|prev=[[Titan Badge (Dragon)]]
}}
<pre>

{{BadgeInfobox
|name=Star Badge
|jname=ダンバッジ
|jtrans=Team Badge
|image=SVbadge StarfallStreet Fighting.png
|color=fighting
|giver=Eri
|cap=No change
|prev=[[Titan Badge (Dragon)]]
}}
</pre>

<noinclude>
[[Category:Documentation templates]]
</noinclude>