Template:Infobox/Documentation
Purpose
This template is used on most pages to display quick high-level information on the subject.
Usage
Place this template at the top of the article, below any {{Hatnotes}} or {{Amboxes}}. Use whichever parameters are applicable; all are optional.
All available parameters:
{{Infobox|type | name = | logo = | image = | caption = | title = | race = | gender = | trial = | occupation = | member = | purpose = | special = | number = | game = | series = | location = | locations = | coord = | launch distance = | occurrence = | quest = | dungeon = | scenario = | stage = | game type = | time limit = | conditions = | previous = | next = | simultaneous = | natseason = | boss = | miniboss = | enemies = | targets = | inhab = | characters = | members = | leader = | missions = | list = | list_header = | pointsint = | counterpart = | counterpart_header = | item = | teaches = | song = | skill = | memory = | memories = | materials = | fusion materials = | battlefield materials = | prereq = | shop = | minigame = | owner = | cost = | value = | rarity = | upgrade from = | upgrade to = | start = | objective = | obtain = | learn = | learn-img = | tell = | tell-img = | reward = | rew-img = | instrument = | perform = | use = | used by = | effect = | dyeable = | dye color = | enhanceable = | ingredients = | warriors = | allies = | recommended level = | threat = | attack = | weapon = | weaponused = | weaponavailable = | element = | recommended element = | power = | shown power = | fuse power = | shield damage = | defense = | shield guard = | health = | damage = | durability = | range = | best bonus = | set = | setbonus = | related = | ship = | platform_header = | date_header = | release = | release <platform1> = | release <platform2> = | ... | developer = | manufacturer = | published by = | publisher = | producer in chief = | producer = | director of production = | production editor = | production assistant = | director = | author = | writer = | writers = | translator = | reviewer = | supervisor = | editor in chief = | senior editors = | senior editor = | editors = | editor = | editorial consultants = | editing collaborators = | copy coordinator = | revisions = | fact checking = | technical advice = | game consulting = | game consultants = | art director = | art editor = | designers = | designer = | design = | concept and design = | concept = | layout = | artist = | illustrators = | illustrator = | cover = | cover design = | cover photography = | photographers = | photographer = | map creation = | contributors = | prepress = | composer = | arranged = | conductor = | performed by = | actor = | voice actor = | recording date = | in cooperation with = | project coordinators = | production coordinators = | production specialist = | host = | type = | founded = | model = | seasons = | episodes = | language = | album = | length = | track = | duration = | size = | weight = | color = | pieces = | quantity = | included with = | ISBN = | ISSN = | ASIN = | catalog = | wave = | seriesnumber = | SKU = | UPC = | EAN = | walkthrough = | guides = | gallery = | videos = | music = | date = | interviewee = | interviewer = | description = | source = | dept = | position = | born = | died = | age = | rank = | joindate = | website = | posts = | im = }}
- type — This defines the color of the title. See below for available types. (Optional.)
- name — This is only necessary if the title of the Infobox should be different from the title of the article. Examples include shortening game titles to their subtitles and removing parenthetical specifications (e.g. Hyrule Castle (Twilight Princess) has name=Hyrule Castle). (Optional. Default: article title)
- boxart — Used only for games and consoles, this overrides the
image
parameter. - member — Any organization(s) of which the subject is a member.
- related — Related subjects. For characters, specify the type of relation, e.g. "Talon (Father)" or "Talon (Boss)".
- threat — A number 1-10.
- attack — Attacks the enemy or boss may perform, including how much damage they do, using {{H}}.
- weapon — Effective weapons.
- release — Include as many
release
arguments as needed, in the formrelease <platform> = <date (using {{Region}})>
.release
by itself is for console release dates.
These defined types typically use the same parameters:
Armor
{{Infobox|armor | image = | caption = | game = | location = | quest = | item = | prereq = | shop = | cost = | used by = | effect = | dyeable = | enhanceable = | defense = | set = | setbonus = | related = | type = }}
Boss
{{Infobox|boss | image = | caption = | title = | race = | gender = | game = | location = | quest = | dungeon = | scenario = | reward = | threat = | attack = | weapon = | weaponused = | health = | related = }}
Character
{{Infobox|character | image = | caption = | title = | race = | gender = | occupation = | member = | game = | series = | location = | quest = | pointsint = | item = | teaches = | shop = | minigame = | related = }}
Dungeon
{{Infobox|dungeon | image = | caption = | game = | location = | locations = | coord = | quest = | boss = | miniboss = | enemies = | inhab = | item = | song = | skill = | memory = | prereq = | reward = | related = | walkthrough = }}
Enemy
{{Infobox|enemy | image = | caption = | threat = | attack = | game = | location = | upgrade from = | upgrade to = | weapon = | reward = | related = }}
Event
{{Infobox|event | image = | caption = | game = | location = | coordinates = | characters = | occurrence = | quest = | related = }}
Game
{{Infobox|game | name = | logo = | boxart = | caption = | release <platform1> = <date1> | release <platform2> = <date2> | ... | developer = | publisher = | producer = | director = | walkthrough = | guides = | gallery = | videos = | music = }}
Location
{{Infobox|location | image = | caption = | game = | location = | coord = | dungeon = | enemies = | inhab = | pointsint = | item = | song = | skill = | memory = | shop = | minigame = | materials = | quest = | counterpart = | related = }}
Group
{{Infobox|group | image = | caption = | game = | location = | leader = | purpose = | quest = | members = | related = }}
Item
{{Infobox|item | image = | caption = | game = | location = | prereq = | quest = | obtain = | cost = | shop = | minigame = | use = | used by = | fuse power = | enhanceable = | setbonus = | related = }}
Object
{{Infobox|object | image = | caption = | purpose = | special = | game = | locations = | quest = | pointsint = | item = | minigame = | use = | used by = | fuse power = | related = }}
Material
{{Infobox|material | image = | caption = | special = | game = | locations = | upgrade from = | upgrade to = | quest = | prereq = | shop = | cost = | value = | rarity = | obtain = | use = | effect = | dye color = | fuse power = | shield damage = | related = }}
Recipe
{{Infobox|recipe | image = | caption = | number = | game = | quest = | obtain = | cost = | value = | shop = | effect = | ingredients = | related = | type = }}
Weapon
{{Infobox|weapon | image = | caption = | number = | game = | locations = | upgrade from = | upgrade to = | quest = | fusion materials = | shop = | cost = | obtain = | used by = | element = | power = | shown power = | durability = | range = | best bonus = | related = | type = }}
Echo
{{Infobox|echo | image = | caption = | game = | location = | prereq = | quest = | obtain = | cost = | minigame = | health = | damage = | use = | used by = | enhanceable = | counterpart = | related = | type = | size = | height = | snap-to-grid = }}
Quest
{{Infobox|quest | image = | caption = | game = | location = | dungeon = | boss = | quest = | prereq = | start = | objective = | reward = | related = | type = }}
Shop
{{Infobox|shop | image = | caption = | game = | location = | coord = | occurrence = | quest = | inhab = | pointsint = | item = | owner = | related = | type = }}
Minigame
{{Infobox|minigame | image = | caption = | game = | location = | coord = | prereq = | owner = | cost = | objective = | reward = | related = }}
Race
{{Infobox|race | image = | caption = | special = | game = | location = | characters = | quest = | related = }}
Ring
{{Infobox|ring | image = | caption = | number = | location = | game = | location = | prereq = | effect = }}
Secret
{{Infobox|secret | image = | caption = | game = | location = | prereq = | learn = | learn-img = | tell = | tell-img = | reward = | rew-img = }}
Skill
{{Infobox|skill | image = | caption = | game = | location = | learn = | perform = | effect = | prereq = | related = }}
Song
{{Infobox|song | image = | caption = | game = | quest = | location = | instrument = | learn = | perform = | effect = | related = }}
Scenario
{{Infobox|scenario | name = | image = | caption = | number = | conditions = | weaponavailable = | element = | recommended element = | game = | stage = | previous = | next = | simultaneous = | warriors = | allies = | boss = | miniboss = | enemies = | characters = | members = | missions = | pointsint = | item = | materials = | battlefield materials = | prereq = | start = | reward = | related = | release = | walkthrough = | guides = | gallery = }}
Interview
{{Infobox|interview | date = | interviewee = | interviewer = | description = | source = }}
Person
{{Infobox|person | image = | caption = | born = | died = | game = | dept = | position = | related = }}
Member
{{Infobox|member | image = | location = | age = | rank = | joindate = | posts = | im = }}
Track
{{Infobox|track | image = | caption = | game = | album = | track = | duration = | related = }}
Product
{{Infobox|product | image = | caption = | game = | cost = | rarity = | release = | developer = | manufacturer = | publisher = | producer = | director = | author = | editor = | artist = | designer = | type = | model = | seasons = | episodes = | language = | length = | size = | weight = | pieces = | quantity = | color = | ISBN = | ISSN = | UPC = | gallery = }}
Publication
{{Infobox|publication | name = | logo = | image = | caption = | title = | member = | purpose = | special = | number = | game = | series = | location = | occurrence = | characters = | list = | list_header = | pointsint = | ship = | shop = | owner = | cost = | rarity = | related = | platform_header = | date_header = | release = | release <platform1> = <date1> | release <platform2> = <date2> | ... | developer = | manufacturer = | published by = | publisher = | producer in chief = | producer = | director of production = | production editor = | production assistant = | director = | author = | writer = | writers = | translator = | reviewer = | supervisor = | editor in chief = | senior editors = | senior editor = | editors = | editor = | editorial consultants = | editing collaborators = | copy coordinator = | revisions = | fact checking = | technical advice = | game consulting = | game consultants = | art director = | art editor = | designers = | designer = | design = | concept and design = | concept = | layout = | artist = | illustrators = | illustrator = | cover = | cover design = | cover photography = | photographers = | photographer = | map creation = | contributors = | prepress = | in cooperation with = | project coordinators = | production coordinators = | production specialist = | host = | type = | founded = | model = | language = | length = | duration = | size = | weight = | color = | pieces = | quantity = | included with = | ISBN = | ISSN = | ASIN = | catalog = | seriesnumber = | UPC = | walkthrough = | guides = | gallery = | date = | interviewee = | interviewer = | description = | source = | dept = | position = | website = }}
Adding Rows
If additional rows are needed, they can be added directly to this template. They generally take the form:
{{#if: {{{parameter|}}} | {{Infobox/Row|Label|{{{parameter}}}}} }}
- parameter — The name of the parameter the row deals with. Be sure it hasn't already been used.
- Label — The label that appears in the left column
Headers can also be added using {{Infobox/Documentation/Header| text }}. They should be surrounded by an 'if' function that checks for any parameters in the section to which the header refers. Check the existing code for examples.
Each argument—up to three—passed to Infobox/Row represents one column. To adjust which cells are represented as labels, use the label
parameter. label=0
makes the whole row data cells; label=1
is the default value; label=2
makes the first two cells labels; etc.
The widths of the columns can be defined using {{#vardefine:colNwidth|value}}
, where value
is the width (e.g. "50px") of the Nth column (i.e. define col3width for the third column). This can only be done once per column; once a cell has a defined width, further cells in the same column will share that width, even if the variable is reassigned.
Demo
The following code demonstrates different behaviors of Infobox/Row. In proper usage, each line should be surrounded by a #if function checking for parameters.
Example | Result | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{Box|width=320px|title=Demonstration|class=infobox}} <table> {{Infobox/Header|Header}} {{Infobox/Row|Colspan'd label}} {{Infobox/Row|Label|Data}} {{Infobox/Row|label=0|Colspan'd data}} {{Infobox/Row|Default|Three column|Behavior}} {{#vardefine:col3width|100px}} {{Infobox/Row|label=0|Three|Data|Columns}} {{Infobox/Row|label=2|Two|Labels|Data}} {{Infobox/Row|label=3|Three|Label|Columns}} {{#vardefine:col3width|75px}} {{Infobox/Row|Different|Col|Width}} </table> {{Box/Bottom}} |
Demonstration
|
Types and Colors
Common types of Infobox are associated with certain colors, as follows:
Types | Color | |||||
---|---|---|---|---|---|---|
[default] | Default
| |||||
boss enemy |
Hostile
| |||||
dungeon scenario |
Dungeon
| |||||
location shop minigame |
Location
| |||||
character group race shop owner |
Character
| |||||
item collectible ring weapon armor outfit recipe object material |
Item
| |||||
event secret skill song quest |
Knowledge
| |||||
interview member person product company publication game console fan game zd soundtrack track |
Nondiegetic
|