Difference between revisions of "Template:Item infobox/doc"

From Albion Online Wiki
Jump to navigation Jump to search
(Populated TemplateData to the best of my knowledge. Should make adding this template to pages more self-explanatory.)
m (fixed typo)
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{doc/start}}
 
{{doc/start}}
 
{{Item infobox
 
{{Item infobox
| name = Rough Logs
+
| item_name = Rough Logs
| image = Wood.png
 
 
| type = Wood
 
| type = Wood
| tier = I
+
| tier = 1
 
| weight = 0.2
 
| weight = 0.2
 
| value = 0
 
| value = 0
Line 10: Line 9:
 
}}
 
}}
  
==Parameters==
 
; name: Name of the item. Defaults to <code><nowiki>{{SUBPAGENAME}}</nowiki></code>.
 
; type: Type of item.
 
; tier: The tier of the item.
 
; weight: The weight of the item. The kg is automatically added.
 
; value: The value of the item.
 
; fame: The [[fame]] earned by gathering or crafting this item.
 
; description: The description of the item.
 
{{doc/end}}
 
 
<templatedata>
 
<templatedata>
 
{
 
{
 
"params": {
 
"params": {
"name": {
+
"item_name": {
 
"label": "Name",
 
"label": "Name",
"description": "The name of the item pulled from {{SUBPAGENAME}}.",
+
"description": "The name of the item.",
 
"type": "string",
 
"type": "string",
"default": "{{SUBPAGENAME}}",
+
"default": "{{PAGENAME}}",
"required": true,
+
"required": true
"autovalue": "{{SUBPAGENAME}}"
 
 
},
 
},
 
"description": {
 
"description": {
Line 39: Line 28:
 
"type": {
 
"type": {
 
"label": "Type",
 
"label": "Type",
"description": "The type of this item.",
+
"description": "The type of this item. Check 'Item type' property for a list of valid values",
 
"type": "string"
 
"type": "string"
 
},
 
},
 
"tier": {
 
"tier": {
 
"label": "Tier",
 
"label": "Tier",
"description": "The tier of the item in Roman Numerals format.",
+
"description": "The tier of the item.",
"example": "IV",
+
"example": "4",
"type": "string",
+
"type": "number",
 
"suggested": true
 
"suggested": true
 
},
 
},
Line 56: Line 45:
 
"type": "number"
 
"type": "number"
 
},
 
},
"value": {
+
"item_value": {
 
"label": "Value",
 
"label": "Value",
 
"description": "The value of a single unit of this item.",
 
"description": "The value of a single unit of this item.",
Line 62: Line 51:
 
"type": "number"
 
"type": "number"
 
},
 
},
"fame": {
+
"enchantment": {
"label": "Fame",
+
"label": "Enchantment",
"description": "The fame geneated per crafting or gathering this item.",
+
"description": "Enchantment level of the item. May be any number from 0 to 3.",
"example": "150",
+
"default": "0",
 
"type": "number"
 
"type": "number"
 +
},
 +
"unique_name": {
 +
"label": "Unique Name",
 +
"description": "Unique name of an item as the game is using it internally. This is only required if multiple items have the same translated name",
 +
"type": "string"
 +
},
 +
"quality": {
 +
"label": "Quality",
 +
"description": "Quality of an item; may be Normal, Good, Outstanding, Excellent, Masterpiece",
 +
"default": "Normal",
 +
"type": "string"
 +
},
 +
"classification": {
 +
"aliases": [
 +
"class"
 +
],
 +
"label": "Item Classification",
 +
"description": "categorization of the item. Deprecated by Shop Category",
 +
"example": "Resource",
 +
"type": "string",
 +
"suggested": true
 +
},
 +
"shop_category": {
 +
"aliases": [
 +
"category"
 +
],
 +
"label": "Shop Category",
 +
"description": "categorization of the item in shop",
 +
"example": "Resource",
 +
"type": "string",
 +
"suggested": true
 +
},
 +
"shop_sub_category": {
 +
"aliases": [
 +
"subcategory"
 +
],
 +
"label": "Shop Subcategory",
 +
"description": "categorization of the item by sub category",
 +
"example": "Stone Block",
 +
"type": "string",
 +
"suggested": true
 
}
 
}
 
},
 
},
Line 72: Line 102:
 
}
 
}
 
</templatedata>
 
</templatedata>
 +
{{doc/end}}

Revision as of 18:55, 15 January 2021

Documentation

Rough Logs

Description
Common, low-quality Wood, used for crafting. It is too weak to be refined.
Type
Wood
Tier
1
Weight
0.2 kg

A template that adds a side element with the item's picture, name, description, type, tier, weight, value, and fame.

Template parameters

ParameterDescriptionTypeStatus
Nameitem_name

The name of the item.

Default
{{PAGENAME}}
Stringrequired
Item Descriptiondescription

The item description as it appears within the game.

Example
Common low-quality stone used for crafting. It is too weak to be refined.
Stringsuggested
Typetype

The type of this item. Check 'Item type' property for a list of valid values

Stringoptional
Tiertier

The tier of the item.

Example
4
Numbersuggested
Weightweight

The weight of a single unit of this item. The kg suffix is added automatically.

Example
1.0
Numbersuggested
Valueitem_value

The value of a single unit of this item.

Example
0
Numberoptional
Enchantmentenchantment

Enchantment level of the item. May be any number from 0 to 3.

Default
0
Numberoptional
Unique Nameunique_name

Unique name of an item as the game is using it internally. This is only required if multiple items have the same translated name

Stringoptional
Qualityquality

Quality of an item; may be Normal, Good, Outstanding, Excellent, Masterpiece

Default
Normal
Stringoptional
Item Classificationclassification class

categorization of the item. Deprecated by Shop Category

Example
Resource
Stringsuggested
Shop Categoryshop_category category

categorization of the item in shop

Example
Resource
Stringsuggested
Shop Subcategoryshop_sub_category subcategory

categorization of the item by sub category

Example
Stone Block
Stringsuggested

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.