Template:Infobox Recipe/doc: Difference between revisions

Jump to navigation Jump to search
Browse history interactively
Content added Content deleted
VisualWikitext
m (Add new parameters to doc)
(Sync with module docs)
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 41: Line 41:


This parameter can be removed if it would be '''1'''
This parameter can be removed if it would be '''1'''
| Yes
| No
|-
|-
| <code>rawmat2</code>
| <code>rawmat2</code>
Line 79: Line 79:
| No
| No
|-
|-
| <code>preparedmat1</code>
| <code>output1</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 item created by performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| Yes
| Yes
|-
|-
| <code>preparedmat1qty</code>
| <code>output1qty</code>
| ''Integer''
| ''Integer''
| The amount of the material used in the process.
| The amount of the output created in the process.


This parameter can be removed if it would be '''1'''
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>showFull</code>
| ''Integer''
| ''boolean''
| The amount of the material used in the process.
| Flag to display all steps of a recipe or only the step specified in the params

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'''
| No
|-
| <code>output1</code>
| ''Exact name of the item''
| The item created by performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| Yes
|-
| <code>output1qty</code>
| ''Integer''
| The amount of the output created in the process.
| 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>
<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
}}
}}
</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
}}

===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>
{{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
}}
</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
|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>


Line 193: Line 175:
{
{
"params": {
"params": {
"rawmat1": {},
"rawmat2": {},
"output1": {},
"facility": {},
"facility": {},
"profession": {},
"profession": {},
"level": {},
"level": {},
"exp": {},
"exp": {},
"rawmat1": {},
"rawmat1qty": {},
"rawmat1qty": {},
"rawmat2": {},
"rawmat2qty": {},
"rawmat2qty": {},
"output1qty": {},
"rawmat3": {},
"rawmat3": {},
"rawmat3qty": {},
"rawmat3qty": {},
"preparedmat1": {},
"output1": {},
"preparedmat1qty": {},
"output1qty": {},
"preparedmat2": {},
"showFull": {}
"preparedmat2qty": {},
"preparedmat1fac": {},
"preparedmat2fac": {},
"preparedmat3": {},
"preparedmat3qty": {},
"preparedmat3fac": {}
},
},
"paramOrder": [
"paramOrder": [
Line 226: Line 200:
"rawmat3",
"rawmat3",
"rawmat3qty",
"rawmat3qty",
"preparedmat1",
"preparedmat1qty",
"preparedmat1fac",
"preparedmat2",
"preparedmat2qty",
"preparedmat2fac",
"preparedmat3",
"preparedmat3qty",
"preparedmat3fac",
"output1",
"output1",
"output1qty"
"output1qty",
"showFull"
],
],
"format": "block"
"format": "block"
Retrieved from ‘https://brightershoreswiki.org/w/Template:Infobox_Recipe/doc’