Difference between revisions of "Template:Equipment/Documentation"
WardPhoenix (talk | contribs) m (a "to" looks better than a "~", especially in negative number cases) |
(Remove multiple spaces from template examples for mobile usability.) |
||
Line 22: | Line 22: | ||
<pre>{{equipment | <pre>{{equipment | ||
− | | image | + | | 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 = <!-- Caption for the image, displays below the image specified above. --> |
− | | worn | + | | worn = <!-- Where it's worn. Can be: Weapon, Shield, Head, Body, Arms, Legs, Talisman. --> |
− | | durability | + | | durability = <!-- E.g., -11, +20 to +50 --> |
| description = <!-- A textual description of the equipment. --> | | description = <!-- A textual description of the equipment. --> | ||
}}</pre> | }}</pre> | ||
{{equipment | {{equipment | ||
− | | image | + | | image = Example.jpg |
− | | caption | + | | caption = Example |
− | | worn | + | | worn = Head |
− | | durability | + | | durability = +32 to +45 |
| description = A stylish cap | | description = A stylish cap | ||
}} | }} | ||
<pre>{{equipment | <pre>{{equipment | ||
− | | image | + | | image = Example.jpg |
− | | caption | + | | caption = Example |
− | | worn | + | | worn = Head |
− | | durability | + | | durability = +32 to +45 |
| description = A stylish cap | | description = A stylish cap | ||
}}</pre> | }}</pre> | ||
{{clear}} | {{clear}} | ||
<noinclude>[[Category:Templates/Documents|{{PAGENAME}}]]</noinclude> | <noinclude>[[Category:Templates/Documents|{{PAGENAME}}]]</noinclude> |
Latest revision as of 13:53, 9 November 2020
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.)
- (Note: Setting
|description=
- Optional — Brief description of the equipment.
|durability=
- Optional — The item's durability as in game. Durability may be noted as follow :
lowest durability seen to highest durability seen
.
|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/Documentation | |
---|---|
| |
Worn | 🧢Head |
Durability | +32 to +45 |
Description | A stylish cap |
{{equipment | image = Example.jpg | caption = Example | worn = Head | durability = +32 to +45 | description = A stylish cap }}