Difference between revisions of "Template:Recipe/doc"
From SpiralKnights
m (remaking - the template is being used to link recipes to recipe page and the relevant item page) |
m (added {{documentation subpage}}) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | ==Usage== | + | <noinclude>{{documentation subpage}}</noinclude>==Usage== |
To display a [[recipe]] and link to the item that recipe is for. The template also links to the recipe page via the icon. | To display a [[recipe]] and link to the item that recipe is for. The template also links to the recipe page via the icon. | ||
| Line 8: | Line 8: | ||
==Parameters== | ==Parameters== | ||
| + | ===Required=== | ||
|1 | |1 | ||
| − | :The item's name | + | :The item's name (not item name recipe, just item name. Use capitals etc - the item's true name) |
|2 | |2 | ||
:The item's type. Types include: | :The item's type. Types include: | ||
| − | * | + | *armor |
| − | * | + | *helmet |
| − | * | + | *shield |
| − | * | + | *bomb |
| − | * | + | *handgun |
| − | * | + | *sword |
| − | * | + | *rarity (fire crystals) |
Other recipes built in to certain alchemy machines do not have item recipe icons. | Other recipes built in to certain alchemy machines do not have item recipe icons. | ||
| + | |||
| + | Please use lowercase. | ||
| + | |||
| + | ===Optional=== | ||
| + | |star | ||
| + | :0,1,2,3,4, or 5. Shows the star level in parenthesis, uses [[:Template:Star]]. | ||
==Notes== | ==Notes== | ||
We could have the recipe icon change to the appropriate item type via a switch containing all items, but that seems silly to maintain when we can just have a type field. | We could have the recipe icon change to the appropriate item type via a switch containing all items, but that seems silly to maintain when we can just have a type field. | ||
Latest revision as of 08:02, 25 September 2015
 |
This is a documentation subpage for Template:Recipe (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
To display a recipe and link to the item that recipe is for. The template also links to the recipe page via the icon.
Contents
Code
{{recipe|ITEMNAME|TYPE}}
Parameters
Required
|1
- The item's name (not item name recipe, just item name. Use capitals etc - the item's true name)
|2
- The item's type. Types include:
- armor
- helmet
- shield
- bomb
- handgun
- sword
- rarity (fire crystals)
Other recipes built in to certain alchemy machines do not have item recipe icons.
Please use lowercase.
Optional
|star
- 0,1,2,3,4, or 5. Shows the star level in parenthesis, uses Template:Star.
Notes
We could have the recipe icon change to the appropriate item type via a switch containing all items, but that seems silly to maintain when we can just have a type field.
