(Manually built "produces" example to avoid category assignment by template) |
Magneto555 (talk | contribs) (Adding spanish link) |
||
(37 intermediate revisions by 11 users not shown) | |||
Line 2: | Line 2: | ||
This template is used to create a recipe box that is uniform across all items and easily searchable via DPL tables. |
This template is used to create a recipe box that is uniform across all items and easily searchable via DPL tables. |
||
ā | The recipe can have up to a maximum of |
+ | The recipe can have up to a maximum of ten items (As of A13 nothing requires more than four items). |
ā | |||
ā | Each row must have inputs for each variable. Missing variables will produce garbage in the output. |
||
Adding this recipe to an item also sets the default category for that item to [[:Category:Craftable_items]] |
Adding this recipe to an item also sets the default category for that item to [[:Category:Craftable_items]] |
||
Line 10: | Line 8: | ||
__TOC__ |
__TOC__ |
||
== Usage == |
== Usage == |
||
+ | Recipes should only be used in the page that they are tied to, i.e. The recipe for a [[Chemistry Station]] should only appear on the [[Chemistry Station]] page, it should not appear on the pages of the components eg. the [[Beaker]] page. This is because the recipe is tied to the page it is on, so dpl searches would list the Beaker as having an ingredient of [[Chemistry Station]], it will also include the [[Beaker]] as a [[:Category:Craftable_items]] which it is not. |
||
ā | === Basic usage === |
||
+ | ===Parameters=== |
||
+ | The recipe formats a borderless table with three main columns; an image column, a page link column,and a column containing the count of the required item. There are a maximum of 10 items that can be used in the recipe. Recipes should start at with the 1st version and count up to make sure that formating in other locations works correctly. The system also allows for including the workplace, the implements that are used from the workplace and if you need any special knowledge to use the recipe. The parameters are as follows: |
||
+ | |||
+ | ;image''X'' : The name of the image of the item. |
||
+ | |||
+ | ;linkname''X'' : The name of the item page (tip: use spaces instead of under-cores (_) for better formatting) |
||
+ | |||
+ | ;itemcount''X'' : The number of items required for the recipe |
||
+ | |||
+ | ;optional''X'' : If this flag exists, it specifies that the ingredient is optional, only available on 2 - 10. |
||
+ | Where '''''X''''' is between 1 and 10. |
||
+ | |||
+ | The other parameters which are all optional are: |
||
+ | ;workstation:The workplace location that the recipe must be performed.<br>'''Note:''' This has changed from workplace to match the ingame description. |
||
+ | ;workstationimage:The image of that workplace location.<br>'''Note:''' This has changed from workplaceimage to match the ingame description. |
||
+ | <!-- ;required:If the workplace is absolutely require, some recipes can be done at multiple places. --> |
||
+ | ;implement:The implement in the workplace that must be there. |
||
+ | ;implementimage:The image of that implement. |
||
+ | ;schematic:The schematic or book that must have been read to perform this recipe. |
||
+ | ;schematicimage:The image of that schematic. |
||
+ | ;skill:The skill or perk that must have been read to perform this recipe. |
||
+ | ;skillimage:The image of that skill. |
||
+ | ;skilllevel:The minimum level that must be attained to use this recipe. |
||
+ | ;time:The time for the recipe to complete. |
||
+ | ;yield:The number that is produced. |
||
+ | |||
+ | === Copy, Paste, & Delete === |
||
+ | |||
+ | You can copy and paste the following where you need it then delete the sections you don't need: |
||
+ | |||
<pre>{{Recipe |
<pre>{{Recipe |
||
|image1= | linkname1= | itemcount1= |
|image1= | linkname1= | itemcount1= |
||
Line 22: | Line 50: | ||
|image9= | linkname9= | itemcount9= |
|image9= | linkname9= | itemcount9= |
||
|image10= | linkname10= | itemcount10= |
|image10= | linkname10= | itemcount10= |
||
+ | |workstationimage= |workstation= |
||
+ | |implementimage= |implement= |
||
+ | |schematicimage= |schematic= |
||
+ | |skillimage= |skill= |skilllevel= |
||
+ | |time= |
||
+ | |yield= |
||
}}</pre> |
}}</pre> |
||
Line 27: | Line 61: | ||
<pre>{{{Recipe |
<pre>{{{Recipe |
||
|image1=Ak47Barrel.png | linkname1=Ak 47 Barrel |itemcount1=1 |
|image1=Ak47Barrel.png | linkname1=Ak 47 Barrel |itemcount1=1 |
||
ā | |image2=Ak47Receiver.png | linkname2=Ak 47 Receiver | itemcount2= |
+ | |image2=Ak47Receiver.png | linkname2=Ak 47 Receiver | itemcount2=1 |
ā | |image3=Ak47Stock.png | linkname3=Ak 47 Stock | itemcount3= |
+ | |image3=Ak47Stock.png | linkname3=Ak 47 Stock | itemcount3=1 |
ā | |image4=Ak47Parts.png | linkname4=Ak 47 Parts | itemcount4= |
+ | |image4=Ak47Parts.png | linkname4=Ak 47 Parts | itemcount4=1 |
}}</pre> |
}}</pre> |
||
;Produces: |
;Produces: |
||
+ | {{Recipe |
||
ā | {| cellspacing="0" cellpadding="2px" style="background: rgba( 255, 255, 255, .30); overflow: hidden; border: 2px solid rgba(0, 0, 0, 0.2); border-radius: 10px; border-radius: 10px; padding: 7px; margin: 0; width: ;" |
||
ā | | |
+ | |image1=Ak47Barrel.png | linkname1=Ak 47 Barrel |itemcount1=1 |
+ | |image2=Ak47Receiver.png | linkname2=Ak 47 Receiver | itemcount2=1 |
||
ā | ! scope="row" style="padding: 5px; margin: 3px; text-align: left; font-weight: bold;" |'''1x''' [[Ak 47 Barrel]] |
||
⚫ | |||
ā | |- |
||
ā | | |
+ | |image4=Ak47Parts.png | linkname4=Ak 47 Parts | itemcount4=1 |
⚫ | |||
ā | ! scope="row" style="padding: 5px; margin: 0px; text-align: left; font-weight: bold;" |'''1x''' [[Ak 47 Receiver]] |
||
ā | |- |
||
⚫ | |||
ā | ! scope="row" style="padding: 5px; margin: 3px; text-align: left; font-weight: bold;" |'''1x''' [[Ak 47 Stock]] |
||
ā | |- |
||
ā | |[[File:Ak47Parts.png|75px|link=Ak 47 Parts]] |
||
ā | ! scope="row" style="padding: 5px; margin: 3px; text-align: left; font-weight: bold;" |'''1x''' [[Ak 47 Parts]] |
||
ā | |- |
||
⚫ | |||
ā | |||
{{doc/end}} |
{{doc/end}} |
||
+ | |||
ā | <includeonly> |
||
+ | <noinclude> |
||
ā | [[Category:Image templates|{{PAGENAME}}]] |
||
+ | [[es:Template:Recipe/doc]] |
||
ā | </includeonly> |
||
+ | </noinclude> |
Revision as of 02:01, 22 February 2018
This template is used to create a recipe box that is uniform across all items and easily searchable via DPL tables.
The recipe can have up to a maximum of ten items (As of A13 nothing requires more than four items).
Adding this recipe to an item also sets the default category for that item to Category:Craftable_items
Usage[]
Recipes should only be used in the page that they are tied to, i.e. The recipe for a Chemistry Station should only appear on the Chemistry Station page, it should not appear on the pages of the components eg. the Beaker page. This is because the recipe is tied to the page it is on, so dpl searches would list the Beaker as having an ingredient of Chemistry Station, it will also include the Beaker as a Category:Craftable_items which it is not.
Parameters[]
The recipe formats a borderless table with three main columns; an image column, a page link column,and a column containing the count of the required item. There are a maximum of 10 items that can be used in the recipe. Recipes should start at with the 1st version and count up to make sure that formating in other locations works correctly. The system also allows for including the workplace, the implements that are used from the workplace and if you need any special knowledge to use the recipe. The parameters are as follows:
- imageX
- The name of the image of the item.
- linknameX
- The name of the item page (tip: use spaces instead of under-cores (_) for better formatting)
- itemcountX
- The number of items required for the recipe
- optionalX
- If this flag exists, it specifies that the ingredient is optional, only available on 2 - 10.
Where X is between 1 and 10.
The other parameters which are all optional are:
- workstation
- The workplace location that the recipe must be performed.
Note: This has changed from workplace to match the ingame description. - workstationimage
- The image of that workplace location.
Note: This has changed from workplaceimage to match the ingame description. - implement
- The implement in the workplace that must be there.
- implementimage
- The image of that implement.
- schematic
- The schematic or book that must have been read to perform this recipe.
- schematicimage
- The image of that schematic.
- skill
- The skill or perk that must have been read to perform this recipe.
- skillimage
- The image of that skill.
- skilllevel
- The minimum level that must be attained to use this recipe.
- time
- The time for the recipe to complete.
- yield
- The number that is produced.
Copy, Paste, & Delete[]
You can copy and paste the following where you need it then delete the sections you don't need:
{{Recipe |image1= | linkname1= | itemcount1= |image2= | linkname2= | itemcount2= |image3= | linkname3= | itemcount3= |image4= | linkname4= | itemcount4= |image5= | linkname5= | itemcount5= |image6= | linkname6= | itemcount6= |image7= | linkname7= | itemcount7= |image8= | linkname8= | itemcount8= |image9= | linkname9= | itemcount9= |image10= | linkname10= | itemcount10= |workstationimage= |workstation= |implementimage= |implement= |schematicimage= |schematic= |skillimage= |skill= |skilllevel= |time= |yield= }}
Example[]
{{{Recipe |image1=Ak47Barrel.png | linkname1=Ak 47 Barrel |itemcount1=1 |image2=Ak47Receiver.png | linkname2=Ak 47 Receiver | itemcount2=1 |image3=Ak47Stock.png | linkname3=Ak 47 Stock | itemcount3=1 |image4=Ak47Parts.png | linkname4=Ak 47 Parts | itemcount4=1 }}
- Produces
Item | Name | Count | |
---|---|---|---|
Ak 47 Barrel | 1 | ||
Ak 47 Receiver | 1 | ||
Ak 47 Stock | 1 | ||
Ak 47 Parts | 1 |
This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.