Template:Databox Recipe

From the RuneScape Wiki, the wiki for all things RuneScape
(Redirected from Template:Databox recipe)
Jump to: navigation, search
Template documentation
This documentation is transcluded from Template:Databox Recipe/doc. [edit] [history] [purge]
Template:Databox Recipe invokes function main in Module:Infobox recipe using Lua.

The Recipe template is used to show the details of a recipe step in item articles, such as a potion mixture or adding a cooking ingredient. It can also be used to display the experience gained for item creation. For food items use Template:Databox Cooking instead.

Use Template:Switch infobox To display multiple methods cleanly.

Parameters

Parameter Format Usage Mandatory?
name Exact name of the item Item name used for display and fetching GEMW prices. Will default to the pagename if not given; Do not include brackets; e.g. Abyssal whip for Abyssal whip Yes
amount Integer Amount of the item made for display and calculation; e.g. if 15 bolts are made, then amount should be set to 15 No
image image.png Item's image for display. Do not include the 'File:' prefix (though doing so will not break the template); do not use brackets

This parameter can be removed if it would be the same as "name.png"

No
ticks Integer or varies The ticks per action (number of ticks to complete this recipe or step) Yes
ticks2 Integer A secondary ticks per action such as for adding a secondary ingredient to potions where the ticks varies based on how whether you are creating multiple No
ticksnote String Should be used with |ticks = varies or 'ticks2' to clarify. |ticksnote = 1 yields: "When creating a single item" No
skill skill name or no The primary skill in which experience is gained, or which has a level requirement, for creating the item Yes
level Integer The level required in the primary skill to create the item; omitted if blank. No
skillXP number The amount of experience gained for performing the action; amount is disregarded; e.g. if 15 bolts are made, use the experience gained for creating all 15 Yes
secSkill skill name The secondary skill in which experience is gained, or which has a level requirement, for creating the item; omitted if blank No
secLevel Integer The level required in the secondary skill to create the item; omitted if blank. No
secXP number The amount of experience gained in the secondary skill for performing the action; amount is disregarded; e.g. if 15 bolts are made, use the experience gained for creating all 15; omitted if blank No
terSkill skill name The tertiary skill in which experience is gained, or which has a level requirement, for creating the item; omitted if blank No
terLevel Integer The level required in the tertiary skill to create the item; omitted if blank. No
terXP number The amount of experience gained in the tertiary skill for performing the action; amount is disregarded; e.g. if 15 bolts are made, use the experience gained for creating all 15; omitted if blank No
improved number The improved number of the recipe, for those whose recipes improve at higher level; omitted if blank No
method explanation of method An explanation or name for the method, only use if the item has multiple recipes and improved doees not apply; omitted if blank No
geValue gemw or no A binary decision on whether or not to look for the price of item in the GEMW; if the item can be traded on the Grand Exchange, set to "gemw", otherwise, set it to "no" Yes
quest Text to display The name of the ultimate quest requirement for creating the item. This parameter is unformatted, but will be prefixed with the Quest symbol; e.g. setting quest = [[Cook's Assistant]] will display

Quests Cook's Assistant

members Yes or No Whether or not the item can only be created by members Yes
facility Link to map facility A link (without brackets) to a facility that can be identified through a minimap icon, such as a furnace, and which is required to create the item; e.g. facility = Inventor's workbench will display

Inventor's workbench Must be performed at an inventor's workbench

If the minimap icon cannot be found, the argument can be replaced with wikitext; e.g. facility = the [[Obelisk of Air]] will display

Must be performed at the Obelisk of Air

No
misc1 Text to display Unformatted text to indicate any other requirements for creating the item; omitted if blank No
misc2
misc3
misc4
misc5
The material parameters are technically limited to 10 materials; however, this can be changed within the module
mat# Exact name of the item Item name used for display (unless overridden with mat#name) and fetching GEMW prices. Do not include brackets; e.g. Abyssal whip for Abyssal whip Only for mat1<x>
mat#img image.png Item's image for display. Do not include the 'File:' prefix (though doing so will not break the template); do not use brackets

This parameter can be removed if it would be the same as "name.png", and is auto generated for coins based on the quantity

mat#name Display name of the item Item's name to display. Use optionally to override the item's exact name.
mat#price gemw, mat, calcvalue or no (see #Prices) Price of the material
  • gemw - Grand exchange price (or divine energy/sandstone), also works for coins.
  • mat/comp - Approximate invention material cost, see RuneScape:Material prices.
  • calcvalue - Get calculated value from the item page, can be used for most items with a distinct value. Calculated using the calculated value property set by {{Infobox Item}} (either an unformatted integer or a template/parser function outputting such).
  • no - Use no if the item is not tradeable and has no distinct value.
  • An unformatted integer or template/parser function outputting an unformatted integer can also be used, but this is for backwards compatibility and has generally been replaced with calcvalue. See #Prices for how to format untradeable items with distinct values.
mat#qty Integer The amount of the material used in the process

This parameter can be removed if it would be 1

mat#note String A note to add to the material price.

This parameter is generally not needed and is automatically set for the following price cases: divine energy, sandstone, mat and calcvalue

nosmw Yes or No If present and true, will suppress SMW output. Set to true for historical/obsolete items. No
instructions text Instructions on how to make the item, usually a numbered list:
# Step 1
# Step 2
# And so on
  1. Step 1
  2. Step 2
  3. And so on
No
totalvar String Gives the name of a MediaWiki variable which will be defined to contain the total price (without commas). No

Prices

Certain materials can be any number of materials (in varying quantities), these are specially supported, and the lowest GE cost is displayed. Currently supported materials are Sandstone and Divine energy. In both cases |mat#price = gemw should be used. For sandstone, the price is the cheapest option to obtain one unit of extra fine sand on average. For divine energy, the quantity 1 is equal to the amount of energy required to create 1 Divine charge. In both cases a note (ref) will be added to the price which gives the source.

Coins is also a special case and |mat#price = gemw can also be used.

For invention materials |mat#price = comp will use the approximate invention material value. Details on how these are calculated can be found at RuneScape:Material prices. A note (ref) will automatically be added to the price which gives the calculation method and links to the explanation page.

Certain materials are not tradeable on the Grand Exchange, but can still be given a distinct market value because all of their materials are. For most of these cases |mat#price = calcvalue can be used which pulls the value from the item page itself (calculated value property). Generally if this is appropriate but produces an error (No calculated value could be found for: ...), consider adding the value to the item page. See {{Infobox Item}} for details. A note (ref) will automatically be added to the price which gives the calculation method or raw price from the property.

There may be special cases where calcvalue is not appropriate, or legacy cases not yet updated where prices can be given using a unformatted integer, or templates/parsers which evaluate as such. The maintenance category Category:Recipes using manual values is added which helps update old templates. For full documentation for and the templates to use are:

For example, an Extreme attack (3) is required for creating overloads; it would be included as:

|mat1 = Extreme attack (3)
|mat1img = Extreme attack (3).png
|mat1qty = 1
|mat1price = {{GETotal|Super attack (3)|Clean avantoe}}

Total

The total cost for production will only be displayed if there are 2 or more items with a definite value.

Example

This is an example that uses random values just to display the functionality of the template

{{Databox Recipe
|name = Supreme overload salve (6)
|amount = 3
|ticks = 2
|ticks2 = 4
|ticksnote = When creating multiple
|skill = Herblore
|level = 17
|skillXP = 888
|secSkill = Fletching
|secLevel = 101
|secXP = 999
|geValue = no
|method = special method
|members = Yes
|quest = Fully completed [[Cook's Assistant]]
|facility = Obelisk
|misc1 = Must have soloed [[Nex]] with an [[Abyssal whip]]
|mat1 = Supreme overload potion (6)
|mat1price = calcvalue
|mat2 = Prayer renewal (4)
|mat2price = gemw
|mat3 = Apple
|mat3img = Cooking apple.png
|mat3price = 9001
|mat3qty = 1337
|mat4 = Argonite ore
|mat4price = 7777
|mat5 = Runite ore
|mat5price = 5
|mat6 = Primal 2h sword
|mat6qty = 666
|mat6price = no
|mat7 = Divine energy
|mat7qty = 1
|mat7img = incandescent energy.png
|mat7price = gemw
|mat8 = Sandstone
|mat8img = Sandstone (5kg).png
|mat8name = Sandstone (of any size)
|mat8price = gemw
|mat9name = Simple parts
|mat9qty = 5
|mat8price = comp
}}
Supreme overload salve (6).png Supreme overload salve (6) ×3
(special method)
HerbloreFletchingHourglass.pngMake-X GE icon.png
888 XP999 XP2 (1.2s) / 4 (2.4s) [r 1]-
Requirements
Herblore Herblore level17
Fletching Fletching level101
Quests Fully completed Cook's Assistant
Obelisk Must be performed at an obelisk
Must have soloed Nex with an Abyssal whip
P2P icon.png Members only
Materials
ItemQuantityPriceTotal
Supreme overload potion (6).pngSupreme overload potion (6)1227,563[r 2]227,563
Prayer renewal (4).pngPrayer renewal (4)124,35624,356
Cooking apple.pngApple1,3379,001[r 3]12,034,337
Argonite ore.pngArgonite ore17,777[r 4]7,777
Runite ore.pngRunite ore15[r 5]5
Primal 2h sword.pngPrimal 2h sword666N/A-
Incandescent energy 1000.pngDivine energy140,050[r 6]40,050
Sandstone (5kg).pngSandstone (of any size)1230[r 7]230
Total price12,334,318
  1. ^ When creating multiple
  2. ^ Calculated value given on the item page (generally based on GE prices of ingredients): [show/hide formula] overload_cost() + Price(Super attack (4)) + Price(Super strength (4)) + Price(Super defence (4)) + Price(Super magic potion (4)) + Price(Super ranging potion (4)) + Price(Crystal flask).
  3. ^ Fixed price given
  4. ^ Fixed price given
  5. ^ Fixed price given
  6. ^ Based on the cost of 225 Incandescent energy as the cheapest option.
  7. ^ Based on the cost of 10 Sandstone (1kg) as the cheapest option.


Blank databox

All parameters

{{Databox Recipe
|name = 
|amount = 
|image = 
|ticks = 
|ticks2 = 
|ticksnote = 
|skill = 
|level = 
|skillXP = 
|secSkill = 
|secLevel = 
|secXP = 
|terSkill = 
|terLevel = 
|terXP = 
|improved = 
|method = 
|geValue = 
|members = 
|facility = 
|misc1 = 
|quest = 
|mat1 = 
|mat1img = 
|mat1name = 
|mat1qty = 
|mat1price = 
|mat2 = 
|mat2img = 
|mat2name = 
|mat2qty = 
|mat2price = 
|mat3 = 
|mat3img = 
|mat3name = 
|mat3qty = 
|mat3price = 
|totalvar = 
|instructions = 
}}

Common parameters

{{Databox Recipe
|name = 
|ticks = 
|skill = 
|level = 
|skillXP = 
|geValue = 
|members = 
|facility = 
|mat1 = 
|mat1qty = 
|mat1price = 
|mat2 = 
|mat2qty = 
|mat2price = 
|mat3 = 
|mat3qty = 
|mat3price = 
}}

Template data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

The '''Recipe''' template is used to show the details of a recipe step in item articles, such as a potion mixture or adding a cooking ingredient. It can also be used to display the experience gained for item creation. For food items use [[Template:Databox Cooking]] instead.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Namename

Exact name of the item. Item name used for display and fetching GEMW prices. Will default to the pagename if not given; Do not include brackets.

Default
empty
Example
Abyssal whip
Auto value
empty
Stringrequired
Amountamount

Amount of the item made for display and calculation; e.g. if 15 bolts are made, then amount should be set to 15

Default
empty
Example
15
Auto value
empty
Numbersuggested
Imageimage

Item's image for display. Do not include the 'File:' prefix (though doing so will not break the template); do not use brackets

Default
empty
Example
Abyssal whip.png
Auto value
empty
Filesuggested
Ticksticks

The Game ticks per action (number of ticks to complete this recipe or step)

Default
empty
Example
2
Auto value
empty
Numberrequired
Ticks2ticks2

A secondary Game ticks per action such as for adding a secondary ingredient to potions where the ticks varies based on how whether you are creating multiple

Default
empty
Example
1
Auto value
empty
Numberoptional
Ticksnoteticksnote

Should be used with "|ticks = varies" or 'ticks2' to clarify. "|ticksnote = 1" yields: "When creating a single item"

Default
empty
Example
empty
Auto value
empty
Stringoptional
Skillskill

The primary skill in which experience is gained, or which has a level requirement, for creating the item

Default
empty
Example
empty
Auto value
empty
Pagerequired
Levellevel

The level required in the primary skill to create the item; omitted if blank.

Default
empty
Example
15
Auto value
empty
Numbersuggested
SkillXPskillXP

The amount of experience gained for performing the action; amount is disregarded; e.g. if 15 bolts are made, use the experience gained for creating ''all 15''

Default
empty
Example
empty
Auto value
empty
Numberrequired
SecSkillsecSkill

The secondary skill in which experience is gained, or which has a level requirement, for creating the item; omitted if blank

Default
empty
Example
empty
Auto value
empty
Pageoptional
SecLevelsecLevel

The level required in the secondary skill to create the item; omitted if blank.

Default
empty
Example
empty
Auto value
empty
Numberoptional
SecXPsecXP

The amount of experience gained in the secondary skill for performing the action; amount is disregarded; e.g. if 15 bolts are made, use the experience gained for creating ''all 15''; omitted if blank

Default
empty
Example
empty
Auto value
empty
Numberoptional
TerSkillterSkill

The tertiary skill in which experience is gained, or which has a level requirement, for creating the item; omitted if blank

Default
empty
Example
empty
Auto value
empty
Pageoptional
TerLevelterLevel

The level required in the tertiary skill to create the item; omitted if blank.

Default
empty
Example
empty
Auto value
empty
Numberoptional
TerXPterXP

The amount of experience gained in the tertiary skill for performing the action; amount is disregarded; e.g. if 15 bolts are made, use the experience gained for creating ''all 15''; omitted if blank

Default
empty
Example
empty
Auto value
empty
Numberoptional
Improvedimproved

The improved number of the recipe, for those whose recipes improve at higher level; omitted if blank

Default
empty
Example
empty
Auto value
empty
Numberoptional
Methodmethod

An explanation or name for the method, only use if the item has multiple recipes and improved does not apply; omitted if blank

Default
empty
Example
empty
Auto value
empty
Stringoptional
GeValuegeValue

A binary decision on whether or not to look for the price of item in the GEMW; if the item can be traded on the Grand Exchange, set to "gemw", otherwise, set it to "no"

Default
empty
Example
gemw
Auto value
empty
Stringrequired
Questquest

The name of the ultimate quest requirement for creating the item. This parameter is unformatted, but will be prefixed with the Quest symbol

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Membersmembers

Whether or not the item can only be created by members: "Yes" or "No"

Default
empty
Example
Yes
Auto value
empty
Stringrequired
Facilityfacility

A link (without brackets) to a facility that can be identified through a minimap icon, such as a [[furnace]], and which is required to create the item; e.g. |facility = Inventor's workbench will display {{Map clickpic|Inventor's workbench}} Must be performed at an [[inventor's workbench]]

Default
empty
Example
Inventor's workbench
Auto value
empty
Stringoptional
Misc1misc1

Unformatted text to indicate any other requirements for creating the item; omitted if blank

Default
empty
Example
empty
Auto value
empty
Stringoptional
Misc2misc2

Unformatted text to indicate any other requirements for creating the item; omitted if blank

Default
empty
Example
empty
Auto value
empty
Stringoptional
Misc3misc3

Unformatted text to indicate any other requirements for creating the item; omitted if blank

Default
empty
Example
empty
Auto value
empty
Stringoptional
Misc4misc4

Unformatted text to indicate any other requirements for creating the item; omitted if blank

Default
empty
Example
empty
Auto value
empty
Stringoptional
Misc5misc5

Unformatted text to indicate any other requirements for creating the item; omitted if blank

Default
empty
Example
empty
Auto value
empty
Stringoptional
Mat1mat1

Item name used for display and fetching GEMW prices. Do not include brackets; e.g. "Abyssal whip" for [[Abyssal whip]]. Additional materials are numbered after this (e.g mat2, mat3, all the way to a max of mat10)

Default
empty
Example
Abyssal whip
Auto value
Pagerequired
Mat1imgmat1img

Item's image for display. Do not include the 'File:' prefix (though doing so will not break the template); do not use brackets. Additional materials are numbered after this (e.g mat2img, mat3img, all the way to a max of mat10img)

Default
empty
Example
This parameter can be removed if it would be the same as the pagename.png
Auto value
empty
Filesuggested
Mat1namemat1name

Item's name to display. Use optionally to override the item's exact name.

Default
empty
Example
Sandstone (of any size)
Auto value
Stringoptional
Mat1qtymat1qty

The amount of the material used in the process. This parameter can be removed if it would be "1". Additional materials are numbered after this (e.g mat2qty, mat3qty, all the way to a max of mat10qty)

Default
empty
Example
15
Auto value
1
Numbersuggested
Mat1pricemat1price

Price of the material; use ''gemw'' to look for prices on the GEMW; use ''comp'' for invention materials; use ''calcvalue'' if the item has a value outside of the Grand Exchange (e.g. a [[Blast fusion hammer]] is unvariable 1,000,000 coins); or set to no if the item is not tradeable and has no distinct value. Additional materials are numbered after this (e.g mat2price, mat3price, all the way to a max of mat10price)

Default
empty
Example
''gemw'' or ''integer'' or ''no''
Auto value
Unknownrequired
Mat2mat2

see mat1

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat2imgmat2img

see mat1img

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat2namemat2name

see mat1name

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat2qtymat2qty

see mat1qty

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat2pricemat2price

see mat1price

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat3mat3

see mat1

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat3imgmat3img

see mat1img

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat3namemat3name

see mat1name

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat3qtymat3qty

see mat1qty

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat3pricemat3price

see mat1price

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat4mat4

see mat1

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat4imgmat4img

see mat1img

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat4namemat4name

see mat1name

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat4qtymat4qty

see mat1qty

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat4pricemat4price

see mat1price

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat5mat5

see mat1

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat5imgmat5img

see mat1img

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat5namemat5name

see mat1name

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat5qtymat5qty

see mat1qty

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat5pricemat5price

see mat1price

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat6mat6

see mat1

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat6imgmat6img

see mat1img

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat6namemat6name

see mat1name

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat6qtymat6qty

see mat1qty

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat6pricemat6price

see mat1price

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat7mat7

see mat1

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat7imgmat7img

see mat1img

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat7namemat7name

see mat1name

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat7qtymat7qty

see mat1qty

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat7pricemat7price

see mat1price

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat8mat8

see mat1

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat8imgmat8img

see mat1img

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat8namemat8name

see mat1name

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat8qtymat8qty

see mat1qty

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat8pricemat8price

see mat1price

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat9mat9

see mat1

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat9imgmat9img

see mat1img

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat9namemat9name

see mat1name

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat9qtymat9qty

see mat1qty

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat9pricemat9price

see mat1price

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat10mat10

see mat1

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat10imgmat10img

see mat1img

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat10namemat10name

see mat1name

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat10qtymat10qty

see mat1qty

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat10pricemat10price

see mat1price

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Instructionsinstructions

Instructions on how to make the item, usually a numbered list.

Default
empty
Example
empty
Auto value
empty
Stringoptional
Totalvartotalvar

Gives the name of a MediaWiki variable which will be defined to contain the total price (without commas).

Default
empty
Example
empty
Auto value
empty
Stringoptional
Nosmwnosmw

If present and true, will suppress SMW output. Set to true for historical/obsolete items.

Default
empty
Example
Yes
Auto value
empty
Unknowndeprecated