Template:Recipe/doc: Difference between revisions

From Against the Storm Official Wiki
(separated the documentation page)
 
m (amending example for product and ingredient combo; removing note at the top)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
This template calls <code>renderRecipe</code> in '''Module:RenderRecipe''' to get recipes for a product and/or a building. This will generate a new wikitable full of content from the game: buildings, stars of efficiency, ingredients, and products.
== Overview ==


This template standardizes the display of recipes throughout this wiki and greatly simplifies the amount of writing that is necessary when adding new content pages, especially for resources and buildings.
Creates a detailed table showing one or more recipes.


Use whenever you need to show a wiki-linked, user-friendly, sortable, and always-up-to-date version of the in-game recipe book instead of a screenshot. You can get very specific and narrow down the table to only one recipe with the parameters.


== Usage ==
The table mimics the in-game recipe book with the building, efficiency grade and production time, ingredients, and product or service.


The table will contain exactly one recipe if the template is given both a product and building. The table will (usually) contain more than one row if the template is given either a product or a building. If nothing is provided, for example <code><nowiki>{{Recipe}}</nowiki></code>, an error will appear instead.
The table is completely data-driven, based on the parameters. It validates input, retrieves all necessary data, and handles all formatting.


Here are ways to call the template, as they would be written in the article calling the template:
The normal usage for this template produces a large table that typically fills the width of the article. (In rare cases, the table ''can'' overrun into the margin. This is a known issue and steps have already been taken to reduce the width of the table.)
 
== Parameters ==
 
=== Product, Building, or Ingredient ===
 
'''At least one of these is required,''' and combinations are allowed. All names provided must be spelled (and, for buildings, punctuated) correctly to match the in-game name. These names will be the same as the articles for those goods and buildings.
 
If you do not wish to write the code <code>product=</code> and <code>building=</code>, you may skip that. If you skip naming them, they must appear in that order, and you cannot skip the product name. The ingredient must always be named. In the future, because building names and resource names are mutually exclusive, this template may be made more flexible with the product and building parameter.


{| class="wikitable"
{| class="wikitable"
! Argument !! Examples !! Expected outcome
! Parameter !! Type !!colspan=2| Description
|-
|-
| None
| product || string || The name of the product or service associated with the recipe. (If you specify a service, '''do not''' change the parameter name from <code>product</code>.)
| <code><nowiki>{{Recipe}}</nowiki></code>
|rowspan=3| '''At least<br />one of these<br /> is required.'''
| An error
|-
|-
| Product and building
| building || string || The name of the building where the recipe is produced.
| style="white-space: nowrap" | <code><nowiki>{{Recipe|Crystalized Dew|Brickyard}}</nowiki></code> <br> <code><nowiki>{{Recipe|product=Crystalized Dew|building=Brickyard}}</nowiki></code>
| A table with one row.
|-
|-
| Product only
| ingredient || string || The name of any ingredient in a recipe.
| style="white-space: nowrap" | <code><nowiki>{{Recipe|Pie}}</nowiki></code> <br> <code><nowiki>{{Recipe|product=Pie}}</nowiki></code>
| A table with several rows, one for each building in which '''Pie''' can be produced.
|-
|-
| Building only
| display || "list" ||colspan=2| If you include <code>display=list</code> it overrides the table display into a bulleted list of products or buildings (depending on which you specified). Useful for populating larger tables or between paragraphs where displaying the entire recipe is excessive or irrelevant.
| style="white-space: nowrap" | <code><nowiki>{{Recipe||Scribe}}</nowiki></code> ''(note the double pipe)'' <br> <code><nowiki>{{Recipe|building=Scribe}}</nowiki></code>
| A table with several rows, one for each product that can be produced in the '''Scribe.'''
|}
|}


== Examples ==
=== Basic usage ===
<pre>{{Recipe|Crystalized Dew|Brickyard}}</pre>
Makes a table of exactly one recipe, for the specified product, in the specified building.
{{Recipe|Crystalized Dew|Brickyard}}
<pre>{{Recipe||Tavern}}</pre>
Makes a table showing the services and service goods in the specified building. Note the double-pipe character (||), which skips specifying the product. If you prefer more readable template calls, you can write <code>building=</code> instead of two pipes.
{{Recipe||Tavern}}
<pre>{{Recipe|building=Press|ingredient=Grain}}</pre>
Makes a table of the recipes that use (instead of produce) the specified ingredient. If you omit the building, you will get a ''much'' longer table of all recipes that use Grain.
{{Recipe|building=Press|ingredient=Grain}}
== Other examples ==
<pre>{{Recipe|ingredient=Grain|display=list}}</pre>
To show all of those recipes, we can instead use the display override to show a bulleted list with much less information overall but in a much more compact form.
{{Recipe|ingredient=Grain|display=list}}
<pre>{{Recipe|product=Meat|ingredient=Plant Fiber}}</pre>
<pre>{{Recipe|product=Meat}}</pre>
Specifying both the product and ingredient is redundant in most cases. Only when products can be both (a) gathered and (b) produced in industry buildings will the results be different. There is currently no way to match only recipes with empty ingredients except by making separate boxes for separate buildings.
{{Recipe|product=Meat|ingredient=Plant Fiber}}
{{Recipe|product=Meat}}
<pre>{{Recipe|building=Press|display=list}}</pre>
<pre>{{Recipe|product=Oil|display=list}}</pre>
The bulleted list example above was made by specifying the Grain ingredient, which resulted in a list of products made from that ingredient. Specifying a building also makes a list of products, those made in that building:
{{Recipe|building=Press|display=list}}
However, specifying a product instead makes a list of buildings, those where that product is made:
{{Recipe|product=Oil|display=list}}


