A KoL Wiki:Established Standards

From A KoL Wiki
Revision as of 02:44, 27 November 2005 by imported>Alpaca (Added a ton of stuff. An absolute ton. The page is done for now.)
The Hermit humbly requests that this page be rewritten or expanded.

Needs new standards added as they are created.

This page contains all formally established standards for creating and editing wiki pages. For standards that are not listed here, see Proposed Standards. This page assumes a basic knowledge of wiki editing.

Due to the examples listed on this page, headings herein are messy, so a wiki-generated table of contents is not suitable. For your convenience, the major sections of this page are:

Headings

  • Please, always use "h2" or "==" headings, or smaller sizes thereof.
=A large and obnoxious heading=

yields:

A large and obnoxious heading

Tables of Contents

  • A page will automatically generate a table of contents if there are four or more headings.
  • If you do not wish for your page to have a table of contents, insert the following near the top of your document:
__NOTOC__
    • Some pages, like correctly-templated item pages, do this automatically.
  • If you have fewer than four headings, but wish to have a table of contents nevertheless, place the following where you wish for the table of contents to appear:
__TOC__

File names

  • Changes in capitalization causes new pages to be created. Please capitalize items just as they are in the Kingdom when you look at your inventory or the mall. This is particularly noticeable when you note the difference between familiars. For example hovering sombrero is the larval item, and Hovering Sombrero is the familiar. Do NOT create a new page on an item because you mis-capitalized. It WILL be deleted.
  • Do not end a page name with a period, even if the title should have a period (such as The Shore, Inc.) Pages named this way can't be linked to properly, and are difficult to edit, move, or delete. Just don't do it.
  • When uploading KoL images, use the same filename for the image as is used in the kingdom. If you receive an error that the file already exists, then it already exists. Do not change the filename of yours. Jick does not repeat filenames, so if we keep his, we should not have any problems. It also makes it easier for everyone to use the same files. When editing a page with an image on it, be sure of what image is being used in the Kingdom. Chances are we already have it.

Categories

  • Contemplated new Categories should be discussed in forums before being implemented. As a general rule of thumb, there should be a strong and meaningful relationship between the elements being categorized. Also, there should probably be at least, say, 10 members in the proposed new category.
  • When making or editing a page for an item that falls into an obvious cateogory, be sure to put that page into the category. For instance, if you were editing Hell ramen, and found it uncategorized, you would put the following at the bottom of the page:
[[Category:Food]]
[[Category:Food (By Fullness)|6, hell ramen]]

The former simply categorizes Hell ramen as a food. The latter categorizes it as a food of six fullness.

Item Pages

Item images should be formatted as such, IN THE ORDER SHOWN HEREIN:

The basic item entry:

Headers

{{itemheader|image=lime.gif|item=lime}}

yields: Template:Itemheader

Descriptions

Item descriptions are to be typed out fully, in normal text, one line under the header:

Template:Itemheader This is a lime. Like a lemon, it's shaped like a lemon. Unlike a lemon, it's a lime.

Basic Item Information

Follow the Kingdom's template for bolding, capitalization, and punctuation closely. 

(Cooking ingredient)<br />
(Cocktailcrafting ingredient)<br />
Type: '''food'''<br />
Selling Price: '''60 Meat'''.

yields:

Template:Itemheader This is a lime. Like a lemon, it's shaped like a lemon. Unlike a lemon, it's a lime.

(Cooking ingredient)
(Cocktailcrafting ingredient)
Type: food
Selling Price: 60 Meat.

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

Enchantment

{{enchantment|enchantment=Scurvy Resistance}}

yields:

Template:Itemheader This is a lime. Like a lemon, it's shaped like a lemon. Unlike a lemon, it's a lime.

(Cooking ingredient)
(Cocktailcrafting ingredient)
Type: food
Selling Price: 60 Meat.

Template:Enchantment

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 location

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

yields:

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.

Recipes

