Template:Item/doc: Difference between revisions

From Path of Exile Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
<includeonly>{{list subpages}}</includeonly>
==Usage==
{{tlx|Item}} is used on item pages to show the item's infobox. This setup also allows an item pages' data to be transcluded on other pages and formatted in various ways such as in a table.


This can be used in item pages to display any unique or normal item. Simply copy and paste on of the below examples then edit the data to match.
===Parameters===
All parameters except for <code>Name</code> are optional. They can be excluded or left blank.


==Parameter Details==
; <code>Name</code> : The name of the item
; <code>PageName</code> : The name of the item's wiki page, if different than <code>Name</code>.
; <code>Image</code> : File name of the item graphic.
; <code>Rarity</code> : The infobox frame to use. Possible values are: <code>Normal</code>, <code>Magic</code>, <code>Rare</code>, <code>Unique</code>, <code>Currency</code>, <code>Quest</code>, and <code>Gem</code>. Defaults to <code>Normal</code>.
; <code>Type</code> : The item's type, for formatting purposes. Possible values are: <code>Weapon</code>, <code>Armour</code>, <code>Accessory</code>, <code>Map</code>, and <code>Currency</code>.
; <code>Subtype</code> : The item's sub-type. Possible values are, but not limited to: <code>Axe</code>, <code>Staff</code>, <code>Gloves</code>, <code>Body Armour</code>, and <code>Ring</code>.
; <code>BaseItem</code> : The base item name, for rares and uniques.
; <code>RequiredLevel</code> : The item's level requirement.
; <code>RequiredStrength</code> : The item's strength requirement.
; <code>RequiredDexterity</code> : The item's dexterity requirement.
; <code>RequiredIntelligence</code> : The item's intelligence requirement.
; <code>PhysicalDamage</code> : The weapon's physical damage.
; <code>CriticalStrikeChance</code> : The weapon's critical strike chance.
; <code>AttacksperSecond</code> : The weapon's attacks per second.
; <code>ElementalDamage</code> : The weapon's elemental damage.
; <code>Armour</code> : The armour's armour value.
; <code>Evasion</code> : The armour's evasion rating.
; <code>EnergyShield</code> : The armour's energy shield value.
; <code>Block</code> : The shield's block chance.
; <code>MapLevel</code> : The map's level.
; <code>ItemQuantity</code> : The map's item quantity value modifier.
; <code>StackSize</code> : The currency item's maximum stack size.
; <code>ImplicitMods</code> : The item's implicit mods. Separate each mod with a colon (:).
; <code>RandomMods</code> : The item's random mods. Separate each mod with a colon (:).
; <code>Cosmetic</code> : The item's cosmetic mods. Separate each mod with a colon (:).
; <code>FlavourText</code> : The item's flavour text. Line breaks must be manually distinguished with a colon (:).
; <code>HelpText</code> : The item's help text. Line breaks must be manually distinguished with a colon (:).


Most parameters are self explanatory or can be understood by looking at the examples. The more troublesome parameters are listed here.


;PageName
====Ranges====
:Completly optional. You only need to use it if the page name and item name are different.
;Type
:Item Type or Slot. For example Belt, Amulet, Weapon, Chest Armour, Helmet, etc.
;WeaponType
:Required if the Type is a Weapon. For example One Handed Sword, Wand, etc.
 
===Ranges===
Ranges occur in weapon damage, implicit mods, random mods and item stats that are effected by mods with ranges.
Ranges occur in weapon damage, implicit mods, random mods and item stats that are effected by mods with ranges.


Line 26: Line 46:
: As above however replace each side of the hyphen with '''(min-max)''' and wrap physical values in <nowiki>{{mod}}</nowiki>. For example: '''<nowiki>{{mod|(10-15)-(20-30)}}</nowiki>'''
: As above however replace each side of the hyphen with '''(min-max)''' and wrap physical values in <nowiki>{{mod}}</nowiki>. For example: '''<nowiki>{{mod|(10-15)-(20-30)}}</nowiki>'''


==Example Usage==
===Templates===
Copy and paste a code template to get started.


=== Chest Armour ===
====Weapon====
  <nowiki>
