Difference between revisions of "Template:Item infobox/doc"
Line 35: | Line 35: | ||
| trade = | | trade = | ||
+ | | gift = | ||
| craft = | | craft = | ||
| paint = | | paint = | ||
Line 135: | Line 136: | ||
:; ''trade''<ref name="notranslate" /> <span style="font-weight:normal;">[{{code|yes, no}}]</span> | :; ''trade''<ref name="notranslate" /> <span style="font-weight:normal;">[{{code|yes, no}}]</span> | ||
:: If the item can obtained through [[Trading]]. Items are marked as tradable by default. Pages with {{code|trade}} set to {{code|no}} are categorized into [[:Category:Untradeable items]]. | :: If the item can obtained through [[Trading]]. Items are marked as tradable by default. Pages with {{code|trade}} set to {{code|no}} are categorized into [[:Category:Untradeable items]]. | ||
+ | |||
+ | :; ''trade''<ref name="notranslate" /> <span style="font-weight:normal;">[{{code|yes, no}}]</span> | ||
+ | :: If the item can be wrapped using the [[Gift Wrap]]. Items are marked like this by default. | ||
:; ''craft''<ref name="notranslate" /> <span style="font-weight:normal;">[{{code|yes, no}}]</span> | :; ''craft''<ref name="notranslate" /> <span style="font-weight:normal;">[{{code|yes, no}}]</span> |
Revision as of 05:25, 13 November 2010
This infobox template can be used to display images and basic information pertaining to items. For infoboxes for other uses, see Category:Infobox templates.
Supersession
{{Item infobox}}
deprecates the following templates:
{{Weapon infobox}}
{{Hat infobox}}
{{Tool infobox}}
Contents
Usage
Please remove the parameters that are left blank. See Parameters section below for documentation of all parameters.
{{Item infobox | name = | game = (Only use this if the game is TFC) | type = | image = | team-colors = | two-models = | kill-icon-1 = ... | kill-icon-6 = | used-by = | slot = | contributed-by = | released = | availability = | trade = | gift = | craft = | paint = | rename = | ammo-loaded = | ammo-carried = | ammo-type = | reload-type = | loadout = | level = | att-1-positive = ... | att-6-negative = | item-description = }}
Parameters
Setup parameters
- name
- The displayed title of the infobox. Not necessary for most English pages as the title is collected from the page's name itself. This is also the name displayed in the loadout stats if enabled (overridden by
loadout-name
). The following parameters are also aliases forname
, and function in the exact same way:NAME, title, name-override, item-name-override
- type[1] [
weapon, hat, misc, taunt, action, tool
] - Changes the display of information and the categorization of the page based on type. Also accepts other variations:
- hat:
hat, hats, head, headwear
- weapon:
weapons
- misc:
misc item, misc., misc, miscellaneous, miscellaneous item
- action:
action item
- hat:
- type[1] [
- game[1]
- Not necessary for the majority of items. Team Fortress Classic weapon pages need to set this parameter to "
tfc
".
Image parameters
- image
- The main infobox image to be displayed directly underneath the title.
- Example:
File name.png
- Example:
- imagewidth
- The width of the image, defaults to
250px
. Use this only if the image does not display well at the default size.- Example:
96px
- Example:
- team-colors
- Set to "
yes
" if the item has team-based color variations. The images will be displayed using the syntax "File:RED <Item Name>.png
" (where <Item Name> is collected from the page's actual name). This can be overridden with different filenames usingskin-image-blu
andskin-image-red
(see below).
- skin-image-blu and skin-image-red
- The filenames for team-color images. Overrides defaults (see above).
Kill icon parameters
Main templates:
{{Icon killicon}}
and {{Kill notice}}
The following parameters can only be used if type
has been set to weapon
or taunt
(see above). Up to 6 of each are allowed.
- kill-icon-n
- The weapon's kill icons. See
{{Icon killicon}}
for exact naming. By default,kill-icon-1
will be displayed using the page's name; thus in most circumstances, definingkill-icon
parameters is not necessary unless the weapon has additional kill icons (e.g.backstab
orflaming arrow
).
- kill-text-n
- The kill text displayed within the kill notice.
- Example:
FISH KILL!
- Example:
Information parameters
- used-by
- The class or classes that can use the item. Basic text parameter.
- slot[1] [
primary, secondary, melee, pda1, pda2
] - Can only be defined when
type
is set toweapon
ortaunt
(see above). Other variations:- primary:
slot1, slot 1, 1
- secondary:
slot2, slot 3, 3
- melee:
slot2, slot 3, 3
- pda1:
pda1, pda 1, disguise kit
- pda2:
pda2, pda 2, watch, cloak
- primary:
- This template will also categorize based on these values.
- The default text displayed by these values can also be overridden by setting
slot
to any other specified value. - Note: this behaviour will disable the automatic categorization based on slot types. Categories will need to be applied to the bottom of the article manually.
- slot[1] [
- contributed-by
- The person(s) who contributed the item to the game. Basic text parameter. Not displayed unless defined specifically. Categorizes the pages into Category:Community-contributed items.
- released
- When the item was released. Basic text parameter. Not displayed unless defined specifically.
- availability
- The means of obtaining the item. Basic text parameter. Not displayed unless defined specifically.
- show-price
- Used to disable the display of the price if in error. Prices themselves are stored inside
{{Item price/core}}
.- Example:
off
- Example:
- trade[1] [
yes, no
] - If the item can obtained through Trading. Items are marked as tradable by default. Pages with
trade
set tono
are categorized into Category:Untradeable items.
- trade[1] [
- rename[1] [
yes, no
] - If the item can be used with the Name Tag or Description Tag.
- rename[1] [
Ammo parameters
These parameters are only available if type
is set to weapon
or taunt
(see above).
- ammo-loaded
- The amount of ammo available in the clip (or magazine?). Basic text parameter. Hidden if set to "
N/A
" or "∞
".
- ammo-carried
- The amount of additional ammo carried by the player. Basic text parameter. Hidden if set to "
N/A
" or "∞
".
- ammo-type
- The ammo's type. Optional basic text parameter.
- reload-type
- The reloading type. Basic text parameter.
- Common uses: Single, No Reload
- show-ammo
- Set to
off
to disable the display of ammunition stats. Some example uses would be the Razorback, Darwin's Danger Shield, or the Electro Sapper.
Loadout parameters
Main template:
{{Backpack item}}
- loadout
- Set to
yes
to display loadout information as it is displayed in the backpack. Is not displayed by default.
- quality[1] [
normal, unique, community, unusual, self-made, valve
] - Item quality. Defaults to "unique" yellow. (See Rarity#Colors and documentation of
{{Backpack item}}
for full list of parameters).
- quality[1] [
- loadout-name
- The name displayed. Defaults to either the page's name itself or the displayed name (set by
name
, see above). Use this parameter when the infobox name differs to the loadout name (for example, adding the rarity prefix on non-English pages):- Example:
Необычный Призрачный Металлолом
(Unusual Haunted Metal Scrap)
- Example:
- level
- The level and type of the item. Basic text parameter. Defaults to "Level 0-100".
- att-n-positive
- Positive attributes. Up to 6 basic text parameters.
- att-n-negative
- Positive attributes. Up to 6 basic text parameters.
- att-n-neutral
- Positive attributes. Up to 6 basic text parameters. Use
item-description
for weapon or hat descriptions instead.
- item-description
- The item's description. Basic text parameter. Displays the description with a smaller font size and lower line height so it fits neatly and stands out from the item's other attributes.
- item-uses
- The amount of uses the item has. Basic text parameter.
- item-flags
- The flags attached to the item. Basic text parameter.
Non-article maintenance parameters
These parameters should only be used in certain circumstances.
- cat
- Disables all automatic categorization (i.e. slot categorization, etc). Does not disable maintenance tracking categories.
- override
- Overrides Polycount Pack categorization. Will not be around for much longer.