Template:Infobox Recipe/doc: Difference between revisions
Sync with module docs
(Created page with "{{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. ==Parameters== {| class="wikitable" ! Parameter ! Format ! Usage ! Mandatory? |- | <code>facility</code> | ''Link to facility'' | The name of the facility that is required to create the item; e.g. <code><nowiki>facility = Standard...") |
Im Wired In (talk | contribs) (Sync with module docs) |
||
| (8 intermediate revisions by 4 users not shown) | |||
Line 1:
{{
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:
| Yes
|-
| <code>
| ''Exact name of the item''
| The primary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| Yes
|-
| <code>
| ''Integer''
| The amount of the material used in the process.
This parameter can be removed if it would be '''1'''
|
|-
| <code>
| ''Exact name of the item''
| The secondary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
|
|-
| <code>
| ''Integer''
| The amount of the material used in the process.
This parameter can be removed if it would be '''1'''
|
|-
| <code>rawmat3</code>
| ''Exact name of the item''
| The tertiary item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| No
|-
| <code>rawmat3qty</code>
| ''Integer''
| The amount of the material used in the process.
This parameter can be removed if it would be '''1'''
| No
|-
| <code>rawmat4</code>
| ''Exact name of the item''
| The fourth item used for performing the craft. e.g. <code>Brown Kelp</code> for [[Brown Kelp]]
| No
|-
| <code>rawmat4qty</code>
| ''Integer''
| The amount of the material used in the process.
This parameter can be removed if it would be '''1'''
| No
|-
| <code>output1</code>
Line 63 ⟶ 87:
| ''Integer''
| 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
|-
|}
==
===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 <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 =
|exp =
|rawmat1 = 10% Preparation Healing
|
|output1 = 10% Potion Healing
|
}}
</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>
{{Infobox Recipe
|facility = Standard Potion Station
|profession = Alchemist
|level =
|exp =
|rawmat1 = 10% Preparation Healing
|
|output1 = 10% Potion Healing
|
|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
}}
Line 104 ⟶ 161:
|level =
|exp =
|
|
|
|
|rawmat3 =
|rawmat3qty =
|output1 =
|output1qty =
</pre>
{{TemplateData|
<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>
| |||