Brighter Shores Wiki

Editing Template:Infobox Recipe/doc

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
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>rawmat1</code>
| <code>mat1</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>rawmat1qty</code>
| <code>mat1qty</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'''
| No
| Yes
|-
|-
| <code>rawmat2</code>
| <code>mat2</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
| Yes
|-
|-
| <code>rawmat2qty</code>
| <code>mat2qty</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'''
| No
| Yes
|-
| <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>
| <code>output1</code>
Line 87: Line 63:
| ''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
|-
|-
|}
|}


==Examples==
==Example==
This is an example that uses random values just to display the functionality of the template.
===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>
<pre>
{{Infobox Recipe
{{Infobox Recipe
|facility = Standard Potion Station
|facility =
|profession = Alchemist
|profession = Alchemist
|level = 0
|level = 123
|exp = 63
|exp = 9876
|mat1 = Brown Kelp
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|mat1qty = 6
|mat2 = Basic Omelette
|output1 = 10% Potion Healing
|output1qty = 1
|mat2qty = 3
|output1 = Fishing Spear
|output1qty = 2
}}
}}
</pre>
</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
{{Infobox Recipe
|facility = Standard Potion Station
|facility = Standard Potion Station
|profession = Alchemist
|profession = Alchemist
|level = 0
|level = 123
|exp = 63
|exp = 9876
|mat1 = Brown Kelp
|rawmat1 = 10% Preparation Healing
|rawmat2 = Bottle
|mat1qty = 6
|mat2 = Basic Omelette
|output1 = 10% Potion Healing
|output1qty = 1
|mat2qty = 3
|output1 = Fishing Spear
|showFull = true
|output1qty = 2
}}
</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 161: Line 104:
|level =
|level =
|exp =
|exp =
|rawmat1 =
|mat1 =
|rawmat1qty =
|mat1qty =
|rawmat2 =
|mat2 =
|rawmat2qty =
|mat2qty =
|rawmat3 =
|rawmat3qty =
|output1 =
|output1 =
|output1qty =
|output1qty =
}}
</pre>
</pre>


<includeonly>[[Category:Infobox templates|Recipe]]</includeonly>
{{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>
Please note that all contributions to Brighter Shores Wiki are considered to be released under the CC BY-NC-SA 3.0 (see Brighter Shores:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Preview page with this template

Templates used on this page:

This page is a member of a hidden category:

Retrieved from ‘https://brightershoreswiki.org/w/Template:Infobox_Recipe/doc’