A KoL Wiki:Established Standards/Item Pages

Item pages should be formatted as such, containing the following elements as needed, IN THE ORDER SHOWN HERE:

New Items

In addition to creating a new page for a new item as detailed below, new items need to be set up in a number of other places. All new items need to go in Items by number, Items by Name and Items by Autosell Price. Depending on the item type, there are a variety of other pages that need to be updated (see the Item Types page for details). Enchanted equipment needs to be added to the appropriate Game Mechanics pages. Changes to existing items, especially name changes, need to be made to all the above pages as well.

The Basic Item Entry

The entire item description page can be formatted, as visible in the game, using the template {{item}} and a corresponding item metadata page (accessible by clicking on the "Create metadata" link on a new item on the wiki, or the "View metadata" link for an item that already has metadata).

{{item|
  itemid=item number|
  descid=description id|
  desc=in-game description|
  other option=value|
  etc.}}

Item descriptions are to be typed out fully, formatted in the same way as they appear in-game, in the desc field

desc=This is a lime. Unlike a lemon, it's a lime.|

Items can have numerous special properties, which can be specified by adding the following fields in place of the "other option=value|" in the template. All of these are optional.

• noid=1 to suppress warnings of missing item/description IDs
• smith=1 for meatsmithing components
• cook=1 for cooking ingredients
• cocktail=1 for cocktailcrafting ingredients
• jewelry=1 for jewelrymaking components

Equipment properties can be specified using the following fields:

• type=type for items with a "Type: " line, like pants, food, etc.
• power=power for weapons and armor
  • You can also add powertype=type to change what type of power, like "Damage Reduction" for shields
• stat=Muscle, Mysticality or Moxie which is the type of the stat requirement listed below
• statreq=stat requirement as a number for equipment
• level=level for food/beverage/booze/spleen items (specify '1' if there is no level requirement visible)
• outfit=outfit name for equipment in outfits
• tradeable=0 for untradable items
• autosell=value for autosellable items
  • autosell=0 for items that cannot be discarded
• quest=1 for quest items
• gift=1 for gift items
• enchantment=enchantment for enchanted equipment
• critical=1 for items that increase critical hit chance.
• mpreduce=1 for items that reduce MP cost of skills.
• hardcore=0 for items that cannot be equipped in Hardcore.
• limit=1 for items that you can only equip one at a time
• hagnk=1 for items that can be pulled from Hagnk's Ancestral Mini-Storage during Hardcore or Ronin without counting as an item pull
• verify=1 if anything needs to be verified
• verify=2 if the item no longer exists and cannot possibly be verified
• verify=3 for custom items placed on user pages and such

Example:

cook=1|
cocktail=1|
level=2|
type=food|
autosell=60|

Note: The rest of our lime example is hypothetical, and does not reflect the true nature of the lime.

An item's enchantment, if it has one, can be specified using the enchantment field.

enchantment=Melee Damage +5|

If the item gives an effect, create a link to the effect's page.

enchantment=Intrinsic Effect: [[Limey Accent]]|

If the item gives element damage, then use the element template (element must be capitalized)

enchantment=+5 {{element|Stench}}|

---

Putting everything together, the Basic Item Entry looks like the following:

{{item|
itemid=333|
descid=839503923|
desc=This is a lime. Unlike a lemon, it's a lime.|
cook=1|
cocktail=1|
type=food|
level=2|
autosell=60|
enchantment=So-So Scurvy Resistance<br />+1 {{element|Stench}}}}

which yields:

Unknown item name

This is a lime. Unlike a lemon, it's a lime.

(Cooking ingredient)
(Cocktailcrafting ingredient)
Type: food (quality unspecified)
Size: UNSPECIFIED
Level required: 2
Selling Price: 60 Meat.

So-So Scurvy Resistance
+1 Stench Damage

(Error - In-game plural not defined in metadata - please add it here.)

Create metadata
Item number: 333
Description ID: 839503923
View in-game: view
View market statistics

refreshedit data

Other Information

We now move away from the copy of the Kingdom's item description. The following elements should be in the order described below:

Drop Locations

The drop location header should read "Drop Location" if there is only one drop location, but should read "Drop Locations" if there is more than one.

==Drop Locations==
*[[The Icy Peak]]
*[[The Misspelled Cemetary]]

yields:

Drop Locations

• The Icy Peak
• The Misspelled Cemetary

Drop locations should have bullets next to them, since an item may drop from multiple locations. They should also be links to the appropriate location page.

Recipe

