Template:Infobox Recipe/doc: Difference between revisions

From Brighter Shores Wiki
Jump to navigation Jump to search
Content added Content deleted
No edit summary
(Sync with module docs)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{documentation}}
{{Documentation}}
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.
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.


Line 31: Line 31:
| Yes
| Yes
|-
|-
| <code>mat1</code>
| <code>rawmat1</code>
| ''Exact name of the item''
| ''Exact name of the item''
| The primary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| The primary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| Yes
| Yes
|-
|-
| <code>mat1qty</code>
| <code>rawmat1qty</code>
| ''Integer''
| ''Integer''
| The amount of the material used in the process.
| The amount of the material used in the process.


This parameter can be removed if it would be '''1'''
This parameter can be removed if it would be '''1'''
| Yes
| No
|-
|-
| <code>mat2</code>
| <code>rawmat2</code>
| ''Exact name of the item''
| ''Exact name of the item''
| The secondary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| The secondary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| No
| No
|-
|-
| <code>mat2qty</code>
| <code>rawmat2qty</code>
| ''Integer''
| ''Integer''
| The amount of the material used in the process.
| The amount of the material used in the process.
Line 55: Line 55:
| No
| No
|-
|-
| <code>mat3</code>
| <code>rawmat3</code>
| ''Exact name of the item''
| ''Exact name of the item''
| The tertiary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| The tertiary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| No
| No
|-
|-
| <code>mat3qty</code>
| <code>rawmat3qty</code>
| ''Integer''
| ''Integer''
| The amount of the material used in the process.
| The amount of the material used in the process.
Line 67: Line 67:
| No
| No
|-
|-
| <code>preparedmat1</code>
| <code>rawmat4</code>
| ''Exact name of the item''
| ''Exact name of the item''
| The first intermediary item created during the craft. e.g. <code>10% Preparation Healing</code> for [[10% Preparation Healing]] which is created from [[Brown Kelp]]
| The fourth item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| Yes
|-
| <code>preparedmat1qty</code>
| ''Integer''
| The amount of the material used in the process.

This parameter can be removed if it would be '''1'''
| Yes
|-
| <code>preparedmat1fac</code>
| ''Exact name of the facility''
| The facility used to create the first intermediary item in the process.

This parameter can be removed if it would be '''1'''
| Yes
|-
| <code>preparedmat2</code>
| ''Exact name of the item''
| The second intermediary item created during the craft. e.g. <code>Bottle</code> for [[Bottle]]
| No
| No
|-
|-
| <code>preparedmat2qty</code>
| <code>rawmat4qty</code>
| ''Integer''
| ''Integer''
| The amount of the material used in the process.
| The amount of the material used in the process.

This parameter can be removed if it would be '''1'''
| No
|-
| <code>preparedmat2fac</code>
| ''Exact name of the facility''
| The facility used to create the second intermediary item in the process.


This parameter can be removed if it would be '''1'''
This parameter can be removed if it would be '''1'''
Line 113: Line 87:
| ''Integer''
| ''Integer''
| The amount of the output created in the process.
| The amount of the output created in the process.

This parameter can be removed if it would be '''1'''
| No
|-
| <code>showFull</code>
| ''boolean''
| Flag to display all steps of a recipe or only the step specified in the params
| No
| No
|-
|-
|}
|}


==Example==
==Examples==
===Show Single Step Recipe===
This is an example that uses values from the 10% Potion Healing 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 <code>showFull</code> parameter can be omitted entirely if this is the desired outcome as the default value is <code>false</code>
<pre>
{{Infobox Recipe
|facility = Standard Potion Station
|profession = Alchemist
|level = 0
|exp = 63
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|output1 = 10% Potion Healing
|output1qty = 1
}}
</pre>
{{Infobox Recipe
|facility = Standard Potion Station
|profession = Alchemist
|level = 0
|exp = 63
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|output1 = 10% Potion Healing
|output1qty = 1
}}

