Difference between revisions of "Template:Recipe/doc"

From Project: Gorgon Wiki
Jump to: navigation, search
m (added optional second parameter)
Line 13: Line 13:
  
 
== Syntax ==
 
== Syntax ==
<pre>{{Recipe|recipeName}}</pre>
+
*<pre>{{Recipe|recipeName}}</pre>
 
+
*or, to omit the leading scroll icon and "Recipe:" text: <pre>{{Recipe|recipeName|noscroll}}</pre>
 
===Parameters===
 
===Parameters===
*First (only) parameter (required): The exact name of the recipe.
+
*First parameter (required): The exact name of the recipe.
 +
*Second parameter (optional): If this parameter is present (can be any non-empty string), the leading scroll icon and "Recipe:" text are omitted.
  
 
== Example ==
 
== Example ==
===Example Code ===
+
===Example 1 Code ===
 
<pre>{{Recipe|Whisky (Drinkable Cask)}}</pre>
 
<pre>{{Recipe|Whisky (Drinkable Cask)}}</pre>
===Example Output ===
+
===Example 1 Output ===
 
{{Recipe|Whisky (Drinkable Cask)}}
 
{{Recipe|Whisky (Drinkable Cask)}}
 +
===Example 2 Code ===
 +
<pre>{{Recipe|Whisky (Drinkable Cask)|x}}</pre>
 +
===Example 2 Output ===
 +
{{Recipe|Whisky (Drinkable Cask)|x}}
  
 
== Note ==
 
== Note ==
 
An old version of this template was partially implemented at one time, attempting to redirect users to recipe pages as found in [[:Category:Recipes]]. However only a small fraction of these individual recipe pages were ever created, and that project was abandoned.
 
An old version of this template was partially implemented at one time, attempting to redirect users to recipe pages as found in [[:Category:Recipes]]. However only a small fraction of these individual recipe pages were ever created, and that project was abandoned.

Revision as of 14:48, 18 December 2020


Description

Takes the name of a recipe. as found in-game in the crafting menu or an NPC's training menu, or in the "Name" field in recipes.json (at http://cdn.projectgorgon.com) and outputs a link and sometimes an icon:

  • If the recipe produces an item, the template outputs that icon's icon and a link to the item page. Uses Template:RecipeToItem.
  • Otherwise the template outputs no icon and a link to a relevant page, usually the page of the skill-line, with a few exceptions (for example the apply augment recipes link to Augmentation instead of Lore).

Syntax

  • {{Recipe|recipeName}}
  • or, to omit the leading scroll icon and "Recipe:" text:
    {{Recipe|recipeName|noscroll}}

Parameters

  • First parameter (required): The exact name of the recipe.
  • Second parameter (optional): If this parameter is present (can be any non-empty string), the leading scroll icon and "Recipe:" text are omitted.

Example

Example 1 Code

{{Recipe|Whisky (Drinkable Cask)}}

Example 1 Output

Error: Item not foundRecipe: icon_5722.png Whisky (Drinkable Cask)

Example 2 Code

{{Recipe|Whisky (Drinkable Cask)|x}}

Example 2 Output

icon_5722.png Whisky (Drinkable Cask)

Note

An old version of this template was partially implemented at one time, attempting to redirect users to recipe pages as found in Category:Recipes. However only a small fraction of these individual recipe pages were ever created, and that project was abandoned.