== Examples ==


The following are generated by calling the template, as shown in the examples in the table above.
<pre>{{Recipe||Supplier|Grain}}</pre>
Forgetting to explicitly name the ingredient parameter with <code>ingredient=</code> does not result in an error, but the ingredient is ignored:
{{Recipe||Supplier|Grain}}
 
 
<pre>{{Recipe|building=Small Warehouse}}</pre>
<pre>{{Recipe|Flour|Brickyard}}</pre>
Asking for buildings with no recipes does not result in an error, but an empty table. Empty tables can also happen if you ask for a combination of product, building, and ingredient which are valid but result in no recipes.
{{Recipe|building=Small Warehouse}}
 
{{Recipe|Flour|Brickyard}}
 
 
=== Errors ===
 
The following are error messages generated by calling the template incorrectly.


<code><nowiki>{{Recipe}}</nowiki></code> yields:
Note: If you are having trouble understanding how the template is understanding your parameters, the caption can help!


{{Recipe}}
<pre>{{Recipe}}</pre>
With no parameters: {{Recipe}}




<code><nowiki>{{Recipe|Crystalized Dew|Brickyard}}</nowiki></code> yields:
<pre>{{Recipe|product=Reeds}}</pre>
<pre>{{Recipe|building=Alchemists' Hut}}</pre>
Misspelling the name of a resource: {{Recipe|product=Reeds}}


{{Recipe|Crystalized Dew|Brickyard}}
Or the name of a building: {{Recipe|building=Alchemists' Hut}}




<code><nowiki>{{Recipe|Pie}}</nowiki></code> yields:
<pre>{{Recipe|Scribe}}</pre>
Forgetting the second pipe when only specifying the building: {{Recipe|Scribe}}


{{Recipe|Pie}}


<pre>{{Recipe|||Grain}}</pre>
Using 3 pipes to skip product and building, but not explicitly naming the ingredient parameter with <code>ingredient=</code>: {{Recipe|||Grain}}


<code><nowiki>{{Recipe||Scribe}}</nowiki></code> yields:


{{Recipe||Scribe}}
<pre>{{Recipe|product=Smoothies}}</pre>
Naming a product (or building, or ingredient) that doesn't exist in the game (or misspelling or mis-punctuating a building name): {{Recipe|product=Smoothies}}

Latest revision as of 21:27, 31 October 2024

Overview

Creates a detailed table showing one or more recipes.

Use whenever you need to show a wiki-linked, user-friendly, sortable, and always-up-to-date version of the in-game recipe book instead of a screenshot. You can get very specific and narrow down the table to only one recipe with the parameters.

The table mimics the in-game recipe book with the building, efficiency grade and production time, ingredients, and product or service.

The table is completely data-driven, based on the parameters. It validates input, retrieves all necessary data, and handles all formatting.

The normal usage for this template produces a large table that typically fills the width of the article. (In rare cases, the table can overrun into the margin. This is a known issue and steps have already been taken to reduce the width of the table.)

Parameters

Product, Building, or Ingredient

At least one of these is required, and combinations are allowed. All names provided must be spelled (and, for buildings, punctuated) correctly to match the in-game name. These names will be the same as the articles for those goods and buildings.

If you do not wish to write the code product= and building=, you may skip that. If you skip naming them, they must appear in that order, and you cannot skip the product name. The ingredient must always be named. In the future, because building names and resource names are mutually exclusive, this template may be made more flexible with the product and building parameter.

Parameter Type Description
product string The name of the product or service associated with the recipe. (If you specify a service, do not change the parameter name from product.) At least
one of these
is required.
building string The name of the building where the recipe is produced.
ingredient string The name of any ingredient in a recipe.
display "list" If you include display=list it overrides the table display into a bulleted list of products or buildings (depending on which you specified). Useful for populating larger tables or between paragraphs where displaying the entire recipe is excessive or irrelevant.

Examples

Basic usage

{{Recipe|Crystalized Dew|Brickyard}}

Makes a table of exactly one recipe, for the specified product, in the specified building.

1 recipes for Crystalized Dew in the Brickyard.
Building Grade Ingredient #1 Ingredient #2 Ingredient #3 Product
Brickyard
★
0:42
3 Herbs Herbs
3 Insects Insects
3 Resin Resin
3 Vegetables Vegetables
3 Algae Algae
4 Stone Stone
4 Clay Clay
10 Storm Water Storm Water
14 Clearance Water Clearance Water
18 Drizzle Water Drizzle Water
2 Crystalized Dew 


{{Recipe||Tavern}}

Makes a table showing the services and service goods in the specified building. Note the double-pipe character (||), which skips specifying the product. If you prefer more readable template calls, you can write building= instead of two pipes.

2 recipes in the Tavern.
Building Grade Ingredient Product
Tavern
★
0:00
1 Ale Ale
1 Leisure Leisure
Tavern
★
0:00
1 Wine Wine
1 Luxury Luxury 


{{Recipe|building=Press|ingredient=Grain}}

Makes a table of the recipes that use (instead of produce) the specified ingredient. If you omit the building, you will get a much longer table of all recipes that use Grain.

2 recipes using Grain in the Press.
Building Grade Ingredient Product
Press
★★★
1:03
2 Grain Grain
2 Meat Meat
2 Vegetables Vegetables
2 Plant Fiber Plant Fiber
2 Fish Fish
5 Oil Oil
Press
★
1:24
8 Grain Grain
8 Mushrooms Mushrooms
8 Roots Roots
8 Algae Algae
10 Flour Flour


Other examples

{{Recipe|ingredient=Grain|display=list}}

To show all of those recipes, we can instead use the display override to show a bulleted list with much less information overall but in a much more compact form. 


{{Recipe|product=Meat|ingredient=Plant Fiber}}
{{Recipe|product=Meat}}

Specifying both the product and ingredient is redundant in most cases. Only when products can be both (a) gathered and (b) produced in industry buildings will the results be different. There is currently no way to match only recipes with empty ingredients except by making separate boxes for separate buildings.

1 recipes for Meat using Plant Fiber.
Building Grade Ingredient Product
Ranch Ranch
★
1:24
8 Plant Fiber Plant Fiber
8 Reed Reed
8 Algae Algae
8 Grain Grain
5 Vegetables Vegetables
10 Meat


3 recipes for Meat.
Building Grade Ingredient Product
Trappers' Camp Trappers' Camp
★★
0:17 		— 1 Meat
Small Trappers' Camp Small Trappers' Camp
★
0:25 		— 1 Meat
Ranch Ranch
★
1:24
8 Plant Fiber Plant Fiber
8 Reed Reed
8 Algae Algae
8 Grain Grain
5 Vegetables Vegetables
10 Meat 



{{Recipe|building=Press|display=list}}
{{Recipe|product=Oil|display=list}}

The bulleted list example above was made by specifying the Grain ingredient, which resulted in a list of products made from that ingredient. Specifying a building also makes a list of products, those made in that building:


However, specifying a product instead makes a list of buildings, those where that product is made: 


{{Recipe||Supplier|Grain}}

Forgetting to explicitly name the ingredient parameter with ingredient= does not result in an error, but the ingredient is ignored:

3 recipes in the Supplier.
Building Grade Ingredient #1 Ingredient #2 Product
Supplier
★★
1:03 		—
7 Grain Grain
7 Mushrooms Mushrooms
7 Roots Roots
7 Algae Algae
10 Flour Flour
Supplier
★★
0:42 		—
5 Wood Wood
2 Planks Planks
Supplier
★★
1:24
5 Leather Leather
5 Scales Scales
3 Oil Oil
3 Meat Meat
10 Waterskins Waterskins 


{{Recipe|building=Small Warehouse}}
{{Recipe|Flour|Brickyard}}

Asking for buildings with no recipes does not result in an error, but an empty table. Empty tables can also happen if you ask for a combination of product, building, and ingredient which are valid but result in no recipes.

0 recipes in the Small Warehouse.
No recipes.


0 recipes for Flour in the Brickyard.
No recipes.


Errors

The following are error messages generated by calling the template incorrectly.

Note: If you are having trouble understanding how the template is understanding your parameters, the caption can help! 

{{Recipe}}

With no parameters: Lua error in Module:RecipeController at line 160: You must specify a product, building, or ingredient. Please see the template documentation for how to use the parameters. 


{{Recipe|product=Reeds}}
{{Recipe|building=Alchemists' Hut}}

Misspelling the name of a resource: Lua error in Module:RecipeController at line 160: You must specify a product, building, or ingredient. Please see the template documentation for how to use the parameters.


Or the name of a building: Lua error in Module:RecipeController at line 160: You must specify a product, building, or ingredient. Please see the template documentation for how to use the parameters. 


{{Recipe|Scribe}}

Forgetting the second pipe when only specifying the building: Lua error in Module:RecipeController at line 160: You must specify a product, building, or ingredient. Please see the template documentation for how to use the parameters. 


{{Recipe|||Grain}}

Using 3 pipes to skip product and building, but not explicitly naming the ingredient parameter with ingredient=: Lua error in Module:RecipeController at line 160: You must specify a product, building, or ingredient. Please see the template documentation for how to use the parameters. 


{{Recipe|product=Smoothies}}

Naming a product (or building, or ingredient) that doesn't exist in the game (or misspelling or mis-punctuating a building name): Lua error in Module:RecipeController at line 160: You must specify a product, building, or ingredient. Please see the template documentation for how to use the parameters.

Retrieved from "https://hoodedhorse.com/wiki/Against_the_Storm/index.php?title=Template:Recipe/doc&oldid=9309"