TheKolWiki:Established Standards

From TheKolWiki
Jump to: navigation, search

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

Large and obnoxious, see?

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__
  • Most pages, like correctly-templated items and adventures, 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.
  • 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 usually does not repeat filenames, so if we keep his, we should not have many 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.
  • In the unlikely event there really is a filename clash, please follow the procedure laid out here.

Categories

  • A category should be viewed as an organization mechanism of last resort. If information can be more usefully organized by the use of a page or a table, then that should be the preferred organization mechanism. Contemplated new Categories should be discussed in Proposed Standards or Discussion 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 category, 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.

  • When categorizing pages whose names begin with an article (such as "a" or "the"), specify the page name with the article moved to the end in the category tag. For example, the Adventure page "The Icy Peak" should be categorized using [[Category:Adventure|Icy Peak, The]] so it appears under "I" instead of "T".
  • All categories that a page is placed in should be grouped together at the bottom of the page.
  • For a complete list of categories, see Special:Categories.

Page Needs Work

Depending on how thorough you have been, other users may need to do additional work on your page. Alert them to what the page needs by putting one of the following codes at the top of the page.

If the page mainly needs formatting work:

{{NeedsCleanup|comment=Insert your comment here}}

If the page mainly needs confirmation of information:

{{NeedsConfirm|comment=Insert your comment here}}

If the page is missing information:

{{NeedsContent|comment=Insert your comment here}}

If the page needs more serious help:

{{rewrite|comment=Insert your comment here}}

In all cases, use your comment to let future editors know what needs to be fixed. Please be specific so they know when they can remove the header.

Sorting

All sections sorted as shown. Any lists that don't have a special reason to be sorted otherwise should be sorted alphabetically.

Page Type Standards

Item Pages

Item pages should be formatted as such, containing the following elements as needed, in the order shown here.

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

Follow the link for information on coding and contents for each element.

Location Pages

Location pages should be formatted as such, containing the following elements as needed, in the order shown here.

Follow the link for information on coding and contents for each element.

Adventure Pages

Combat Adventure Pages

Combat adventure pages should contain the following elements in the order shown here.


Follow the link for information on coding and contents for each element.

Non-Combat Adventure Pages

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

Follow the link for information on coding and contents for each element.

Effect Pages

Effect pages should contain the following elements in the order shown here.

Follow the link for information on coding and contents for each element.

Skill Pages

Skill pages should contain the following elements in the order shown here.

Follow the link for information on coding and contents for each element.

Familiar Pages

Familiar pages should contain the following elements in the order shown here.

Follow the link for information on coding and contents for each element.

Outfit Pages

Skill pages should contain the following elements in the order shown here.

Follow the link for information on coding and contents for each element.

Trophy Pages

Trophy pages should contain the following elements in the order shown here.

Follow the link for information on coding and contents for each element.

Tattoo Pages

Tattoo pages should contain the following elements in the order shown here.

Follow the link for information on coding and contents for each element.

Data Pages

Established Standards
Adventures | Effects | Familiars | Items | Locations | Outfits | Skills | Tattoos | Trophies | Data