Difference between revisions of "Template:Equipment/Documentation"

From GodWiki
Jump to: navigation, search
(documenting top parameter)
m
 
Line 11: Line 11:
 
; {{para|description}} : ''Optional'' — Brief description of the equipment.
 
; {{para|description}} : ''Optional'' — Brief description of the equipment.
  
; {{para|durability}} : ''Optional'' — The item's durability.
+
; {{para|durability}} : ''Optional'' — The item's durability as in game (example : +42)
  
 
; {{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|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.

Latest revision as of 11:13, 24 December 2019

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

|image=filename 
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 {{picture}} hatnote before the infobox. Disable this if necessary with |ignore-no-image=yes (see below).
|caption=Image description 
Optional — Use only if |image= is also set. Text of a descriptive caption to display beneath the image.
|worn=Weapon,Shield,Head,Body,Arms,Legs,Talisman 
Required — Where this equipment is worn/used. (default: Unknown. Alternate name: |type=.)
(Note: Setting |worn= will auto-categorize the article into the appropriate equipment sub-category.)
|description= 
Optional — Brief description of the equipment.
|durability= 
Optional — The item's durability as in game (example : +42)
|ignore-no-image=yes 
Optional — Set to yes (or any similar positive-state value) to disable the automatic placement of {{Picture}} above the infobox.
|top=no 
Optional — Set to no to disable the automatic placement of the {{Top}} template on the article.

Example of Use

Quick blank template:

{{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. -->
}}
Equipment of Godville
Equipment/Documentation
Example.jpg
Example
Worn 🧢Head
Durability +32
Description A stylish cap
{{equipment
| image       = Example.jpg
| caption     = Example
| worn        = Head
| durability  = +32
| description = A stylish cap
}}