Module:Infobox Recipe/doc

This is the documentation page for Module:Infobox Recipe

This is a documentation subpage for Module:Infobox Recipe.

It contains usage information, categories, and other content that is not part of the original module page.

Module:Infobox Recipe's function _main is invoked by Template:Infobox Recipe.

Module:Infobox Recipe requires .

Module:Infobox Recipe loads data from Module:Experience/data.

The Infobox 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.

Parameters

Parameter	Format	Usage	Mandatory?
`facility`	Link to facility	The name of the facility that is required to create the item; e.g. `facility = Standard Potion Station` will display Standard Potion Station	Yes
`profession`	profession name	The profession in which experience is gained, or which has a level requirement, for creating the item	Yes
`level`	Integer	The level required in the profession to create the item.	Yes
`exp`	number	The amount of experience gained for performing the action.	Yes
`rawmat1`	Exact name of the item	The primary item used for performing the craft. e.g. `Brown Kelp` for Brown Kelp	Yes
`rawmat1qty`	Integer	The amount of the material used in the process. This parameter can be removed if it would be 1	No
`rawmat2`	Exact name of the item	The secondary item used for performing the craft. e.g. `Brown Kelp` for Brown Kelp	No
`rawmat2qty`	Integer	The amount of the material used in the process. This parameter can be removed if it would be 1	No
`rawmat3`	Exact name of the item	The tertiary item used for performing the craft. e.g. `Brown Kelp` for Brown Kelp	No
`rawmat3qty`	Integer	The amount of the material used in the process. This parameter can be removed if it would be 1	No
`rawmat4`	Exact name of the item	The fourth item used for performing the craft. e.g. `Brown Kelp` for Brown Kelp	No
`rawmat4qty`	Integer	The amount of the material used in the process. This parameter can be removed if it would be 1	No
`output1`	Exact name of the item	The item created by performing the craft. e.g. `Brown Kelp` for Brown Kelp	Yes
`output1qty`	Integer	The amount of the output created in the process. This parameter can be removed if it would be 1	No
`showFull`	boolean	Flag to display all steps of a recipe or only the step specified in the params	No

Examples

Show Single Step Recipe

This is an example that uses values from the 10% Potion Healing recipe. Notice that this only shows information of the steps for which the information has been provided. The showFull parameter can be omitted entirely if this is the desired outcome as the default value is false

{{Infobox Recipe
|facility = Standard Potion Station
|profession = Alchemist
|level = 0
|exp = 63
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|output1 = 10% Potion Healing
|output1qty = 1
}}

Requirements
Facility		Standard Potion Station
Experience		63
Duration		? (edit)
Profession		Level	KP	Album XP ? Album XP is a bonus awarded once for the first time the activity is performed.
Alchemist		0	? (edit)	250 xp
Raw Ingredient		Quantity	Cost
	10% Preparation Healing	1			0
	Bottle	1			20
Total Raw cost					20
Output		Quantity	Value
	10% Potion Healing	1			450
Profit					430

Show Full Recipe

This is an example that uses values from the 10% Potion Healing recipe. Notice that the parameters that have been passed to this example do not include 'Brown Kelp' This is displayed because the showFull parameter has been set to true. This causes the Infobox Module to query smw data for each of the provided raw materials to check if they have raw materials of their own. If they do, they are brought in to the recipe.

{{Infobox Recipe
|facility = Standard Potion Station
|profession = Alchemist
|level = 0
|exp = 63
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|output1 = 10% Potion Healing
|output1qty = 1
|showFull = true
}}

Requirements
Facility		Standard Potion Station
Experience		63 (105 total)
Duration		? (edit) (? total)
Profession		Level	KP	Album XP ? Album XP is a bonus awarded once for the first time the activity is performed.
Alchemist		0	? (edit)	250 xp
Raw Ingredient		Quantity	Cost
	Bottle	1			20
	Brown Kelp	1			500
Total Raw cost					520
Intermediate Ingredient		Quantity	Faciltity
	10% Preparation Healing	1	Reagent Preparation Station
Output		Quantity	Value
	10% Potion Healing	1			450
Profit					-70

Blank infobox

{{Infobox Recipe
|facility = 
|profession = 
|level = 
|exp = 
|rawmat1 = 
|rawmat1qty = 
|rawmat2 = 
|rawmat2qty = 
|rawmat3 = 
|rawmat3qty = 
|output1 = 
|output1qty =