===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 <code>showFull</code> parameter has been set to <code>true</code>. 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.
<pre>
<pre>
{{Template Infobox Recipe
{{Infobox Recipe
|facility = Standard Potion Station
|facility = Standard Potion Station
|profession = Alchemist
|profession = Alchemist
|level = 0
|level = 0
|exp = 63
|exp = 63
|rawmat1 = Brown Kelp
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|rawmat1qty = 1
|preparedmat1 = 10% Preparation Healing
|preparedmat1qty = 1
|preparedmat1fac = Reagent Preparation Station
|preparedmat2 = Bottle
|preparedmat2qty = 1
|preparedmat2fac = Standard Potion Station
|output1 = 10% Potion Healing
|output1 = 10% Potion Healing
|output1qty = 1
|output1qty = 1
|showFull = true
}}
}}
</pre>
</pre>
{{Template: Infobox Recipe
{{Infobox Recipe
|facility = Standard Potion Station
|facility = Standard Potion Station
|profession = Alchemist
|profession = Alchemist
|level = 0
|level = 0
|exp = 63
|exp = 63
|rawmat1 = Brown Kelp
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|rawmat1qty = 1
|preparedmat1 = 10% Preparation Healing
|preparedmat1qty = 1
|preparedmat1fac = Reagent Preparation Station
|preparedmat2 = Bottle
|preparedmat2qty = 1
|preparedmat2fac = Standard Potion Station
|output1 = 10% Potion Healing
|output1 = 10% Potion Healing
|output1qty = 1
|output1qty = 1
|showFull = true
}}
}}


==Blank infobox==
==Blank infobox==
<pre>
<pre>
{{Template:Infobox Recipe
{{Infobox Recipe
|facility =
|facility =
|profession =
|profession =
|level =
|level =
|exp =
|exp =
|rawmat1 =
|rawmat1 =
|rawmat1qty =
|rawmat1qty =
|rawmat2 =
|rawmat2 =
|rawmat3qty =
|rawmat2qty =
|rawmat3 =
|rawmat3 =
|rawmat2qty =
|rawmat3qty =
|output1 =
|preparedmat1 =
|output1qty =
|preparedmat1qty =
|preparedmat1fac =
|preparedmat2 =
|preparedmat2qty =
|preparedmat2fac =
|output1 =
|output1qty =
</pre>
</pre>


{{TemplateData|
<includeonly>[[Category:Infobox templates|ChefRecipeTest]]</includeonly>
<templatedata>
{
"params": {
"facility": {},
"profession": {},
"level": {},
"exp": {},
"rawmat1": {},
"rawmat1qty": {},
"rawmat2": {},
"rawmat2qty": {},
"rawmat3": {},
"rawmat3qty": {},
"output1": {},
"output1qty": {},
"showFull": {}
},
"paramOrder": [
"facility",
"profession",
"level",
"exp",
"rawmat1",
"rawmat1qty",
"rawmat2",
"rawmat2qty",
"rawmat3",
"rawmat3qty",
"output1",
"output1qty",
"showFull"
],
"format": "block"
}
</templatedata>
}}<includeonly>[[Category:Infobox templates]]</includeonly>

Latest revision as of 21:18, 21 November 2024

This is a documentation subpage for Template:Infobox Recipe.
It contains usage information, categories, and other content that is not part of the original template page.
Template:Infobox Recipe invokes function _main in Module:Infobox Recipe using Lua.

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
ProfessionLevelXP
Alchemist063
Raw IngredientQuantityCost
10% Preparation Healing10Copper
Bottle120Copper
Total Raw cost20Copper
OutputQuantityValue
10% Potion Healing1450Copper
Profit430Copper

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
ProfessionLevelXP
Alchemist063
Raw IngredientQuantityCost
Brown Kelp1500Copper
Bottle120Copper
Total Raw cost520Copper
Intermediate IngredientQuantityFaciltity
10% Preparation Healing1 Reagent Preparation Station
OutputQuantityValue
10% Potion Healing1450Copper
Profit-70Copper

Blank infobox

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

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.


No description.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
facilityfacility

no description

Unknownoptional
professionprofession

no description

Unknownoptional
levellevel

no description

Unknownoptional
expexp

no description

Unknownoptional
rawmat1rawmat1

no description

Unknownoptional
rawmat1qtyrawmat1qty

no description

Unknownoptional
rawmat2rawmat2

no description

Unknownoptional
rawmat2qtyrawmat2qty

no description

Unknownoptional
rawmat3rawmat3

no description

Unknownoptional
rawmat3qtyrawmat3qty

no description

Unknownoptional
output1output1

no description

Unknownoptional
output1qtyoutput1qty

no description

Unknownoptional
showFullshowFull

no description

Unknownoptional