User:Cache117/Template:Infobox recipe/doc

From the RuneScape Wiki, the wiki for all things RuneScape
Jump to: navigation, search
Information icon-grey.svg
This is a documentation subpage for User:Cache117/Template:Infobox recipe.
It contains usage information, categories, and other content that is not part of the original template page.

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:Infobox 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 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 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
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 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"

mat#price gemw or integer or no or see #Prices Price of the material; use gemw to look for prices on the GEMW; set to no if the item is not tradeable and has no distinct value; use an unformatted integer if the item has a value outside of the Grand Exchange (e.g. a Blast fusion hammer is unvariable 1,000,000 coins); 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

nosmw Yes or No If present and true, will suppress SMW output. Set to true for historical/obsolete items. 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 divine energy, the quantity 1 is equal to the amount of energy required to create 1 Divine charge.

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 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

{{Infobox 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 = {{#expr:{{ovlcost|4/3}} + 162}}
|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
}}
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)1134,847[r 2]134,847
Prayer renewal (4).pngPrayer renewal (4)123,50323,503
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 energy138,025[r 6]38,025
Total price12,238,494
  1. ^ When creating multiple
  2. ^ Fixed price given
  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.

Blank infobox

All parameters

{{Infobox recipe
|name      = 
|amount    = 
|image     = 
|ticks     = 
|ticks2    = 
|ticksnote = 
|skill     = 
|level     = 
|skillXP   = 
|secSkill  = 
|secLevel  = 
|secXP     = 
|improved  = 
|method    = 
|geValue   = 
|members   = 
|facility  = 
|misc1     = 
|quest     = 
|mat1      = 
|mat1img   = 
|mat1qty   = 
|mat1price = 
|mat2      = 
|mat2img   = 
|mat2qty   = 
|mat2price = 
|mat3      = 
|mat3img   = 
|mat3qty   = 
|mat3price = 
}}

Common parameters

{{Infobox 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:Infobox 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 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 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
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

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat1imgmat1img

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat1qtymat1qty

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat1pricemat1price

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat2mat2

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat2imgmat2img

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat2qtymat2qty

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat2pricemat2price

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat3mat3

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat3imgmat3img

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat3qtymat3qty

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat3pricemat3price

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat4mat4

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat4imgmat4img

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat4qtymat4qty

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat4pricemat4price

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat5mat5

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat5imgmat5img

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat5qtymat5qty

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat5pricemat5price

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat6mat6

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat6imgmat6img

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat6qtymat6qty

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat6pricemat6price

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat7mat7

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat7imgmat7img

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat7qtymat7qty

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional
Mat7pricemat7price

no description

Default
empty
Example
empty
Auto value
empty
Unknownoptional