Difference between revisions of "Template:ItemCategory/doc"

From Project: Gorgon Wiki
Jump to: navigation, search
(documentation written)
m (Syntax)
Line 11: Line 11:
  
 
== Syntax ==
 
== Syntax ==
<pre>{{ItemCategory | <Item Category Keyword> | <Display Text> }}</pre>
+
<pre>{{ItemCategory | <Item Category Keyword> | <Display Text>}}</pre>
  
 
=== Parameters ===
 
=== Parameters ===
Line 17: Line 17:
  
 
Second parameter (optional): The link text you wish to be displayed.  If omitted this is selected automatically via a lookup table.  It will be the plural form of the Item Category, in plain english, in most cases.
 
Second parameter (optional): The link text you wish to be displayed.  If omitted this is selected automatically via a lookup table.  It will be the plural form of the Item Category, in plain english, in most cases.
 +
 
== Examples ==
 
== Examples ==
 
{| class="wikitable"
 
{| class="wikitable"

Revision as of 15:57, 31 August 2020


Description

Used for those of us who have trouble remembering the correct syntax to link to a category page, or to save a little typing by using a default display link text provided by a lookup table.

Syntax

{{ItemCategory | <Item Category Keyword> | <Display Text>}}

Parameters

First parameter (required): The Keyword for the Item Category, as found in items.json in the public data.

Second parameter (optional): The link text you wish to be displayed. If omitted this is selected automatically via a lookup table. It will be the plural form of the Item Category, in plain english, in most cases.

Examples

Code Result
{{ItemCategory|MagicOil}}
Magic Oil
{{ItemCategory|MagicOil|Oils which have magical properties}}
Oils which have magical properties
{{ItemCategory|Armor}}
Pieces of Armor
{{ItemCategory|Apple}}
Apples