==Recipe==
<table cellpadding=3 cellspacing=0 border=1px>
<tr align=center>
<td>{{supertinker}}</td>
<td>[[flange]]</td>
<td>[[cog]]</td>
<td>[[spring]]</td>
<td colspan=2><br></td>
<td>[[flange]]</td>
<td>[[spring]]</td>
<td>[[sprocket]]</td>
</tr>
<tr align=center style="background-color: #EEEEEE">
<td style="background-color: #FFFFFF">{{supertinker}}</td>
<td colspan=3>[[clockwork thingamajig]]</td>
<td>[[spring]]</td>
<td>[[sprocket]]</td>
<td colspan=3>[[clockwork doohickey]]</td>
<td>[[cog]]</td>
<td>[[sprocket]]</td>
</tr>
<tr align=center style="background-color: #DDDDDD">
<td style="background-color: #FFFFFF">{{supertinker}}</td>
<td colspan=5>[[clockwork claws]]</td>
<td colspan=5>[[clockwork counterclockwise dome]]</td>
<td>[[clockwork key]]</td>
</tr>
<tr align=center style="background-color: #CCCCCC">
<td style="background-color: #FFFFFF">{{cook}}</td>
<td colspan=11>[[clockwork endoskeleton]]</td>
<td>[[grapefruit]]</td>
</tr>
<tr align=center style="background-color: #BBBBBB">
<td style="background-color: #FFFFFF">{{equals}}</td>
<td colspan=12>[[unwound clockwork grapefruit]]</td>
</tr>
</table>

yields:

flange cog spring
flange spring sprocket
clockwork thingamajig spring sprocket clockwork doohickey cog sprocket
clockwork claws clockwork counterclockwise dome clockwork key
clockwork endoskeleton grapefruit
unwound clockwork grapefruit

To enter the nifty icons into a table, use these templates:
Basic Recipe Types

Special skills

Other

  • Note that you only insert crafting icons within the table in cases where multiple crafting skills are being utililized 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 when consumed. For usable items, use when used. 

==When Consumed==
{{Food|full=2|adv=2-5|mus=gain 5-15|mys=gain 5-15|mox=gain 5-15|text=You eat the lime. Limetastic!}}

yields:

Template:Food 

==When Consumed==
{{Booze|drunk=3|adv=3|mus=gain no|mys=gain no|mox=gain no|text=You drink the lime. Limetastic!}}

yields:

Template:Booze 

==When Used==
*From inventory:
<center>
You use the lime, and it kicks your butt... from inside your stomach.
</center>
{{AcquireEffect|image=Beatenup.gif|effect=Beaten Up|duration=4}}
*In combat:
<center>You throw the lime at your opponent doing 83 Limetastic! damage.</center>

yields:

  • From inventory:

You use the lime, and it kicks your butt... from inside your stomach.

You acquire an effect: Beaten Up
(duration: 4 Adventures)
  • In combat:
You throw the lime at your opponent doing 83 Limetastic! damage.

Some items may be used from multiple places. Therefore, even when an item only has one method of use, always specify where it's being used from by putting down a (noncentered) bullet and use location, followed by a colon. Then, center and copy down all text and effects of the use, as it appears in the Kingdom.

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. 

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

yields:

Always put a bullet, and always link the item.

Zapping

==Zapping==
{{ZAP lime}}

yields:

Template:ZAP lime

Just include the item's zapping template, if applicable. It should already exist. If it doesn't, make it, rather than filling in the generic template.

References

==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|Manitoba]]

yields:

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

Always start a referencce with a bullet, as more references may be added. Always explain your reference and add links for more information. An unexplained and unlinked reference is useless to anyone but the author. If a song lyric is referenced, include the lyric, 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. Also, it's good to 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 redundant. 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. Italicize the names of movies, books, poems, albums, and video games. Some of these would be underlined, but web links get underlined, so it'd be moot. Song titles, lyics, and quotes should be enclosed in quotes. Song lyics and poem excerpts should have their lines seperated 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 selecion needs to be uncommonly long, it can be enclosed in <blockquote></blockquote>, but this should not be used often.

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:

  • This lime variant does not exist.

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

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. 

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

yields:

As with almost every other section, use a bullet.

Location Pages

The following template is for pages outlining a specific location.

  • These pages are to contain the location image, at the top, centered, and
  • A brief description of the location.

They are then to include the following template copied for each applicable adventure: 

