Difference between revisions of "Template:Artifact/Documentation"
m (Fixed typo) |
(Correct docs for |type= defaulting) |
||
Line 6: | Line 6: | ||
: 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)''. | : 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|type|<var>Normal,Bold,Healing,Activatable</var>}} : '' | + | ; {{para|type|<var>Normal,Bold,Healing,Activatable</var>}} : '''''Required''''' — The type of the item. (Default: ''Unknown'') |
:: ''('''Note''': Setting {{para|type}} to <code>Bold</code>, <code>Healing</code>, or <code>Activatable</code> will also categorize the article into the [[:Category:Bold Artifacts|Bold Artifacts]], [[:Category:Healing Artifacts|Healing Artifacts]], or [[:Category:Activatable Artifacts|Activatable Artifacts]] category, respectively.)'' | :: ''('''Note''': Setting {{para|type}} to <code>Bold</code>, <code>Healing</code>, or <code>Activatable</code> will also categorize the article into the [[:Category:Bold Artifacts|Bold Artifacts]], [[:Category:Healing Artifacts|Healing Artifacts]], or [[:Category:Activatable Artifacts|Activatable Artifacts]] category, respectively.)'' | ||
− | ;{{para|description}} : ''Required'' — A brief description of the item. ( | + | ;{{para|description}} : '''''Required''''' — A brief description of the item. (Default: ''Unknown'') |
;{{para|value}} : ''Optional'' — The average amount in gold coins this item can be sold for. | ;{{para|value}} : ''Optional'' — The average amount in gold coins this item can be sold for. |
Revision as of 21:34, 30 December 2018
As well as automatically categorizing an article into Category:Artifacts, this template supplies some standard information about the subject of the article.
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).
|type=Normal,Bold,Healing,Activatable
- Required — The type of the item. (Default: Unknown)
- (Note: Setting
|type=
toBold
,Healing
, orActivatable
will also categorize the article into the Bold Artifacts, Healing Artifacts, or Activatable Artifacts category, respectively.)
- (Note: Setting
|description=
- Required — A brief description of the item. (Default: Unknown)
|value=
- Optional — The average amount in gold coins this item can be sold for.
|monster=Monster Name
- Optional — Only include if the artifact actually has its own associated monster. Will automatically link to the Godwiki article for that monster.
- (Note: Setting
|monster=
will categorize the article into the Monsters' Artifacts category.)
- (Note: Setting
|ignore-no-image=yes
- Optional — Set to
yes
(or any similar positive-state value) to disable the automatic placement of{{Picture}}
above the infobox.
Example of Use
{{artifact | image = Example.jpg | type = Normal | description = A completely everyday and normal item. | value = 55 | monster = Generic Enemy }}
Quick blank template:
{{artifact | image = | type = Normal | description = }}