Module:Availability/Sandbox/doc

Edit this documentation page

Module:Availability (aka Template:Availability) is used to display and autotranslate the 'Availability' section in {{Item infobox}}. Preferably, the shortcut {{avail}} should be used.

For future reference, if creating new additions, the key cannot include a number, or it will be parsed out. Thus, if you want to add a string like xmas2015, instead add it to the Multipart strings with xmas and use num to represent the 2015.

Entries

Parameter	Output
audition-reel	Audition Reel
box-companion	What's in the Companion Square Box?
box-portal	What's in the Portal 2 Soundtrack Box?
box-sandvich	What's in the Sandvich Box?
box-tf	What's in the Team Fortress 2 Soundtrack Box?
bread-box	Bread Box
chemistryset	Chemistry Set
collectors	Chemistry Set (Collector's)
contract	Contract (Decorated)
contract-unique	ConTracker
craft	Craft
craft-expired	Craft (expired)
creepy-crate	Unlocked Creepy Crate
directors	Director's Cut Reel
distributed	Distributed
distributed-duels	Distributed (periodical)
distributed-expired	Distributed (expired)
distributed-gifts	Distributed (periodical)
distributed-stamps	Distributed (periodical)
drop	Drop
drop-expired	Drop (expired)
festive-gift	Smissmas 2015 Festive Gift
gift-cauldron	Halloween Gift Cauldron
goodie-cauldron	Antique Halloween Goodie Cauldron (limited)
halloween-package	Halloween Package
halloween-purchase	Purchase
halloween-purchase-expired	Purchase (expired)
hauntedgift	Haunted Halloween Gift (expired)
jungleinferno-campaign	Jungle Inferno Campaign Pass (limited)
jungleinferno-contracts	Jungle Inferno Contracts Pass
keyless-crate	Unlocked Cosmetic Crate (Unique and Strange)
keyless-crate-unusual	Unlocked Cosmetic Crate (Unique, Strange and Unusual)
pallet-of-crates	Pallet of Crates
pile-of-ash	Pile of Ash (expired)
pile-of-curses	Pile of Curses (expired)
promotional	Promotional
promotional-craft	Promotional (craft)
promotional-expired	Promotional (expired)
promotional-expired-codes	Promotional (expired)
promotional-unlock	Promotional (unlock)
purchase	Purchase
purchase-limited	Purchase (limited)
retired	Retired
stock	Stock
stockpile	Stockpile Crate
trade-up	Trade-Up
transmute	Halloween Transmute (Untradable)
unavailable	Unavailable
uncrate-bonus	Uncrate (bonus)
unlock	Unlock
unusual	Uncrate (Unusual)
unusual-expired	Uncrate (Unusual) (expired)
warpaint	War Paint (Decorated)
MvM related strings
mannup	Reward
australium	Reward (Australium)
botkiller	Reward (Botkiller)
mvm-both-types	Reward (Botkiller and Australium)
Dynamic strings (mostly used for crate/case numbers). The numeric value is automatically parsed.
crate1	Uncrate #1
crate2-strange	Uncrate #2 (Strange)
crate3-festive	Uncrate #3 (Festive) (expired)
crate4-haunted	Uncrate #4 (Haunted) (expired)
crate5-expired	Uncrate #5 (expired)
case95	Gun Mettle Cosmetic Case
case95-bonus	Gun Mettle Cosmetic Case (bonus)

Usage

• {{avail|drop}} produces Drop
• {{avail|drop|craft}} produces Drop or Craft
• {{avail|drop|craft|purchase}} produces Drop, Craft or Purchase
• {{avail|drop|craft|purchase|promotional}} produces Drop, Craft, Purchase or Promotional

Backwards compatibility

{{Availability}} changes over time, and thus has some parameters which have been deprecated. They will still function in this template, but their use will place the page into Outdated Availability Parameters. Please replace them with the appropriate new value.

Outdated Parameter	New Parameter	Output
crate74	crate74-haunted	Uncrate #74 (Haunted) (expired)
crate74-expired	crate74-haunted	Uncrate #74 (Haunted) (expired)
crateX-bonus	caseX-bonus	Bone-Chilling Bonanza Case (bonus)