Modèle:Recipes/doc
Query crafting recipes from database and display them as a table. The original source for the data can be found on the subpages of Recipes.
Usage
Parameters for query constraints:
station
= station1/station2/...
List only recipes that use these stations.
stationnot
= station1/station2/...
Exclude recipes that use these stations.
result
= result1/result2/...
List only recipes that create this item. It is also possible to do pattern search using SQL LIKE syntax. Example: result=LIKE %Phaseblade
, multiple:result=Iron Bar/LIKE %Phaseblade
. Note that "LIKE" must be all uppercase.
resultnot
= result1/result2/...
Exclude recipes that create this item. It is also possible to do pattern search using SQL LIKE syntax. Example: resultnot=LIKE %Phaseblade
, multiple:resultnot=Iron Bar/LIKE %Phaseblade
. Note that "LIKE" must be all uppercase.
ingredient
= ingredient1/ingredient2/...
List only recipes that use these items as ingredients. You can use "Any xxx" as ingredient name for some alternative crafting ingredients groups; and, if you query an item in a substitutable item group, you will get "Any xxx" as well. Adding "#" as a prefix (#xxx) will turn this off for that specific item. For example, if you query by |ingredient=Shadewood
, you will get recipes as if you query by ingredient=#Shadewood/#Any Wood
; |ingredient=#Shadewood/Iron Bar
equals to |ingredient=#Shadewood/#Iron Bar/#Any Iron Bar
. It is also possible to do pattern search using SQL LIKE syntax. Example: ingredient=LIKE %Phaseblade
, multiple:ingredient=Iron Bar/LIKE %Phaseblade
. Note that "LIKE" must be all uppercase.
version
/versions
= platform-platform-platform
List only recipes that are exclusive to the specified platforms. Please note that this parameter requires full-match. For example, if a recipe is exclusive to desktop and console, you must use |version=desktop-console
(can be in any order) to match it. |version=desktop
will not match it.
NOTE: The relationship between the above parameters is "and", and the relationship of multiple values inside a single parameter is "or". For example, |station=Sawmill/Loom|resultnot=Silk
means (in SQL style):(station = Sawmill OR station = Loom) AND result <> Silk
where
= whereString
Raw input string for where the parameter of cargo query is located. If specified, all of above parameters are ignored. Used to write complex queries when necessary, with caution.
Other parameters:
title
Adds a title bar to the recipes table, with specified text.
grouping
= n/no
Turn off result & ext cols grouping.
nostation
= y
If set, the Crafting Station column will be hidden.
stationgrouping
= n/no
Turn off Crafting Station column grouping. Only valid when nostation
is not set.
showresultid
= y
If set, result items will show their internal item IDs (if available).
cate
= no/force
By default, this template will add transcluding page to crafting station category if crafting result is the page title itself. cate=no
will disable this. cate=force
will force categorization, no matter what the result and page title are.
link
= n/no
Set to n/no
to stop the result items from linking to their pages.
expectedrows
= number
Assert the expected number of rows in this crafts table. If the expected and actual number of rows are not equal, this page will be added to Category:Recipes_table_with_unexpected_total_number_of_rows.
sortable
= n/no
Makes the table unsortable.
class
=id
=css
/style
=
HTML class/id/style attributes for outer wrapper div element.
Example
{{recipes|ingredient=Bone|station=Bone Welder|resultnot=Bone Block Wall|expectedrows=18}}
This code queries all Bone furniture.
Explanation: Select all recipes that have Os as an ingredient, and Soudeuse d'os(versions Bureau, Console, Console old-gen et Mobile) as a crafting station, then exclude the result Mur en blocs d'os. There are 18 items in Bone furniture, so we assert expectedrows=18
.
Register Recipes
Recipes in database are registered by {{recipes/register}}. All recipes should be registered on the corresponding crafting station page ( Recipes/[station] ), e.g. Recipes/Sawmill. For usage of {{recipes/register}}, see its documentation.
Advanced Usage
Custom Result Cells
resulttemplate
= template name used for format result cell.
This template will receive the following arguments:
link
,showid
,noversion
: options for {{item}} template used by default display.result
,resultid
,resultimage
,resultname
,resulttext
,amount
,versionse
: infomation about crafting result.
"@@@@" in template output will be replaced with the default result display.
See Chairs#Recipes for an example.
Custom Table Header
header-result
= content of result <th>, default isResult
header-ingredients
= content of ingredients<th>, default isIngredients
header-station
= content of crafting station<th>, default is[[Crafting station]]
Adding extra columns/rows around crafting stations
Only valid when nostation
is not set.
Define cols:
station-col-before-1
station-col-before-2
station-col-before-3
...
Column headers before crafting station column
station-col-after-1
station-col-after-2
station-col-after-3
...
Column headers before crafting station column
Define index key for row content:
station-index-Furnace
= _a
Define index key for "Furnace"(as station
parameter), for example
Define actual contents:
_a-row-station-col-before-1
=_a-row-station-col-before-2
=
...
_a-row-station-col-after-1
=
...
Define contents for <td> using index key.
Adding extra cols/rows around by crafting results
Define columns:
col-A-1
col-A-2
...
col-B-1
...
col-C-1
...
col-D-1
...
The order in which all columns are displayed is:
col-A
s • Result
• col-B
s • Ingredients
• col-C
s • station-col-before
s • Crafting Station
• station-col-after
s • Col-D
s
Define index key for row content:
Define index key for a row(Priority in this order):
result-index-#3
= _a
Define by row number
result-index-Crimtane Bar-desktop console
= _a
Define by result name + version info
result-index-Copper Bar
= _a
Define by result name
Define actual contents:
_a-row-col-A-1
=
...
Define contents for <td> using index key, corresponding to the definition of columns.
Adding extra rows
NOTE: extra rows don't count as part of expectedrows
.
Before recipe rows:
topextrow-1-col-result
=topextrow-1-col-ingredients
=topextrow-1-col-station
=topextrow-1-col-ingredients
=topextrow-1-col-C-2
=
...
topextrow-2-col-result
=
...
After recipe rows:
extrow-1-col-result
=extrow-1-col-ingredients
=extrow-1-col-station
=extrow-1-col-B-1
=extrow-1-col-C-1
=
...
extrow-2-col-result
=
...
See Bars and Recovery potions for examples.
Extract component
Some components of the recipe can be extracted and formatted separately, see {{recipes/extract}}.
Count for result rows
You can use {{recipes/exist}} and {{recipes/count}} to check the existence and number of results of recipes that meet query constraints. Note: you should use {{#if:{{recipes/exist|<constraints>}}}}
to check existence instead of {{#ifeq:{{recipes/count|<constraints>}}|0}}
, because the former is much faster and cheaper.