==Recipe==
{| border="1px" cellspacing="0" cellpadding="3"
|- style="background-color: #FFFFFF" align="center"
| {{smith}}
| [[sturdy sword hilt]]
| [[dense meat stack]]
| style="background-color: #FFFFFF" width="32" | {{cook}}
| [[spices]]
| [[herbs]]
| rowspan="2" |
|- style="background-color: #EEEEEE" align="center"
| style="background-color: #FFFFFF" | {{smith}}
| colspan="2" | [[dense meat sword]]
| colspan="3" | [[secret blend of herbs and spices]]
|- style="background-color: #DDDDDD" align="center"
| style="background-color: #FFFFFF" | {{smith}}
| colspan="5" | [[Kentucky-fried meat sword]]
| [[hot wing]]
|- style="background-color: #CCCCCC" align="center"
| style="background-color: #FFFFFF" | {{equals}}
| colspan="6" | [[buffalo blade]]
|}

yields:

	sturdy sword hilt	dense meat stack		spices	herbs
	dense meat sword		secret blend of herbs and spices
	Kentucky-fried meat sword					hot wing
	buffalo blade

To enter nifty icons into a recipe, use these templates:

Basic Recipe Types {{cocktail}} {{combine}} {{cook}} {{jewelry}} {{smith}}

Special skills {{advcocktail}} {{armorcraft}} {{expensivejewelry}} {{improve}} {{kick}} {{pasta}} {{sauce}} {{shcocktail}} {{smash}} {{supersmith}} {{wayofSauce}}

Other {{add}} {{equals}} {{assimilator}} {{Crimborg Toymaker}} {{multiuse}} {{pixel}} {{Spooky Toymaker}} {{spore}} {{starcombo}} {{staffcrafting}} {{supertinker}} {{toolmaker}} {{toymaker}} {{untinker}} {{weave}}

• Note that you only insert crafting icons within the table in cases where multiple crafting skills are being utilized within the same row. If all combinations within a row use the same skill, placing the icon on the far left is sufficient.
• Also keep in mind that on an actual item page, the item itself will not be a link; rather, the bracketing will serve to bold the name of the item within the recipe table.

When Consumed/Used

• For food and booze, use the header "When Consumed", for usable items, use "When Used".
• For food, do NOT record adventure gains if you are currently under The Opossum zodiac sign, have recently consumed milk of magnesium or a munchies pill, or have Gluttony or Pride.
• For booze, do NOT record adventure gains if you are currently under The Blender zodiac sign or are listening to Ode to Booze. Be aware that wearing a tuxedo shirt may also affect booze adventure gains.
• During stat days, do NOT record stat gains for the stat being boosted on that day (that is, during Moxie days, do not record values for Moxie substat gains).
• All item usage texts should be formatted using the {{useitem}} template.

==When Consumed==
{{useitem|
text=You eat the lime. Limetastic!|
adv=2-5|
mys=lose 1-5|
mox=gain 5-15|
type=food|
limiter=2}}

yields:

When Consumed

You eat the lime. Limetastic!

You gain 2-5 Adventures.

You lose 1-5 Magicalness. You gain 5-15 Roguishness.

(You gain 2 Fullness.)

• For booze, simply change the type from "food" to "booze".

{{useitem|
text=You drink the lime. How'd you do that?|
adv=3|
mus=gain 15-20|
type=booze|
limiter=3}}

yields:

You drink the lime. How'd you do that?

You gain 3 Adventures.

You gain 15-20 Muscleboundness.

You gain 3 Drunkenness.

Usable items may require more formatting. If an item is usable both from your inventory and during combat, specify where it's being used from by putting down a (non-centered) bullet and use location, followed by a colon. Then, use {{useitem}} to show all text and effects of the use, as it appears in the Kingdom.

==When Used==
*From inventory:
{{useitem|
text=You use the lime, and it goths you up!|
effect={{acquireEffect|effect=Gothy|duration=4}}}}
*In combat:
{{useitem|
text=The lime limes your opponent for 83 {{element|Lime|damage}}|
type=combat}}

yields:

When Used

• From inventory:

You use the lime, and it goths you up!

You acquire an effect: Gothy (duration: 4 Adventures)

• In combat:

	The lime limes your opponent for 83 Lime damage

For familiars, simply set the type to "familiar" and fill in the text appropriately.

{{useitem|
text=It begins to pace back and forth menacingly.|
type=familiar}}

yields:

You put the Established Standards/Item Pages(?) in your Familiar-Gro™ Terrarium.

It begins to pace back and forth menacingly.

You decide to name him Hadolph.

Note: For elemental damage, use the template {{element}} to format it properly.

Uses

