Difference between revisions of "Template:Monster/Documentation"

From GodWiki
Jump to navigation Jump to search
(Add note about automatic categorization for totem monsters.)
m (fixing |boss-type= section jump link and adding the snowman note)
 
(52 intermediate revisions by 8 users not shown)
Line 1: Line 1:
The monster template categorizes an article as a [[monster]] article and it supplies information about it.
+
As well as automatically categorizing an article into [[:Category:Monsters]], this template supplies some standard information about the subject of the article. For details on how to create a monster article, refers to the [[Creators Manual]] and the [[Guideline: Monster Articles]].
  
'''Parameters:'''
+
==Parameter quick-start==
 +
The following is essential documentation for users of this template. Comprehensive documentation follows this section.
 +
===Boss types===
 +
: The following codes can be used as arguments to {{para|boss-type}}.
 +
: {| class="wikitable"
 +
! {{para|boss-type}} !! Boss Type displayed !! Notes
 +
|-
 +
| <code>above</code> || Above-Ground || <code>[[snowman]]</code> is an exclusive variant
 +
|-
 +
| <code>dig</code> ''or'' <code>ug</code> || Underground ||
 +
|-
 +
| <code>quest</code> || Mini-Quest ||
 +
|-
 +
| <code>1</code> ''or'' <code>1ab</code> || 1-Ability Dungeon || ''AKA "Level 1" / "Class C" (old system)''
 +
|-
 +
| <code>2</code> ''or'' <code>2ab</code> || 2-Ability Dungeon || ''AKA "Level 2" / "Class B"''
 +
|-
 +
| <code>3</code> ''or'' <code>3ab</code> ''or'' <code>tb</code> || 3-Ability Dungeon || ''AKA "Level 3" / "Treasure Boss" / "Class A"''
 +
|-
 +
| <code>dungeon</code> || Dungeon || ''(unknown/generic)''
 +
|}
  
* '''image''' - ''Optional but preferable'' The full image file name.
+
===Implied subtypes===
 +
It is no longer '''required''' that {{para|pet|yes}}, {{para|boss|yes}}, or {{para|sea|yes}} be used to create an infobox of the associated subtype. Setting a value for any of the associated subtype parameters ({{para|boss-type}} for bosses; {{para|pet-level-from}}, {{para|pet-levels}}, or {{para|pet-feature}} for pets; or {{para|sea-names}} for beasties) will ''imply'' the setting of the subtype switch.
  
* '''class''' - The class of the monster e.g. alien, feline, humanoid, demon, amphibian etc.  Be reasonably exact but don't go overboard by using any taxonomy.
+
The {{para|<var>type</var>|yes}} switches '''may''' still be used, to activate the features for that type of infobox when none of the subtype parameters are being set.
  
* '''habitat''' - The habitat the monster is generally found in.
+
===Conflicting subtypes===
 +
If conflicting subtypes are set in the template, the template will add the page to [[:Category:Monsters with conflicting type parameters]]. More information about conflicting types can be found there.
  
* '''description''' - A brief description of the monster's appearance
+
==Parameters==
  
* '''health''' - ''Optional'' To find a monster's health, roll your mouse over the progress bar and it will give you a percentage (let's call it p1). Repeat until you get an EN entry where it tells you how many hp the monster got hit for (call it h). Then roll your mouse over to get the new percentage (call it p2). The health of the monster is: h/((p2-p1)/100).
+
; {{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|caption|<var>Image description</var>}} : ''Optional'' — Use only if {{para|image}} is also set. Text of a descriptive caption to display beneath the image.
  
* '''rattle''' - ''Optional'' Only include if the monster actually has a [[Death Rattle]].
+
; {{para|class}} : The class of the monster e.g. alien, feline, humanoid, demon, amphibian etc. Be reasonably exact but don't go overboard by using any taxonomy. (default: ''Unknown'')
  
* '''artifact''' - ''Optional'' Only include if the monster actually has it's [[Monsters' Artifacts|own artifact]].
+
; {{para|habitat}} : The habitat the monster is generally found in. (default: ''Unknown'')
  
* '''position''' - ''Optional'' The position of the template on the page. By default set to 'right' although you may set it to 'left' or 'centre'.
+
; {{para|description}} : A brief description of the monster's appearance. (default: ''Unknown'')
  
