Template:Recipe/doc: Difference between revisions

From Subnautica Wiki
(Changed Airsack to Bladderfish icon)
Tag: sourceedit
(Updated documentation for auto categorization)
Line 3: Line 3:
;Usage
;Usage


*Full syntax: <code><nowiki>{{Recipe|item1=|count1=|item2=|count2=|item3=|count3=|item4=|count4=|item5=|count5=|item6=|count6=|item7=|count7=|item8=|count8=|machine=|result1=|resultcount1=|result2=|resultcount2=|result3=|resultcount3=}}</nowiki></code>
*Full syntax: <code><nowiki>{{Recipe|Main=|item1=|count1=|item2=|count2=|item3=|count3=|item4=|count4=|item5=|count5=|item6=|count6=|item7=|count7=|item8=|count8=|machine=|result1=|resultcount1=|result2=|resultcount2=|result3=|resultcount3=}}</nowiki></code>




Line 9: Line 9:
:<code><nowiki>{{Recipe|item=Bladderfish|machine=Fabricator|result=Filtered Water}}</nowiki></code>
:<code><nowiki>{{Recipe|item=Bladderfish|machine=Fabricator|result=Filtered Water}}</nowiki></code>
{{Recipe|item=Bladderfish|machine=Fabricator|result=Filtered Water}}
{{Recipe|item=Bladderfish|machine=Fabricator|result=Filtered Water}}


*If the recipe is for how to craft the topic of the article (e.g., the recipe for Bladderfish on the Bladderfish page), add <code>Main=</code> to the recipe code:
:<code><nowiki>{{Recipe|item=Bladderfish|machine=Fabricator|result=Filtered Water}}</nowiki></code> would not add the <code>Crafted with Bladderfish</code> or <code>Crafted with Fabricator</code> categories; however,
:<code><nowiki>{{Recipe|Main=|item=Bladderfish|machine=Fabricator|result=Filtered Water}}</nowiki></code> would add the categories.





Revision as of 22:43, 9 October 2017

Overview

This template is used to make an organized, standardized recipe layout with automatic links/icons. Full in-game item names should be used, as this will select the corresponding article and image. The "item" text is corresponds to the ingredients, the "machine" text corresponds to the method of crafting, and the "result" text corresponds to the products. While the typical order is "item", "machine, then "result" any order will work as long as there is proper separation. This is also true for the "count" text. The "item=" and "item1=" texts are interchangeable and the same goes for "result1" and "count1". If no count is provided for an item or result then a single count is assumed. Therefor "count=1" is unnecessary but will still work.

Usage
  • Full syntax: {{Recipe|Main=|item1=|count1=|item2=|count2=|item3=|count3=|item4=|count4=|item5=|count5=|item6=|count6=|item7=|count7=|item8=|count8=|machine=|result1=|resultcount1=|result2=|resultcount2=|result3=|resultcount3=}}


  • Basic usage is as follows:
{{Recipe|item=Bladderfish|machine=Fabricator|result=Filtered Water}}
Bladderfish.pngItem Arrow.pngFabricator.pngItem Arrow.pngFiltered Water.png


  • If the recipe is for how to craft the topic of the article (e.g., the recipe for Bladderfish on the Bladderfish page), add Main= to the recipe code:
{{Recipe|item=Bladderfish|machine=Fabricator|result=Filtered Water}} would not add the Crafted with Bladderfish or Crafted with Fabricator categories; however,
{{Recipe|Main=|item=Bladderfish|machine=Fabricator|result=Filtered Water}} would add the categories.


  • Typically, more than 1 of an item is needed:
{{Recipe|item=Salt Deposit|count=3|machine=Fabricator|result=Magnesium}}
Salt Deposit.pngSalt Deposit.pngSalt Deposit.pngItem Arrow.pngFabricator.pngItem Arrow.pngMagnesium.png


  • Multiple results of the same item are possible, too:
{{Recipe|item=Metal Salvage|machine=Fabricator|result=Titanium|resultcount=2}}
Metal Salvage.pngItem Arrow.pngFabricator.pngItem Arrow.pngTitanium.pngTitanium.png


  • This will also show a multiplier if a lot of an item is needed:
{{Recipe|item=Titanium|count=10|machine=Fabricator|result=Titanium Ingot}}
Titanium.png×10Item Arrow.pngFabricator.pngItem Arrow.pngTitanium Ingot.png


  • Most recipes need several different items:
{{Recipe|item1=Plasteel Ingot|count1=5|item2=Enameled Glass|count2=5|item3=Advanced Wiring Kit|machine=Mobile Vehicle Bay|result=Cyclops}}
Plasteel Ingot.png×5Enameled Glass.png×5Advanced Wiring Kit.pngItem Arrow.pngMobile Vehicle Bay.pngItem Arrow.pngCyclops.png


  • While it hasn't been utilized on the wiki there is a small syntax:
{{Recipe|item1=Salt Deposit|item2=Spadefish|machine=Fabricator|result=Cooked Spadefish|small=yes}}
Salt Deposit.pngSpadefish.pngItem Arrow.pngFabricator.pngItem Arrow.pngCooked Spadefish.png


  • If the recipe is known but cannot be used in the game the "machine" is set to "stop":
{{Recipe|item = Titanium|count=2|item2 = Wiring Kit|item3=Computer Chip|item4=Workbench Blueprint|machine=stop|result = Modification Station}}
Titanium.pngTitanium.pngWiring Kit.pngComputer Chip.pngWorkbench Blueprint.pngItem Arrow.pngStop.pngItem Arrow.pngModification Station.png


Lastly, credit where credit is due: Big thanks to the Don't Starve Wikia for the base code. It has been modified to (hopefully) be more resilient.