Template:Infobox Recipe/doc: Difference between revisions
The Gaffer (talk | contribs) No edit summary |
(add the kp documentation, which I accidentally put on the doc for the module not template) |
||
(6 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{ |
{{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 14: | Line 14: | ||
[[Standard Potion Station]] |
[[Standard Potion Station]] |
||
| Yes |
|||
|- |
|||
| <code>duration</code> |
|||
| ''duration in seconds'' |
|||
| The amount of time that the recipe takes to complete; e.g. <code><nowiki>duration = 7.5</nowiki></code> will display |
|||
7.5s |
|||
| Yes |
| Yes |
||
|- |
|- |
||
| <code>profession</code> |
| <code>profession</code> |
||
| ''profession name'' |
| ''profession name'' |
||
| The profession in which experience is gained, or which has a level requirement, for creating the item |
| The profession in which experience is gained, or which has a level requirement, for creating the item. |
||
e.g. <code>profession = Alchemist</code> for [[Alchemist]] |
|||
| Yes |
| Yes |
||
|- |
|- |
||
Line 29: | Line 38: | ||
| ''number'' |
| ''number'' |
||
| The amount of experience gained for performing the action. |
| The amount of experience gained for performing the action. |
||
| Yes |
|||
|- |
|||
| <code>kp</code> |
|||
| ''number'' |
|||
| The amount of knowledge points gained for performing the action. e.g. <code>kp = 1.5%</code> |
|||
| Yes |
| Yes |
||
|- |
|- |
||
Line 41: | Line 55: | ||
This parameter can be removed if it would be '''1''' |
This parameter can be removed if it would be '''1''' |
||
| |
| No |
||
|- |
|- |
||
| <code>rawmat2</code> |
| <code>rawmat2</code> |
||
Line 67: | Line 81: | ||
| No |
| No |
||
|- |
|- |
||
| <code> |
| <code>rawmat4</code> |
||
| ''Exact name of the item'' |
| ''Exact name of the item'' |
||
| The |
| 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> |
| <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 101: | ||
| ''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== |
||
===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> |
||
{{ |
{{Infobox Recipe |
||
|facility = Standard Potion Station |
|facility = Standard Potion Station |
||
|duration = 7.5 |
|||
|profession = Alchemist |
|profession = Alchemist |
||
|level = 0 |
|level = 0 |
||
|exp = 63 |
|exp = 63 |
||
|kp = 1.5% |
|||
|rawmat1 = Brown Kelp |
|||
|rawmat1 = 10% Preparation Healing |
|||
|rawmat1qty = 1 |
|||
|rawmat2 = Bottle |
|||
|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> |
||
{{ |
{{Infobox Recipe |
||
|facility = Standard Potion Station |
|facility = Standard Potion Station |
||
|duration = 7.5 |
|||
|profession = Alchemist |
|profession = Alchemist |
||
|level = 0 |
|level = 0 |
||
|exp = 63 |
|exp = 63 |
||
|kp = 1.5% |
|||
|rawmat1 = Brown Kelp |
|||
|rawmat1 = 10% Preparation Healing |
|||
|rawmat1qty = 1 |
|||
|rawmat2 = Bottle |
|||
|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> |
<pre> |
||
{{ |
{{Infobox Recipe |
||
|facility = |
|facility = Standard Potion Station |
||
|duration = 7.5 |
|||
|profession = |
|||
|profession = Alchemist |
|||
|level = |
|||
| |
|level = 0 |
||
| |
|exp = 63 |
||
|kp = 1.5% |
|||
|rawmat1qty = |
|||
|rawmat1 = 10% Preparation Healing |
|||
|rawmat2 = |
|||
|rawmat2 = Bottle |
|||
|rawmat3qty = |
|||
|output1 = 10% Potion Healing |
|||
|rawmat3 = |
|||
|output1qty = 1 |
|||
|rawmat2qty = |
|||
|showFull = true |
|||
|preparedmat1 = |
|||
}} |
|||
|preparedmat1qty = |
|||
|preparedmat1fac = |
|||
|preparedmat2 = |
|||
|preparedmat2qty = |
|||
|preparedmat2fac = |
|||
|output1 = |
|||
|output1qty = |
|||
</pre> |
</pre> |
||
{{Infobox Recipe |
|||
|facility = Standard Potion Station |
|||
|duration = 7.5 |
|||
|profession = Alchemist |
|||
|level = 0 |
|||
|exp = 63 |
|||
|kp = 1.5% |
|||
|rawmat1 = 10% Preparation Healing |
|||
|rawmat2 = Bottle |
|||
|output1 = 10% Potion Healing |
|||
|output1qty = 1 |
|||
|showFull = true |
|||
}} |
|||
==Blank infobox== |
|||
<pre> |
|||
{{Infobox Recipe |
|||
|facility = |
|||
|duration = |
|||
|profession = |
|||
|level = |
|||
|exp = |
|||
|kp = |
|||
|rawmat1 = |
|||
|rawmat1qty = |
|||
|rawmat2 = |
|||
|rawmat2qty = |
|||
|rawmat3 = |
|||
|rawmat3qty = |
|||
|output1 = |
|||
|output1qty = |
|||
</pre><includeonly>[[Category:Infobox templates]]</includeonly> |
|||
{{TemplateData| |
|||
<includeonly>[[Category:Infobox templates|ChefRecipeTest]]</includeonly> |
|||
<templatedata> |
|||
{ |
|||
"params": { |
|||
"facility": {}, |
|||
"duration": {}, |
|||
"profession": {}, |
|||
"level": {}, |
|||
"exp": {}, |
|||
"rawmat1": {}, |
|||
"rawmat1qty": {}, |
|||
"rawmat2": {}, |
|||
"rawmat2qty": {}, |
|||
"rawmat3": {}, |
|||
"rawmat3qty": {}, |
|||
"output1": {}, |
|||
"output1qty": {}, |
|||
"showFull": {} |
|||
}, |
|||
"paramOrder": [ |
|||
"facility", |
|||
"duration", |
|||
"profession", |
|||
"level", |
|||
"exp", |
|||
"rawmat1", |
|||
"rawmat1qty", |
|||
"rawmat2", |
|||
"rawmat2qty", |
|||
"rawmat3", |
|||
"rawmat3qty", |
|||
"output1", |
|||
"output1qty", |
|||
"showFull" |
|||
], |
|||
"format": "block" |
|||
} |
|||
</templatedata> |
|||
}}<includeonly>[[Category:Infobox templates]]</includeonly> |
Latest revision as of 14:31, 26 November 2024
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
|
Yes |
duration
|
duration in seconds | The amount of time that the recipe takes to complete; e.g. duration = 7.5 will display
7.5s |
Yes |
profession
|
profession name | The profession in which experience is gained, or which has a level requirement, for creating the item.
e.g. |
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 |
kp
|
number | The amount of knowledge points gained for performing the action. e.g. kp = 1.5%
|
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 |duration = 7.5 |profession = Alchemist |level = 0 |exp = 63 |kp = 1.5% |rawmat1 = 10% Preparation Healing |rawmat2 = Bottle |output1 = 10% Potion Healing |output1qty = 1 }}
Requirements | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Facility | Standard Potion Station | |||||||||||
Duration | 7.5s | |||||||||||
Profession | Level | KP | XP | |||||||||
Alchemist | 0 | 1.5% | 63 | |||||||||
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 |duration = 7.5 |profession = Alchemist |level = 0 |exp = 63 |kp = 1.5% |rawmat1 = 10% Preparation Healing |rawmat2 = Bottle |output1 = 10% Potion Healing |output1qty = 1 |showFull = true }}
Requirements | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Facility | Standard Potion Station | |||||||||||
Duration | 7.5s | |||||||||||
Profession | Level | KP | XP | |||||||||
Alchemist | 0 | 1.5% | 63 | |||||||||
Raw Ingredient | Quantity | Cost | ||||||||||
Brown Kelp | 1 | 500 | ||||||||||
Bottle | 1 | 20 | ||||||||||
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 = |duration = |profession = |level = |exp = |kp = |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.
|