Difference between revisions of "Template:Petbox/doc"
Jump to navigation
Jump to search
(Created page with "This template is to be used when creating {{cl|Pets}} pages. The infobox will be beneficial in providing quick snippets of information to the user without forcing him/her to...") |
|||
| Line 29: | Line 29: | ||
! Parameter Name !! Required !! Description !! Accepted Values !! Default | ! Parameter Name !! Required !! Description !! Accepted Values !! Default | ||
|- | |- | ||
| − | | | + | | content || no || Is this article page for SWL or TSW || swl, tsw || tsw |
|- | |- | ||
| − | | | + | | '''name''' || '''Yes''' || The pet name. Used to assist with transclusions and additional templates. || <text> || |
|- | |- | ||
| − | | guiicon || Yes || The icon used by the [[Pet Inventory]] GUI || <filename>.<extension> || | + | | '''invicon''' || '''Yes''' || The icon that initially shows up in your inventory when you first receive the pet || <filename>.<extension> || |
| + | |- | ||
| + | | '''guiicon''' || '''Yes''' || The icon used by the [[Pet Inventory]] GUI || <filename>.<extension> || | ||
|- | |- | ||
| invdesc || No || The description the icon has while it is in your inventory || <text> || "Summons the <pagename>" | | invdesc || No || The description the icon has while it is in your inventory || <text> || "Summons the <pagename>" | ||
|- | |- | ||
| − | | description || Yes || The description of the pet from the [[Pet Inventory]] GUI || <text> || | + | | '''description''' || '''Yes''' || The description of the pet from the [[Pet Inventory]] GUI || <text> || |
| + | |- | ||
| + | | '''source''' || '''Yes''' || Description name of where it came from, as per the [[Pet Inventory]] GUI || || | ||
|- | |- | ||
| − | | | + | | sourcetype || no || Generic source type, for categorization || Mission, Achievement, Vendor, Bag, Item Store, Event, Item of the month || |
|- | |- | ||
| − | | colour || No || The colour/rarity of the pet. || White, Green Blue, Purple, Orange || White | + | | colour || No || The colour/rarity of the pet. || White, Green, Blue, Purple, Orange, Red || White |
|- | |- | ||
| binds || No || Enter "no" if the inventory item for this pet does ''not'' bind || No || Yes | | binds || No || Enter "no" if the inventory item for this pet does ''not'' bind || No || Yes | ||
Latest revision as of 17:33, 8 October 2017
This template is to be used when creating Category:Pets pages.
The infobox will be beneficial in providing quick snippets of information to the user without forcing him/her to go rifling through blocks of text. They are very easy to use and will make the page look much better.
Usage
Place this at the very top of your page, and fill in the information provided (variable descriptions follow the code). If some variables don't have info, just ignore it, and it will be hidden in the template.
{{Petbox
|name =
|invicon =
|guiicon =
|invdesc =
|description =
|source =
|colour =
|binds =
|unique =
}}
IMPORTANT
- Do not add the you should not need to add any categories to the page when using this template. They are automatically set by the template!
- Do not place brackets around Source. Page links are created by the template.
Parameters
| Parameter Name | Required | Description | Accepted Values | Default |
|---|---|---|---|---|
| content | no | Is this article page for SWL or TSW | swl, tsw | tsw |
| name | Yes | The pet name. Used to assist with transclusions and additional templates. | <text> | |
| invicon | Yes | The icon that initially shows up in your inventory when you first receive the pet | <filename>.<extension> | |
| guiicon | Yes | The icon used by the Pet Inventory GUI | <filename>.<extension> | |
| invdesc | No | The description the icon has while it is in your inventory | <text> | "Summons the <pagename>" |
| description | Yes | The description of the pet from the Pet Inventory GUI | <text> | |
| source | Yes | Description name of where it came from, as per the Pet Inventory GUI | ||
| sourcetype | no | Generic source type, for categorization | Mission, Achievement, Vendor, Bag, Item Store, Event, Item of the month | |
| colour | No | The colour/rarity of the pet. | White, Green, Blue, Purple, Orange, Red | White |
| binds | No | Enter "no" if the inventory item for this pet does not bind | No | Yes |
| unique | No | Enter "no" if for some reason this pet is not unique while in your inventory | No | Yes |
Notes
- This infobox is almost never used on it's own, see Template:Petpage for creating a page that would use this template