<!-- Please do not add anything above this
-->{{Item | View={{{View|}}} | Format={{{Format|}}}
| Name                  = Driftwood Wand
| PageName              =
| Image                  = DriftwoodWand.png
| Rarity                = Normal
| Type                  = Weapon
| Subtype                = Wand
| RequiredLevel          =
| RequiredStrength      =
| RequiredDexterity      =
| RequiredInteligence    =
| PhysicalDamage        = 4-7
| CriticalStrikeChance  = 8%
| AttacksperSecond      = 1.3
| ImplicitMods          = (8-12)% increased Spell Damage
}}<noinclude><!--
Additional page content should be placed below this line -->


  <nowiki>
<!-- Please do not add anything above this
-->{{Item | View={{{View|}}}
|Name                  = Voll's Protector
|PageName              = Voll's Protector
|Image                  = VollsProtector.png
<!-- Basic Info -->
|Rarity                = Unique
|Type                  = Chest Armour
|BaseItem              = Holy Chainmail
<!-- Use Requirements -->
|RequiredLevel          = 35
|RequiredInteligence    = 53
|RequiredDexterity      =
|RequiredStrength      = 53
<!-- Armour Stats -->
|Armour                = {{mod|221}}
|Evasion                =
|EnergyShield          = {{mod|66}}
<!-- Mods and Flavour Text -->
|ImplicitMods          =
|RandomMods            = 60% Increased Armour and Energy Shield : 50% Reduced Maximum Mana : Gain a Power Charge on Critical Strike
|FlavourText            = Although a great leader during the war, : Voll proved disastrous in times of peace.
<!-- Additional Important Notes -->
|Notes                  =
*Introduced to the game in [[Version 0.9.3h]].
}}<noinclude>
<!-- Place here anything that should not be included in non-default views of this info. For example, Builds, Additional Artwork, Version History, etc.-->


