Difference between revisions of "Template:Artifact/Documentation"
m (Template:clear at end to keep from overrunning documentation box) |
(Document |cost= and add an example) |
||
Line 12: | Line 12: | ||
;{{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. | ||
+ | |||
+ | ;{{para|cost|<var>godpower</var>}}: ''Optional'' – For {{para|type|activatable}} artifacts, indicates the activation cost. Possible values are: | ||
+ | ::{{para|cost|0}} – Requires no godpower to activate (can also be: <code>free</code>,<code>none</code>) | ||
+ | ::{{para|cost|50}} – Requires 50% of godpower to activate | ||
; {{para|monster|<var>Monster Name</var>}} : ''Optional'' — Only include if the artifact actually has its own [[Monsters' Artifacts|associated monster]]. Will automatically link to the Godwiki article for that monster. | ; {{para|monster|<var>Monster Name</var>}} : ''Optional'' — Only include if the artifact actually has its own [[Monsters' Artifacts|associated monster]]. Will automatically link to the Godwiki article for that monster. | ||
Line 41: | Line 45: | ||
| value = 55 | | value = 55 | ||
| monster = Generic Enemy | | monster = Generic Enemy | ||
+ | }}</nowiki></pre> | ||
+ | {{clear}} | ||
+ | {{Artifact | ||
+ | |image = Example.jpg | ||
+ | |caption= | ||
+ | |type = Activatable | ||
+ | |cost = 50 | ||
+ | |description = | ||
+ | }} | ||
+ | <pre><nowiki>{{Artifact | ||
+ | |image = Example.jpg | ||
+ | |caption= | ||
+ | |type = Activatable | ||
+ | |cost = 50 | ||
+ | |description = | ||
}}</nowiki></pre> | }}</nowiki></pre> | ||
{{clear}}<noinclude>[[Category:Templates/Documents|{{PAGENAME}}]]</noinclude> | {{clear}}<noinclude>[[Category:Templates/Documents|{{PAGENAME}}]]</noinclude> |
Revision as of 22:49, 26 January 2019
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).|caption=Image description
- Optional — Use only if
|image=
is also set. Text of a descriptive caption to display beneath the image.
|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.
|cost=godpower
- Optional – For
|type=activatable
artifacts, indicates the activation cost. Possible values are:|cost=0
– Requires no godpower to activate (can also be:free
,none
)|cost=50
– Requires 50% of godpower to activate
|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
Quick blank template:
{{artifact | image = <!-- An image filename (e.g. Example_picture_name.jpg). If the filename doesn't exist, this gives you a link to upload it. --> | type = <!-- Type can be: Normal, Bold, Healing, or Activatable. Defaults to 'Normal' if no type is given. --> | description = | value = <!-- Average selling value --> | monster = <!-- If this is only found on a specific monster, list it here --> }}
Artifact/Documentation | |
---|---|
Type | 🧷Normal |
Value | 55 |
Associated Monster | Generic Enemy |
Description | A completely everyday and normal item. |
{{artifact | image = Example.jpg | type = Normal | description = A completely everyday and normal item. | value = 55 | monster = Generic Enemy }}
Artifact/Documentation | |
---|---|
Type | ⚙️Activatable |
Description | Unknown |
Activation | |
Cost | 50% of godpower |
{{Artifact |image = Example.jpg |caption= |type = Activatable |cost = 50 |description = }}