Difference between revisions of "Template:Artifact/Documentation"
m (Elaborated on default image behaviour, explaining {{Picture}} and how to suppress/detach the templates if required.) |
(Update and reformat parameter docs) |
||
Line 3: | Line 3: | ||
==Parameters== | ==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|type|<var>Normal,Bold,Healing,Activatable</var>}} : ''Optional'' — The type of the item. (default: Normal) | ||
+ | :: ''('''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. (default: ''Unknown'') | |
− | |||
− | + | ;{{para|value}} : ''Optional'' — The average amount in gold coins this item can be sold for. | |
− | + | ; {{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. | |
+ | :: ''('''Note''': Setting {{para|monster}} will categorize the article into the [[:Category:Monsters' Artifacts|Monsters' Artifacts]] category.)'' | ||
+ | ;{{para|wanted|<var>date</var>}} : ''Optional'' — Date or dates when the monster was Wanted in the [[Godville Times]]. | ||
+ | : In the field, write the word "Day" or "Days" and add the [https://web.archive.org/web/20141229212110*/http://godvillegame.com/news web.archive.org] link of the g.e. day or days the monster was in the godville times. Don't write the letters "g.e." as those are automatically added. | ||
− | + | ; {{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. | |
− | |||
− | |||
− | |||
==Example of Use== | ==Example of Use== |
Revision as of 03:41, 25 November 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
- Optional — The type of the item. (default: Normal)
- (Note: Setting {para|type}} to
Bold
,Healing
, orActivatable
will also categorize the article into the Bold Artifacts, Healing Artifacts, or Activatable Artifacts category, respectively.)
- (Note: Setting {para|type}} to
|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
|wanted=date
- Optional — Date or dates when the monster was Wanted in the Godville Times.
- In the field, write the word "Day" or "Days" and add the web.archive.org link of the g.e. day or days the monster was in the godville times. Don't write the letters "g.e." as those are automatically added.
|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 | wanted = Day [https://web.archive.org/web/20140830200611/http://godvillegame.com/news 1574] }}