{{Adventure|name=Sabre-toothed_lime|drops=[[lime]], [[Lime|totally different lime]]|meat=13-16|stat=2-3|image=biglime.gif}}
  • The name variable is the name of the adventure, as it appears in bold at the top of your center pane when adventuring, or the name of the monster.
  • The drops are a list of dropped items, seperated by commas.
    • If you gain multiple copies of an item, list the item multiple times.
  • Meat is the meat gain
  • Stat is the total substat gain.
    • Add up Muscle, Mysticality, and Moxie gains.
  • Image is the picture associated with the adventure, uploaded to the wiki with the name the file uses in the Kingdom.

This yields:

Limetastic!

Non-Combat Adventure Pages

Due to the highly variable nature of non-combat adventures, no wiki template exists for them. Please, therefore, adhere to the following guidelines:

  • The name of the page should be the name of the adventure, as it appears at the top of the center pane in your browser.
  • On the page, center the associated image at the top, and include the obligatory initial paragraph of text (un-centered) below that.
  • If the adventure allows for choices, include a line (Wikicode: ----) after the initial description, and then:
    • Put the text of the choice, as it appears on the button in the Kingdom, centered, in bold, below the line.
    • Include any results of that choice below, formatted as they appear in the Kingdom.
    • Include another line before the next choice.
  • If the adventure does not allow for choices, copy out the rest of the text in exactly the same format as is in the Kingdom.

Combat Adventure Pages

Begin with the following template: 

{{battletop|image=biglime.gif|a=a|name=Sabre-toothed lime|text=This room is guarded by a lime with nasty pointy teeth. Look on the bright side - if it bites you, at least you won't get scurvy.}}
  • Image is the monster's image, uploaded to the wiki with the same filename as in the Kingdom.
  • A is the monster's article - are you fighting a monster, an annoying monster?
  • Name is the monster's name.
  • Text is the monster's description, as it appears in the Kingdom.

Our above example would yield:

Template:Battletop

Attack Messages

  • Center all messages.
    • If a monster hits you or tries to hit you in a body part, use the following syntax:
{{part}}

Which yields:

<neck>

  • List successful attack messages first.
    • Follow these up with the following syntax:
'''<span style="color: red;">Eek! Oof! Ugh!</span>'''

Which yields:

Eek! Oof! Ugh!

You may replace the three exclamations with others of your choice from the Kingdom.

  • If a monster misses, write that message down under the successful hit messages.

Spoils of War

  • List the rewards in the order in which they appear in the Kingdom.
  • Center the rewards
    • If you gain multiple copies of an item, list multiple copies of the item.
    • Link items to their wiki pages.
  • Give the total substats gained from the fight, added up, instead of seperating them into Muscle, Mysticality, and Moxie. 
<center>[[image:meat.gif|Meat]] You gain 160-240 Meat.

[[image:lime.gif|lime]] You acquire an item: '''[[lime]]'''<br />
[[image:lime.gif|lime]] You acquire an item: '''[[lime]]'''

You gain 18-21 {{substat}}</center>

Yields:

Meat You gain 160-240 Meat.

lime You acquire an item: lime
lime You acquire an item: lime

You gain 18-21 <substat>

Effect Pages

Header

Use the following template: 

{{effect|name=Scurvy Resistance|image=lime.gif|desc=Lime juice flows through your veins, making you so ridiculously powerful that scurvy withers in your very presence.|effect=*+100 Muscle<br /> *+100 Mysticality}}
  • Name is the name of the effect.
  • Image is the image associated with that effect, uploaded to the wiki, with the same filename that it has in the Kingdom.
  • Desc is the effect's description, as it appears in the popup in the Kingdom when you click the effect in your character pane.
  • Effect is the actual, mechanical effect you experience.

Our example above would yield:

undefined effect name

undefined effect name

Lime juice flows through your veins, making you so ridiculously powerful that scurvy withers in your very presence.

  • +100 to All Stats

Create metadataData:Established Standards
Effect ID not known!
Description ID not known!

Obtained From

  • List and wikilink the source of the effect.
==Obtained From==
*[[Lime]]

Yields:

As always, bullet.

Other Information

If necessary, include a references, notes, and/or See Also section, which adheres to the same standards meticulously outlined in the item pages section of this guide.

Retrieved from "https://wiki.kingdomofloathing.com/index.php?title=A_KoL_Wiki:Established_Standards&oldid=572418"