==Builds==
*[http://www.youtube.com/watch?v=_aP9O0Vnt0c Path of Exile - Build of the Week #2]
*[http://www.youtube.com/watch?v=MSc6wTmFOlY Path of Exile - Build of the Week #15]


{{Navbox Unique Items}}
[[Category:Wands]]
[[Category:Unique Items]]
[[Category:Unique Armour]]
[[Category:Armour]]
</noinclude><!-- Please do not add anything below this -->
</noinclude><!-- Please do not add anything below this -->
   </nowiki>
   </nowiki>


=== Belt ===
====Armour====
 
   <nowiki>
   <nowiki>
<!-- Please do not add anything above this
<!-- Please do not add anything above this
-->{{Item | View={{{View|}}}
-->{{Item | View={{{View|}}} | Format={{{Format|}}}
|Name                  = Wurm's Molt
| Name                  = Scholar's Robe
|PageName              = Wurm's Molt
| PageName              =  
|Image                  = WurmsMolt.png
| Image                  = ScholarsRobe.png
<!-- Basic Info -->
| Rarity                = Normal
|Rarity                = Unique
| Type                  = Armour
|Type                  = Belt
| Subtype                = Body Armour
|BaseItem              = Leather Belt
| RequiredLevel          = 18
<!-- Use Requirements -->
| RequiredStrength      =  
|RequiredLevel          = 8
| RequiredDexterity      =  
|RequiredInteligence    =
| RequiredIntelligence  = 55
|RequiredDexterity      =
| Armour                =  
|RequiredStrength      =
| Evasion                =  
<!-- Mods and Flavour Text -->
| EnergyShield          = 41
|ImplicitMods          = +(25–40) to Maximum Life
| ImplicitMods          =  
|RandomMods            = +(20–30) to Strength : +(20–30) to Intelligence : (1–2)% of Physical Attack Damage Leeched back as Life : (1–2)% of Physical Attack Damage Leeched back as Mana : +(15–25)% to Cold Resistance
}}<noinclude><!--  
|FlavourText            = They say a lifetime of wisdom is carried : in every skin the great beasts shed.
Additional page content should be placed below this line -->
<!-- Additional Important Notes -->
 
|Notes                  =  
}}<noinclude>
<!-- Place here anything that should not be included in non-default views of this info. For example, Builds, Additional Artwork, Version History, etc.-->


{{Navbox Unique Items}}
 
[[Category:Body armours]]
</noinclude><!-- Please do not add anything below this -->
</noinclude><!-- Please do not add anything below this -->
   </nowiki>
   </nowiki>


=== Weapon ===
====Unique Amulet====
 
   <nowiki>
   <nowiki>
<!-- Please do not add anything above this
<!-- Please do not add anything above this
-->{{Item | View={{{View|}}}
-->{{Item | View={{{View|}}} | Format={{{Format|}}}
|Name                  = Tipua Kaikohuru
| Name                  = Araku Tiki
|PageName              = Tipua Kaikohuru
| PageName              =  
|Image                  = TipuaKaikohuru.png
| Image                  = ArakuTiki.png
<!-- Basic Info -->
| Rarity                = Unique
|Rarity                = Unique
| Type                  = Accessory
|Type                  = Weapon
| Subtype                = Amulet
|WeaponType            = One Handed Sword
| RequiredLevel          = 18
|BaseItem              = Whalebone Rapier
| ImplicitMods          = (2.0-4.0) Life Regenerated per second
<!-- Use Requirements -->
| RandomMods            = You gain 100 Evasion Rating when on Low Life : +(30-50) to maximum Life : +(20-30)% to Fire Resistance : 1.0% of Life Regenerated per Second while on Low Life
|RequiredLevel          = 7
| FlavourText            = It is said to make you invisible when the Great : Spirit comes to take you on your final journey.
|RequiredInteligence    =
}}<noinclude><!--  
|RequiredDexterity      = 32
Additional page content should be placed below this line -->
|RequiredStrength      =
 
<!-- Weapon Stats -->
 
|PhysicalDamage        = {{mod|12-56}}
 
|CriticalStrikeChance  = 5%
|AttacksperSecond      = {{mod|1.86}}
|ElementalDamage        = {{Fire|4-8}}
<!-- Mods and Flavour Text -->
|ImplicitMods          = 20% Increased Global Critical Strike Multiplier
|RandomMods            = +1 to Level of Melee Gems in this Item : Uses Both Hand Slots : (250-300)% Increased Physical Damage : Adds (3-4)-(7-8) Fire Damage : 20% Increased Attack Speed : 30% Increased Global Critical Strike Chance : +(30-40) to Evasion Rating : 20% Reduced Rarity of Items Found : 30% Increased Movement Speed when on Low Life
|FlavourText            = She paints her offer in wicked hues : An off-white Grin, an elegant bruise. : To the nascent scourge she sings the ruse : With me in hand, what else need you use?
<!-- Additional Important Notes -->
|Notes                  =
*Introduced to the game in [[Version 0.9.10]].
*Created by Diamond Supporter [http://www.pathofexile.com/account/view-profile/Charan Charan].
*The first, and so far only, one handed weapon to use both hand slots.
}}<noinclude>
<!-- Place here anything that should not be included in non-default views of this info. For example, Builds, Additional Artwork, Version History, etc.-->
{{Navbox Unique Items}}
{{Navbox Unique Items}}
[[Category:Unique Items]]
 
[[Category:Unique Swords]]
[[Category:Unique amulets]]
[[Category:Swords]]
</noinclude><!-- Please do not add anything below this -->
</noinclude><!-- Please do not add anything below this -->
   </nowiki>
   </nowiki>


<includeonly>
<includeonly>
{{list subpages}}
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Item templates]]
[[Category:Item templates]]
</includeonly>
</includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>
<noinclude>[[Category:Template documentation]]</noinclude>

Revision as of 00:06, 3 April 2013

Usage

{{Item}} is used on item pages to show the item's infobox. This setup also allows an item pages' data to be transcluded on other pages and formatted in various ways such as in a table.

Parameters

All parameters except for Name are optional. They can be excluded or left blank.

Name
The name of the item
PageName
The name of the item's wiki page, if different than Name.
Image
File name of the item graphic.
Rarity
The infobox frame to use. Possible values are: Normal, Magic, Rare, Unique, Currency, Quest, and Gem. Defaults to Normal.
Type
The item's type, for formatting purposes. Possible values are: Weapon, Armour, Accessory, Map, and Currency.
Subtype
The item's sub-type. Possible values are, but not limited to: Axe, Staff, Gloves, Body Armour, and Ring.
BaseItem
The base item name, for rares and uniques.
RequiredLevel
The item's level requirement.
RequiredStrength
The item's strength requirement.
RequiredDexterity
The item's dexterity requirement.
RequiredIntelligence
The item's intelligence requirement.
PhysicalDamage
The weapon's physical damage.
CriticalStrikeChance
The weapon's critical strike chance.
AttacksperSecond
The weapon's attacks per second.
ElementalDamage
The weapon's elemental damage.
Armour
The armour's armour value.
Evasion
The armour's evasion rating.
EnergyShield
The armour's energy shield value.
Block
The shield's block chance.
MapLevel
The map's level.
ItemQuantity
The map's item quantity value modifier.
StackSize
The currency item's maximum stack size.
ImplicitMods
The item's implicit mods. Separate each mod with a colon (:).
RandomMods
The item's random mods. Separate each mod with a colon (:).
Cosmetic
The item's cosmetic mods. Separate each mod with a colon (:).
FlavourText
The item's flavour text. Line breaks must be manually distinguished with a colon (:).
HelpText
The item's help text. Line breaks must be manually distinguished with a colon (:).


Ranges

Ranges occur in weapon damage, implicit mods, random mods and item stats that are effected by mods with ranges.

When using the Item template with ranges please follow these guidelines.

Ranged Implicit and Random Mods
Wrap the range with parenthesis and separate with a hyphen. For example: (50-80)% Increased Armour
Ranged Physical and Elemental Damages
Separate the min and max with a hyphen. For example: 235-368
Ranged Modded Damages
As above however replace each side of the hyphen with (min-max) and wrap physical values in {{mod}}. For example: {{mod|(10-15)-(20-30)}}

Templates

Copy and paste a code template to get started.

Weapon

 
<!-- Please do not add anything above this 
-->{{Item | View={{{View|}}} | Format={{{Format|}}}
| Name                   = Driftwood Wand
| PageName               = 
| Image                  = DriftwoodWand.png
| Rarity                 = Normal
| Type                   = Weapon
| Subtype                = Wand
| RequiredLevel          = 
| RequiredStrength       = 
| RequiredDexterity      = 
| RequiredInteligence    = 
| PhysicalDamage         = 4-7
| CriticalStrikeChance   = 8%
| AttacksperSecond       = 1.3
| ImplicitMods           = (8-12)% increased Spell Damage
}}<noinclude><!-- 
Additional page content should be placed below this line -->



[[Category:Wands]]
</noinclude><!-- Please do not add anything below this -->

Armour

 
<!-- Please do not add anything above this
-->{{Item | View={{{View|}}} | Format={{{Format|}}}
| Name                   = Scholar's Robe
| PageName               = 
| Image                  = ScholarsRobe.png
| Rarity                 = Normal
| Type                   = Armour
| Subtype                = Body Armour
| RequiredLevel          = 18
| RequiredStrength       = 
| RequiredDexterity      = 
| RequiredIntelligence   = 55
| Armour                 = 
| Evasion                = 
| EnergyShield           = 41
| ImplicitMods           = 
}}<noinclude><!-- 
Additional page content should be placed below this line -->



[[Category:Body armours]]
</noinclude><!-- Please do not add anything below this -->

Unique Amulet

 
<!-- Please do not add anything above this
-->{{Item | View={{{View|}}} | Format={{{Format|}}}
| Name                   = Araku Tiki
| PageName               = 
| Image                  = ArakuTiki.png
| Rarity                 = Unique
| Type                   = Accessory
| Subtype                = Amulet
| RequiredLevel          = 18
| ImplicitMods           = (2.0-4.0) Life Regenerated per second
| RandomMods             = You gain 100 Evasion Rating when on Low Life : +(30-50) to maximum Life : +(20-30)% to Fire Resistance : 1.0% of Life Regenerated per Second while on Low Life
| FlavourText            = It is said to make you invisible when the Great : Spirit comes to take you on your final journey.
}}<noinclude><!-- 
Additional page content should be placed below this line -->



{{Navbox Unique Items}}

[[Category:Unique amulets]]
</noinclude><!-- Please do not add anything below this -->
Retrieved from "https://www.poewiki.net/index.php?title=Template:Item/doc&oldid=893544"