* '''totem''' - ''Optional'' If the monster is a totem for a guild, the guild may be added here.  Write only the guild name. The name will automatically link to that guild's GodWiki page, and the monster page will automatically be included in [[Category:Totem Monsters]].  
+
; {{para|latin}} : ''Optional'' — The monster's latin name. If set, will be listed directly underneath the article title at the top of the infobox. '''Automatically italicized.'''
  
* '''wanted''' - ''Optional'' Add the particular date or dates 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. Do no write the letters "g.e." as those are automatically added
+
; {{para|strong|<var>yes</var>}} : ''Optional'' — Set this parameter to ''yes'' or any [[Template:yesno|yes-like]] value to indicate this monster is a ''strong monster'', as described at [[Monsters#Strong Monsters|Monsters &sect; Strong Monsters]]. This parameter should not be used for a boss-monster or beastie, but some monsters and some pets are strong monsters. This will categorise the monster into the [[:Category:Strong Monsters|Strong Monsters]] category.
  
Example of Usage:
+
; {{para|health}} : ''Optional'' — The monster's typical health.
 +
: To find a monster's health, roll your mouse over the progress bar and it will give you a percentage (let's call it p1). Repeat until you get an EN entry where it tells you how many hp the monster got hit for (call it h). Then roll your mouse over to get the new percentage (call it p2). The health of the monster is: h/((p2-p1)/100).
  
<nowiki>{{monster</nowiki><br>
+
; {{para|rattle}} : ''Optional'' — Only include if the monster actually has a [[Death Rattle]].
| image = Example.jpg<br>
 
| class = Demon<br>
 
| habitat = Hell, Swamps, and Old Shoes<br>
 
| description = An evil red thing with an attitude<br>
 
| rattle = I'll be back!<br>
 
| artifact = Hell's Hailstone<br>
 
| totem = James' Guild<br>
 
| wanted = Day <nowiki>[https://web.archive.org/web/20140830200611/http://godvillegame.com/news 1574]</nowiki><br>
 
<nowiki>}}</nowiki>
 
  
 +
; {{para|artifact|<var>Artifact Name</var>}} : ''Optional'' — Only include if the monster actually has its [[Monsters' Artifacts|own artifact]]. Will automatically link to the Godwiki article for that artifact.
  
<noinclude> [[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>
+
; {{para|totem|<var>Guild Name</var>}} : ''Optional'' — The Guild which has this monster as its [[Guild Leader#Totem Monster|totem monster]]. Will automatically link to the Godwiki article for that Guild and the Guild's Godville page.
 +
::''('''Note:''' Setting {{para|totem}} will categorize the article into the [[:Category:Totem Monsters|Totem Monsters]] category.)''
 +
 
 +
;{{para|wanted|<var>date(s)</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.
 +
 
 +
===Subtype parameters===
 +
====Boss-monsters====
 +
''('''Note:''' Setting {{para|boss-type}} will categorize the article into the [[:Category:Boss-Monsters|Boss-Monsters]] category.)''
 +
;{{para|boss-type}} : ''Optional'' — See the [[#Boss types|boss types table]].
 +
 
 +
====Pets====
 +
''('''Note:''' Setting {{para|pet-level-from}}, {{para|pet-levels}}, or {{para|pet-feature}} will categorize the article into the [[:Category:Pets|Pets]] category.)''
 +
;{{para|pet-level-from}} : ''Optional'' — The lowest level at which the pet can be tamed. The infobox will calculate the correct range, including pre- and post-ark levels ranges.
 +
;{{para|pet-levels}} <small>{{nobold|or {{para|levels}}}}</small> : ''Deprecated'' — The range of levels the hero must be in to be able to tame the pet. Ignored if the preferred parameter {{para|pet-level-from}} is set; please use it instead.
 +
;{{para|pet-feature}} <small>{{nobold|or {{para|pet-features}}, {{para|feature}}, {{para|features}}}}</small> : ''Optional'' — Only include if the pet actually has a feature listed in its stats. (default: ''Unknown'')
 +
 
 +
====Sea creatures (Beasties)====
 +
''('''Note:''' Setting {{para|sea-names}} will categorize the article into the [[:Category:Beasties|Beasties]] category.)''
 +
;{{para|sea-names}} <small>{{nobold|or {{para|names}}}}</small> : ''Optional'' — Set from <code>1</code>/<code>one</code> to <code>5</code>/<code>five</code> to indicate which strength level the Beastie has, which represents its "type". (''Required'' with {{para|sea|yes}}, default: ''Unknown''.)
 +
 
 +
===Subtype switches===
 +
;{{para|boss|yes}}, {{para|pet|yes}}, {{para|sea|yes}}, : ''Optional'' — If set to a positive value (such as ''yes'', ''y'', ''true'', ''1'', etc.), activate the appropriate sub-category, title change, and categorization. Useful when none of the parameters related to the sub-type can be set.
 +
 
 +
===Template functionality===
 +
; {{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|top|<var>no</var>}} : ''Optional'' — Set to <code>no</code> to disable the automatic placement of the {{tlx|Top}} template on the article.
 +
 
 +
==Examples of Use==
 +
 
 +
====Empty quick-start template====
 +
 
 +
This has the most commonly used parameters ready to fill in. Paste this into an article for a quick start on your monster infobox. Unused parameters will be ignored (or appear as "''Unknown''").
 +
 
 +
<pre>{{monster
 +
| 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 = <!-- A caption to be displayed beneath the image. -->
 +
| latin = <!-- a Latin-style species name, if known/made-up -->
 +
| description = <!-- A short description of the monster. -->
 +
| class = <!-- The class of monster, such as "Humanoid" or "Automata" -->
 +
| habitat = <!-- Where the monster lives or thrives -->
 +
| strong = <!-- Set this to yes if this is a strong monster. -->
 +
| boss-type = <!-- One of: above, dig, quest, 1ab, 2ab, 3ab. See table for details. -->
 +
| pet-level-from = <!-- The lowest hero level at which the pet can be tamed -->
 +
| pet-feature = <!-- Rideable, Sailing, Dungeon, etc. -->
 +
| sea-names = <!-- From 1 to 5, the strength level the Beastie has -->
 +
}}</pre>
 +
 
 +
====Monster====
 +
{{monster
 +
| image = Example.jpg
 +
| caption = Example
 +
| latin =
 +
| description = An evil red thing with an attitude
 +
| class = Demon
 +
| habitat = Hell, Swamps, and Old Shoes
 +
| artifact = Hell's Hailstone
 +
| health = 55
 +
| rattle = I'll be back!
 +
| totem = James' Guild
 +
| wanted = Day [https://web.archive.org/web/20140830200611/http://godvillegame.com/news 1574]
 +
}}
 +
<pre>{{monster
 +
| image = Example.jpg
 +
| caption = Example
 +
| latin =
 +
| description = An evil red thing with an attitude
 +
| class = Demon
 +
| habitat = Hell, Swamps, and Old Shoes
 +
| artifact = Hell's Hailstone
 +
| health = 55
 +
| rattle = I'll be back!
 +
| totem = James' Guild
 +
| wanted = Day [https://web.archive.org/web/20140830200611/http://godvillegame.com/news 1574]
 +
}}</pre>
 +
{{clear}}
 +
 
 +
====Strong Monster====
 +
{{monster
 +
| image = GodvilleAdministrator.jpg
 +
| caption = The almighty Godville Administrator.
 +
| latin = Deusvilla administrare
 +
| description = Giant anthropomorphic beings with great power
 +
| class = Supreme being
 +
| habitat = Everywhere
 +
| strong = yes
 +
| artifact = Invite to Godville
 +
}}
 +
<pre>{{monster
 +
| image = GodvilleAdministrator.jpg
 +
| caption = The almighty Godville Administrator.
 +
| latin = Deusvilla administrare
 +
| description = Giant anthropomorphic beings with great power
 +
| class = Supreme being
 +
| habitat = Everywhere
 +
| strong = yes
 +
| artifact = Invite to Godville
 +
}}</pre>
 +
{{clear}}
 +
 
 +
====Pet====
 +
{{monster
 +
| image = Significantotter.jpg
 +
| caption = Example Pet
 +
| latin =
 +
| description = Aquatic mammal
 +
| class = Important
 +
| habitat = Bottled water streams
 +
| pet-level-from = 18
 +
}}
 +
<pre>{{monster
 +
| image = Significantotter.jpg
 +
| caption = Example Pet
 +
| latin =
 +
| description = Aquatic mammal
 +
| class = Important
 +
| habitat = Bottled water streams
 +
| pet-level-from = 18
 +
}}</pre>
 +
{{clear}}
 +
 
 +
====Boss-monster====
 +
{{monster
 +
| image = Bosstradamus.jpg
 +
| caption = Example Boss
 +
| latin =
 +
| description = A supervising future teller
 +
| class = Squid
 +
| habitat = Dungeons and cubicles
 +
| boss-type = 3ab
 +
}}
 +
<pre>{{monster
 +
| image = Bosstradamus.jpg
 +
| caption = Example Boss
 +
| latin =
 +
| description = A supervising future teller
 +
| class = Squid
 +
| habitat = Dungeons and cubicles
 +
| boss-type = 3ab
 +
}}</pre>
 +
{{clear}}
 +
 
 +
====Beastie====
 +
{{monster
 +
| image = ninjastar.jpg
 +
| caption = Example Beastie
 +
| latin =
 +
| description = A weaponized starfish
 +
| class = Serrated Starfish
 +
| habitat = The surface of the water
 +
| sea-names = 1
 +
}}
 +
<pre>{{monster
 +
| image = ninjastar.jpg
 +
| caption = Example Beastie
 +
| latin =
 +
| description = A weaponized starfish
 +
| class = Serrated Starfish
 +
| habitat = The surface of the water
 +
| sea-names = 1
 +
}}</pre>
 +
{{clear}}
 +
<noinclude>[[Category:Templates/Documents|{{PAGENAME}}]]</noinclude>

Latest revision as of 15:07, 20 January 2021

As well as automatically categorizing an article into Category:Monsters, this template supplies some standard information about the subject of the article. For details on how to create a monster article, refers to the Creators Manual and the Guideline: Monster Articles.

Parameter quick-start

The following is essential documentation for users of this template. Comprehensive documentation follows this section.

Boss types

The following codes can be used as arguments to |boss-type=.
|boss-type= Boss Type displayed Notes
above Above-Ground snowman is an exclusive variant
dig or ug Underground
quest Mini-Quest
1 or 1ab 1-Ability Dungeon AKA "Level 1" / "Class C" (old system)
2 or 2ab 2-Ability Dungeon AKA "Level 2" / "Class B"
3 or 3ab or tb 3-Ability Dungeon AKA "Level 3" / "Treasure Boss" / "Class A"
dungeon Dungeon (unknown/generic)

Implied subtypes

It is no longer required that |pet=yes, |boss=yes, or |sea=yes be used to create an infobox of the associated subtype. Setting a value for any of the associated subtype parameters (|boss-type= for bosses; |pet-level-from=, |pet-levels=, or |pet-feature= for pets; or |sea-names= for beasties) will imply the setting of the subtype switch.

The |type=yes switches may still be used, to activate the features for that type of infobox when none of the subtype parameters are being set.

Conflicting subtypes

If conflicting subtypes are set in the template, the template will add the page to Category:Monsters with conflicting type parameters. More information about conflicting types can be found there.

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.
|class=
The class of the monster e.g. alien, feline, humanoid, demon, amphibian etc. Be reasonably exact but don't go overboard by using any taxonomy. (default: Unknown)
|habitat=
The habitat the monster is generally found in. (default: Unknown)
|description=
A brief description of the monster's appearance. (default: Unknown)
|latin=
Optional — The monster's latin name. If set, will be listed directly underneath the article title at the top of the infobox. Automatically italicized.
|strong=yes
Optional — Set this parameter to yes or any yes-like value to indicate this monster is a strong monster, as described at Monsters § Strong Monsters. This parameter should not be used for a boss-monster or beastie, but some monsters and some pets are strong monsters. This will categorise the monster into the Strong Monsters category.
|health=
Optional — The monster's typical health.
To find a monster's health, roll your mouse over the progress bar and it will give you a percentage (let's call it p1). Repeat until you get an EN entry where it tells you how many hp the monster got hit for (call it h). Then roll your mouse over to get the new percentage (call it p2). The health of the monster is: h/((p2-p1)/100).
|rattle=
Optional — Only include if the monster actually has a Death Rattle.
|artifact=Artifact Name
Optional — Only include if the monster actually has its own artifact. Will automatically link to the Godwiki article for that artifact.
|totem=Guild Name
Optional — The Guild which has this monster as its totem monster. Will automatically link to the Godwiki article for that Guild and the Guild's Godville page.
(Note: Setting |totem= will categorize the article into the Totem Monsters category.)
|wanted=date(s)
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.

Subtype parameters

Boss-monsters

(Note: Setting |boss-type= will categorize the article into the Boss-Monsters category.)

|boss-type=
Optional — See the boss types table.

Pets

(Note: Setting |pet-level-from=, |pet-levels=, or |pet-feature= will categorize the article into the Pets category.)

|pet-level-from=
Optional — The lowest level at which the pet can be tamed. The infobox will calculate the correct range, including pre- and post-ark levels ranges.
|pet-levels= or |levels=
Deprecated — The range of levels the hero must be in to be able to tame the pet. Ignored if the preferred parameter |pet-level-from= is set; please use it instead.
|pet-feature= or |pet-features=, |feature=, |features=
Optional — Only include if the pet actually has a feature listed in its stats. (default: Unknown)

Sea creatures (Beasties)

(Note: Setting |sea-names= will categorize the article into the Beasties category.)

|sea-names= or |names=
Optional — Set from 1/one to 5/five to indicate which strength level the Beastie has, which represents its "type". (Required with |sea=yes, default: Unknown.)

Subtype switches

|boss=yes, |pet=yes, |sea=yes,
Optional — If set to a positive value (such as yes, y, true, 1, etc.), activate the appropriate sub-category, title change, and categorization. Useful when none of the parameters related to the sub-type can be set.

Template functionality

|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.

Examples of Use

Empty quick-start template

This has the most commonly used parameters ready to fill in. Paste this into an article for a quick start on your monster infobox. Unused parameters will be ignored (or appear as "Unknown").

{{monster
| 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 = <!-- A caption to be displayed beneath the image. -->
| latin = <!-- a Latin-style species name, if known/made-up -->
| description = <!-- A short description of the monster. -->
| class = <!-- The class of monster, such as "Humanoid" or "Automata" -->
| habitat = <!-- Where the monster lives or thrives -->
| strong = <!-- Set this to yes if this is a strong monster. -->
| boss-type = <!-- One of: above, dig, quest, 1ab, 2ab, 3ab. See table for details. -->
| pet-level-from = <!-- The lowest hero level at which the pet can be tamed -->
| pet-feature = <!-- Rideable, Sailing, Dungeon, etc. -->
| sea-names = <!-- From 1 to 5, the strength level the Beastie has -->
}}

Monster

Monsters of Godville
Monster/Documentation
Example.jpg
Example
Class Demon
Habitat Hell, Swamps, and Old Shoes
Health 55
Death Rattle I'll be back!
Artifact Hell's Hailstone
Wanted on Day 1574 g.e.
Totem for James' Guild ⚜️ 
Description An evil red thing with an attitude
{{monster
| image = Example.jpg
| caption = Example
| latin = 
| description = An evil red thing with an attitude
| class = Demon
| habitat = Hell, Swamps, and Old Shoes
| artifact = Hell's Hailstone
| health = 55
| rattle = I'll be back!
| totem = James' Guild
| wanted = Day [https://web.archive.org/web/20140830200611/http://godvillegame.com/news 1574]
}}

Strong Monster

Strong Monsters of Godville
Monster/Documentation
Deusvilla administrare
GodvilleAdministrator.jpg
The almighty Godville Administrator.
Strong Monster
Class Supreme being
Habitat Everywhere
Artifact Invite to Godville
Description Giant anthropomorphic beings with great power
{{monster
| image = GodvilleAdministrator.jpg
| caption = The almighty Godville Administrator.
| latin = Deusvilla administrare
| description = Giant anthropomorphic beings with great power
| class = Supreme being
| habitat = Everywhere
| strong = yes
| artifact = Invite to Godville
}}

Pet

Pets of Godville
Monster/Documentation
Significantotter.jpg
Example Pet
Class Important
Habitat Bottled water streams
Description Aquatic mammal
Pet
Tame at levels 18–32 (47 with ark)
Features Unknown
{{monster
| image = Significantotter.jpg
| caption = Example Pet
| latin = 
| description = Aquatic mammal
| class = Important
| habitat = Bottled water streams
| pet-level-from = 18
}}

Boss-monster

Boss-Monsters of Godville
Monster/Documentation
Bosstradamus.jpg
Example Boss
Class Squid
Habitat Dungeons and cubicles
Description A supervising future teller
Boss
Boss Type 3-Ability Dungeon
Part Level Level 3
{{monster
| image = Bosstradamus.jpg
| caption = Example Boss
| latin = 
| description = A supervising future teller
| class = Squid
| habitat = Dungeons and cubicles
| boss-type = 3ab
}}

Beastie

Beasties of Godville
Monster/Documentation
ninjastar.jpg
Example Beastie
Class Serrated Starfish
Habitat The surface of the water
Description A weaponized starfish
Beastie
Type Single-Named
Strength Level 1: 10-19 HP
{{monster
| image = ninjastar.jpg
| caption = Example Beastie
| latin = 
| description = A weaponized starfish
| class = Serrated Starfish
| habitat = The surface of the water
| sea-names = 1
}}