This section differs from the When Used section. It is just a list of links to items that are created with the lime as an ingredient. This is not recursive though; only list items whose creation directly include this item, not items created beyond that.

==Uses==
*[[Boris's key lime pie]]
*[[Jarlsberg's key lime pie]]
*[[Sneaky pete's key lime pie]]

yields:

Uses

• Boris's key lime pie
• Jarlsberg's key lime pie
• Sneaky Pete's key lime pie

Always put a bullet, and always [[link]] the item.

Messages

The messages section applies to weapons which have hit messages specific to that weapon only. Hit messages which occur for all weapons of the same category are collected on the category page (compare black sword and the swords category).

==Messages==
*''[[Player Hit Messages|Weapon-Specific Hit Messages]]'':
{{Hit Message|You bonk <it> for X damage.}}
{{Hit Message|You bop <it> for X damage.}}

yields:

Messages

• Weapon-Specific Hit Messages:

You bonk <it> for X damage. ZOT! BONK! SMACK!

You bop <it> for X damage. SOCKO! ZAP! WHAM!

Pronouns and specific damage amounts should be replaced with generic values as illustrated above. New messages should also be added to Player Hit Messages.

Notes

The notes section contains any information that doesn't fit into any of the above sections.

==Notes==
*This lime variant does not exist.

yields:

Notes

• This lime variant does not exist.

Once again, always use a bullet, as more information may be added.

References

• A reference is incomplete unless it explains how it is a reference. Always explain your reference and add links for more information. If a song lyric is referenced, include the lyric. If a movie referenced, briefly describe the situation in the movie, etc. If a band/movie/album/game/book is mentioned in the reference link it up, preferably to Wikipedia. An unexplained and unlinked reference is useless to anyone but the author.
• Mention where the reference is located on the page, such as the item description, message when consumed, attack message, etc.
• Write references in complete sentences, using proper capitalization! Do not always say "is a reference to" or "refers to", for it gets repetitive. Feel free to mix it up using things like "is from", "alludes to", "is an allusion to", "is a play on", or some other synonym.
• Always start a reference with a bullet, as more references may be added. Italicize the names of movies, books, poems, albums, and video games. Some of these would be underlined, but web links may be underlined, so it'd be moot. Song titles, lyrics, and quotes should be enclosed in quotes. Song lyrics and poem excerpts should have their lines separated by /s, such as "The farmer in the dell / The farmer in the dell / Hi-ho, the derry-o / The farmer in the dell". If the selection needs to be uncommonly long, it can be enclosed in <blockquote></blockquote>, but this should not be used often.

==References==
*In the description of this item , "watch out Manitoba!" alludes to
 the 2010 movie ''[[Wikipedia:Lime|Attack of the Limes!]]'', in which
 a giant radioactive lime annihilates the whole Canadian province of
 [[Wikipedia:Manitoba|]].

yields:

References

• In the description of this item , "watch out Manitoba!" alludes to the 2010 movie Attack of the Limes!, in which a giant radioactive lime annihilates the whole Canadian province of Manitoba.

Try to link properly using Wikipedia links just as above. A list of other useful interwiki prefixes can be found here.

See Also

This section contains any links within the wiki that relate directly to the item, but don't fall into one of the above categories.

The See Also section should include a link to all relevant Game Mechanics pages (alphabetized, of course). For example:

• Bonus Spell Damage
• Critical Hit Chance
• Meat from Monsters
• Muscle Modifiers

When adding these links, it'd be nice if the item were added to the corresponding lists in addition to items by name, number, and autosell price.

==See Also==
*[[lime]]

yields:

See Also

• lime

As with almost every other section, use a bullet.

Zapping

==Zapping==
{{ZAP lime}}

yields:

Zapping

Just include the item's zapping template, if applicable. It should already exist in the ⌈Zap Group Templates⌉^?. If it doesn't, make it, rather than filling in the generic template.

Collection

Custom items do not get this section.

==Collection==
<collection>lime</collection>

yields:

Collection

• #: - 0

Powered by Museum 🏛️ (see more)

Navigational Templates

Any navigational templates that are not within their own section (such as zapping), should be included beneath the collection information with two lines of blank space separating them in the code.

{{Ultra rares}}

yields:

Categorization

Any categorization of the item pages should occur at the bottom of the wiki code, below the navigational templates. Each categorization should be on a separate line. Please note that a number of formerly used categories have been discontinued and should not be used. These include Drops, NPC Buy, and more. If a category doesn't exist, then don't use it.

[[Category:Food]]
[[Category:Accordions]]

For items that start with "the", do this:

[[Category:Food|lime, the]]
[[Category:Accordions|lime, the]]