View source for Template:Equipment/Documentation

As well as automatically categorizing an article into [[:Category:Equipment]], this template supplies some standard information about the subject of the article. For details on how to create an equipment article, refers to the [[Creators Manual]] and the [[Guideline: Equipment Articles]].

==Parameters==
; {{para|image|<var>filename</var>}} : ''Optional but preferred'' — The full image file name.
: If an image is not supplied, a placeholder will be used, and by default the template will place the {{tlx|picture}} hatnote before the infobox. Disable this if necessary with {{para|ignore-no-image|yes}} ''(see below)''.
:;{{para|caption|<var>Image description</var>}} : ''Optional'' — Use only if {{para|image}} is also set. Text of a descriptive caption to display beneath the image.

;{{para|worn|<var>Weapon,Shield,Head,Body,Arms,Legs,Talisman</var>}} : ''Required'' — Where this equipment is worn/used. (default: ''Unknown''. Alternate name: {{para|type}}.)
:: ''('''Note:''' Setting {{para|worn}} will auto-categorize the article into the appropriate equipment sub-category.)''

; {{para|description}} : ''Optional'' — Brief description of the equipment.

; {{para|durability}} : ''Optional'' — The item's durability as in game. Durability may be noted as follow : <code>lowest durability seen to highest durability seen</code>.

; {{para|ignore-no-image|<var>yes</var>}} : ''Optional'' — Set to <code>yes</code> (or any similar positive-state value) to disable the automatic placement of {{tlx|Picture}} above the infobox.

; {{para|top|<var>no</var>}} : ''Optional'' — Set to <code>no</code> to disable the automatic placement of the {{tlx|Top}} template on the article.

==Example of Use==

Quick blank template:

<pre>{{equipment
| image = <!-- An image filename (e.g. Example_picture_name.jpg). If the filename doesn't exist, this gives you a link to upload it. -->
| caption = <!-- Caption for the image, displays below the image specified above. -->
| worn = <!-- Where it's worn. Can be: Weapon, Shield, Head, Body, Arms, Legs, Talisman. -->
| durability = <!-- E.g., -11, +20 to +50 -->
| description = <!-- A textual description of the equipment. -->
}}</pre>
{{equipment
| image = Example.jpg
| caption = Example
| worn = Head
| durability = +32 to +45
| description = A stylish cap
}}
<pre>{{equipment
| image = Example.jpg
| caption = Example
| worn = Head
| durability = +32 to +45
| description = A stylish cap
}}</pre>
{{clear}}
<noinclude>[[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>