Difference between revisions of "Module:Availability/Sandbox/doc"
m |
m (→Backwards compatibility) |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | <div class="plainlinks" style="float:right"><small>[{{fullurl:Module:Availability/doc|action=edit}} Edit this documentation page]</small></div> |
+ | {{clr}} | ||
+ | {{Complex template|user=Darkid}} | ||
+ | {{Ambox | ||
+ | | type = notice | ||
+ | | contents = To update which crate series are linked as active, change the list in [[Module:Availability/active]]. | ||
+ | }} | ||
+ | |||
+ | [[Module:Availability]] (aka [[Template:Availability]]) is used to display and autotranslate the 'Availability' section in {{tl|Item infobox}}. Preferably, the shortcut '''{{tl|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 <code>xmas2015</code>, instead add it to the Multipart strings with <code>xmas</code> and use <code>num</code> to represent the 2015. | ||
+ | |||
+ | __FORCETOC__ | ||
+ | === Entries === | ||
+ | {| class="wikitable grid" | ||
+ | ! class="header" | Parameter | ||
+ | ! class="header" | Output | ||
+ | |- | ||
+ | | <code>audition-reel</code> || {{#invoke:Availability/Sandbox|avail|audition-reel}} | ||
+ | |- | ||
+ | | <code>box-companion</code> || {{#invoke:Availability/Sandbox|avail|box-companion}} | ||
+ | |- | ||
+ | | <code>box-portal</code> || {{#invoke:Availability/Sandbox|avail|box-portal}} | ||
+ | |- | ||
+ | | <code>box-sandvich</code> || {{#invoke:Availability/Sandbox|avail|box-sandvich}} | ||
+ | |- | ||
+ | | <code>box-tf</code> || {{#invoke:Availability/Sandbox|avail|box-tf}} | ||
+ | |- | ||
+ | | <code>bread-box</code> || {{#invoke:Availability/Sandbox|avail|bread-box}} | ||
+ | |- | ||
+ | | <code>chemistryset</code> || {{#invoke:Availability/Sandbox|avail|chemistryset}} | ||
+ | |- | ||
+ | | <code>collectors</code> || {{#invoke:Availability/Sandbox|avail|collectors}} | ||
+ | |- | ||
+ | | <code>contract</code> || {{#invoke:Availability/Sandbox|avail|contract}} | ||
+ | |- | ||
+ | | <code>contract-unique</code> || {{#invoke:Availability/Sandbox|avail|contract-unique}} | ||
+ | |- | ||
+ | | <code>craft</code> || {{#invoke:Availability/Sandbox|avail|craft}} | ||
+ | |- | ||
+ | | <code>craft-expired</code> || {{#invoke:Availability/Sandbox|avail|craft-expired}} | ||
+ | |- | ||
+ | | <code>creepy-crate</code> || {{#invoke:Availability/Sandbox|avail|creepy-crate}} | ||
+ | |- | ||
+ | | <code>directors</code> || {{#invoke:Availability/Sandbox|avail|directors}} | ||
+ | |- | ||
+ | | <code>distributed</code> || {{#invoke:Availability/Sandbox|avail|distributed}} | ||
+ | |- | ||
+ | | <code>distributed-duels</code> || {{#invoke:Availability/Sandbox|avail|distributed-duels}} | ||
+ | |- | ||
+ | | <code>distributed-expired</code> || {{#invoke:Availability/Sandbox|avail|distributed-expired}} | ||
+ | |- | ||
+ | | <code>distributed-gifts</code> || {{#invoke:Availability/Sandbox|avail|distributed-gifts}} | ||
+ | |- | ||
+ | | <code>distributed-stamps</code> || {{#invoke:Availability/Sandbox|avail|distributed-stamps}} | ||
+ | |- | ||
+ | | <code>drop</code> || {{#invoke:Availability/Sandbox|avail|drop}} | ||
+ | |- | ||
+ | | <code>drop-expired</code> || {{#invoke:Availability/Sandbox|avail|drop-expired}} | ||
+ | |- | ||
+ | | <code>festive-gift</code> || {{#invoke:Availability/Sandbox|avail|festive-gift}} | ||
+ | |- | ||
+ | | <code>gift-cauldron</code> || {{#invoke:Availability/Sandbox|avail|gift-cauldron}} | ||
+ | |- | ||
+ | | <code>goodie-cauldron</code> || {{#invoke:Availability/Sandbox|avail|goodie-cauldron}} | ||
+ | |- | ||
+ | | <code>halloween-package</code> || {{#invoke:Availability/Sandbox|avail|halloween-package}} | ||
+ | |- | ||
+ | | <code>halloween-purchase</code> || {{#invoke:Availability/Sandbox|avail|halloween-purchase}} | ||
+ | |- | ||
+ | | <code>halloween-purchase-expired</code> || {{#invoke:Availability/Sandbox|avail|halloween-purchase-expired}} | ||
+ | |- | ||
+ | | <code>hauntedgift</code> || {{#invoke:Availability/Sandbox|avail|hauntedgift}} | ||
+ | |- | ||
+ | | <code>jungleinferno-campaign</code> || {{#invoke:Availability/Sandbox|avail|jungleinferno-campaign}} | ||
+ | |- | ||
+ | | <code>jungleinferno-contracts</code> || {{#invoke:Availability/Sandbox|avail|jungleinferno-contracts}} | ||
+ | |- | ||
+ | | <code>keyless-crate</code> || {{#invoke:Availability/Sandbox|avail|keyless-crate}} | ||
+ | |- | ||
+ | | <code>keyless-crate-unusual</code> || {{#invoke:Availability/Sandbox|avail|keyless-crate-unusual}} | ||
+ | |- | ||
+ | | <code>pallet-of-crates</code> || {{#invoke:Availability/Sandbox|avail|pallet-of-crates}} | ||
+ | |- | ||
+ | | <code>pile-of-ash</code> || {{#invoke:Availability/Sandbox|avail|pile-of-ash}} | ||
+ | |- | ||
+ | | <code>pile-of-curses</code> || {{#invoke:Availability/Sandbox|avail|pile-of-curses}} | ||
+ | |- | ||
+ | | <code>promotional</code> || {{#invoke:Availability/Sandbox|avail|promotional}} | ||
+ | |- | ||
+ | | <code>promotional-craft</code> || {{#invoke:Availability/Sandbox|avail|promotional-craft}} | ||
+ | |- | ||
+ | | <code>promotional-expired</code> || {{#invoke:Availability/Sandbox|avail|promotional-expired}} | ||
+ | |- | ||
+ | | <code>promotional-expired-codes</code> || {{#invoke:Availability/Sandbox|avail|promotional-expired-codes}} | ||
+ | |- | ||
+ | | <code>promotional-unlock</code> || {{#invoke:Availability/Sandbox|avail|promotional-unlock}} | ||
+ | |- | ||
+ | | <code>purchase</code> || {{#invoke:Availability/Sandbox|avail|purchase}} | ||
+ | |- | ||
+ | | <code>purchase-limited</code> || {{#invoke:Availability/Sandbox|avail|purchase-limited}} | ||
+ | |- | ||
+ | | <code>retired</code> || {{#invoke:Availability/Sandbox|avail|retired}} | ||
+ | |- | ||
+ | | <code>stock</code> || {{#invoke:Availability/Sandbox|avail|stock}} | ||
+ | |- | ||
+ | | <code>stockpile</code> || {{#invoke:Availability/Sandbox|avail|stockpile}} | ||
+ | |- | ||
+ | | <code>trade-up</code> || {{#invoke:Availability/Sandbox|avail|trade-up}} | ||
+ | |- | ||
+ | | <code>transmute</code> || {{#invoke:Availability/Sandbox|avail|transmute}} | ||
+ | |- | ||
+ | | <code>unavailable</code> || {{#invoke:Availability/Sandbox|avail|unavailable}} | ||
+ | |- | ||
+ | | <code>uncrate-bonus</code> || {{#invoke:Availability/Sandbox|avail|uncrate-bonus}} | ||
+ | |- | ||
+ | | <code>unlock</code> || {{#invoke:Availability/Sandbox|avail|unlock}} | ||
+ | |- | ||
+ | | <code>unusual</code> || {{#invoke:Availability/Sandbox|avail|unusual}} | ||
+ | |- | ||
+ | | <code>unusual-expired</code> || {{#invoke:Availability/Sandbox|avail|unusual-expired}} | ||
+ | |- | ||
+ | | <code>warpaint</code> || {{#invoke:Availability/Sandbox|avail|warpaint}} | ||
+ | |- | ||
+ | ! class="header" colspan="2" | [[Mann Up|MvM]] related strings | ||
+ | |- | ||
+ | | <code>mannup</code> || {{#invoke:Availability/Sandbox|avail|mannup}} | ||
+ | |- | ||
+ | | <code>australium</code> || {{#invoke:Availability/Sandbox|avail|australium}} | ||
+ | |- | ||
+ | | <code>botkiller</code> || {{#invoke:Availability/Sandbox|avail|botkiller}} | ||
+ | |- | ||
+ | | <code>mvm-both-types</code> || {{#invoke:Availability/Sandbox|avail|mvm-both-types}} | ||
+ | |- | ||
+ | ! class="header" colspan="2" | Dynamic strings (mostly used for crate/case numbers). The numeric value is automatically parsed. | ||
+ | |- | ||
+ | | <code>crate1</code> || {{#invoke:Availability/Sandbox|avail|crate1}} | ||
+ | |- | ||
+ | | <code>crate2-strange</code> || {{#invoke:Availability/Sandbox|avail|crate2-strange}} | ||
+ | |- | ||
+ | | <code>crate3-festive</code> || {{#invoke:Availability/Sandbox|avail|crate3-festive}} | ||
+ | |- | ||
+ | | <code>crate4-haunted</code> || {{#invoke:Availability/Sandbox|avail|crate4-haunted}} | ||
+ | |- | ||
+ | | <code>crate5-expired</code> || {{#invoke:Availability/Sandbox|avail|crate5-expired}} | ||
+ | |- | ||
+ | | <code>case95</code> || {{#invoke:Availability/Sandbox|avail|case95}} | ||
+ | |- | ||
+ | | <code>case95-bonus</code> || {{#invoke:Availability/Sandbox|avail|case95-bonus}} | ||
+ | |} | ||
+ | |||
+ | === Usage === | ||
+ | * {{tlx|avail|drop}} produces {{#invoke:Availability/Sandbox|avail|drop}} | ||
+ | * {{tlx|avail|drop|craft}} produces {{#invoke:Availability/Sandbox|avail|drop|craft}} | ||
+ | * {{tlx|avail|drop|craft|purchase}} produces {{#invoke:Availability/Sandbox|avail|drop|craft|purchase}} | ||
+ | * {{tlx|avail|drop|craft|purchase|promotional}} produces {{#invoke:Availability/Sandbox|avail|drop|craft|purchase|promotional}} | ||
+ | |||
+ | === Backwards compatibility === | ||
+ | {{tl|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 [[:Category:Outdated Availability Parameters|Outdated Availability Parameters]]. Please replace them with the appropriate new value. | ||
+ | {| class="wikitable grid" | ||
+ | ! class="header" | Outdated Parameter | ||
+ | ! class="header" | New Parameter | ||
+ | ! class="header" | Output | ||
+ | |- | ||
+ | | <code>crate74</code> || <code>crate74-haunted</code> || {{#invoke:Availability/Sandbox|avail|crate74-haunted}} | ||
+ | |- | ||
+ | | <code>crate74-expired</code> || <code>crate74-haunted</code> || {{#invoke:Availability/Sandbox|avail|crate74-haunted}} | ||
+ | |- | ||
+ | | <code>crateX-bonus</code> || <code>caseX-bonus</code> || {{#invoke:Availability/Sandbox|avail|case142-bonus}} | ||
+ | |} |
Latest revision as of 20:38, 3 June 2024
This module is very complex. If you have questions about this module, feel free to ask on the IRC. Darkid has offered to maintain this module, you may contact them if you need further assistance. |
To update which crate series are linked as active, change the list in Module:Availability/active. |
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.
Contents
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) |