A KoL Wiki:Established Standards: Difference between revisions

From A KoL Wiki
← Older edit
imported>Alpaca
Added a ton of stuff. An absolute ton. The page is done for now.
m Update all namespaces
 
(80 intermediate revisions by 33 users not shown)
Line 1: Line 1:
{{Rewrite|comment=Needs new standards added as they are created.}}
__NOTOC__
__NOTOC__
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 [[Make a Wiki page|wiki editing]].
This page contains all formally established standards for creating and editing wiki pages. For standards that are not listed here, see [[A KoL Wiki:Proposed Standards|Proposed Standards]]. This page assumes a basic knowledge of [[Make a Wiki page|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:
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:
*[[Established Standards#Headings|Headings]]
*Information about KoL Standards
*[[Established Standards#Tables of Contents|Tables of Contents]]
**[[#Headings|Headings]]
*[[Established Standards#File names|File names]]
**[[#Tables of Contents|Tables of Contents]]
*[[Established Standards#Categories|Categories]]
**[[#File names|File names]]
*[[Established Standards#Item Pages|Item Pages]]
**[[#Categories|Categories]]
*[[Established Standards#Location Pages|Location Pages]]
**[[#Page Needs Work|Page Needs Work]]
*[[Established Standards#Non-Combat Adventure Pages|Non-Combat Adventure Pages]]
**[[#Page Type Standards|Page Type Standards]]
*[[Established Standards#Combat Adventure Pages|Combat Adventure Pages]]
***[[#Item Pages|Item Pages]]
*[[Established Standards#Effect Pages|Effect Pages]]
***[[#Location Pages|Location Pages]]
***[[#Adventure Pages|Adventure Pages]]
****[[#Combat Adventure Pages|Combat Adventure Pages]]
****[[#Non-Combat Adventure Pages|Non-Combat Adventure Pages]]
***[[#Effect Pages|Effect Pages]]
***[[#Skill Pages|Skill Pages]]
***[[#Familiar Pages|Familiar Pages]]
***[[#Outfit Pages|Outfit Pages]]
***[[#Trophy Pages|Trophy Pages]]
***[[#Tattoo Pages|Tattoo Pages]]
***[[#Data Pages|Data Pages]]


==Headings==
==Headings==
Line 19: Line 28:
  <nowiki>=A large and obnoxious heading=</nowiki>
  <nowiki>=A large and obnoxious heading=</nowiki>
yields:
yields:
<h1>A large and obnoxious heading</h1>
=A large and obnoxious heading=
Large and obnoxious, see?


==Tables of Contents==
==Tables of Contents==
Line 25: Line 35:
*If you do not wish for your page to have a table of contents, insert the following near the top of your document:
*If you do not wish for your page to have a table of contents, insert the following near the top of your document:
  <nowiki>__NOTOC__</nowiki>
  <nowiki>__NOTOC__</nowiki>
**Some pages, like correctly-templated item pages, do this automatically.
*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:
*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:
  <nowiki>__TOC__</nowiki>
  <nowiki>__TOC__</nowiki>
Line 31: Line 41:
==File names==
==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.
*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.
*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.
*In the unlikely event there really is a filename clash, please follow the procedure laid out [[A KoL Wiki:Filename issues table|here]].
 
* 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==
==Categories==
*Contemplated new Categories should be discussed in [http://kol.thraeryn.org/forum/index.php?c=5 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.
*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 [[A KoL Wiki:Proposed Standards|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 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:
* 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:
  <nowiki>[[Category:Food]]
  <nowiki>[[Category:Food]]
[[Category:Food (By Fullness)|6, hell ramen]]</nowiki>
[[Category:Food (By Fullness)|6, hell ramen]]</nowiki>
Line 44: Line 52:
The former simply categorizes Hell ramen as a food. The latter categorizes it as a food of six fullness.
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 <nowiki>[[Category:Adventure|Icy Peak, The]]</nowiki> 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]].
*For a complete list of categories, see [[Special:Categories]].


==Item Pages==
==Page Needs Work==
Item images should be formatted as such, '''IN THE ORDER SHOWN HEREIN''':
 
<h3>The basic item entry:</h3>
<h4>Headers</h4>
<nowiki>{{itemheader|image=lime.gif|item=lime}}</nowiki>
yields:
{{Itemheader|image=lime.gif|item=lime}}
 
<h4>Descriptions</h4>
Item descriptions are to be typed out fully, in normal text, one line under the header:
 
{{Itemheader|image=lime.gif|item=lime}}
This is a lime. Like a lemon, it's shaped like a lemon. Unlike a lemon, it's a lime.
 
<h4>Basic Item Information</h4>
Follow the Kingdom's template for bolding, capitalization, and punctuation closely.
 
<nowiki>(Cooking ingredient)<br />
(Cocktailcrafting ingredient)<br />
Type: '''food'''<br />
Selling Price: '''60 Meat'''.</nowiki>
 
yields:
 
{{Itemheader|image=lime.gif|item=lime}}
This is a lime. Like a lemon, it's shaped like a lemon. Unlike a lemon, it's a lime.
 
(Cooking ingredient)<br />
(Cocktailcrafting ingredient)<br />
Type: '''food'''<br />
Selling Price: '''60 Meat'''.
 
'''Note: The rest of our lime example is hypothetical, and does not reflect the true nature of the [[lime]].'''
 
<h4>Enchantment</h4>
 
<nowiki>{{enchantment|enchantment=Scurvy Resistance}}</nowiki>
 
yields:
 
{{Itemheader|image=lime.gif|item=lime}}
This is a lime. Like a lemon, it's shaped like a lemon. Unlike a lemon, it's a lime.
 
(Cooking ingredient)<br />
(Cocktailcrafting ingredient)<br />
Type: '''food'''<br />
Selling Price: '''60 Meat'''.
 
{{enchantment|enchantment=Scurvy Resistance}}
 
<h3>Other information</h3>
We now move away from the copy of the Kingdom's item description. The following elements should be in the order described below:
 
<h4>Drop location</h4>
 
<nowiki>==Drop Location==
*[[The Misspelled Cemetary]]
*[[The Icy Peak]]</nowiki>
 
yields:
 
*[[The Misspelled Cemetary]]
*[[The Icy Peak]]
 
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.
 
<h4>Recipes</h4>
 
<nowiki>==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>
</nowiki>
 
yields:
 
<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>
 
To enter the nifty icons into a table, use these templates:<BR>
'''Basic Recipe Types'''
*{{combine}}: [[template:combine]], <nowiki>{{combine}}</nowiki>
*{{cook}}: [[template:cook]], <nowiki>{{cook}}</nowiki>
*{{cocktail}}: [[template:cocktail]], <nowiki>{{cocktail}}</nowiki>
*{{smith}}: [[template:smith]], <nowiki>{{smith}}</nowiki>
*{{jewelry}}: [[template:jewelry]], <nowiki>{{jewelry}}</nowiki>
'''Special skills'''
*{{pasta}}: [[template:pasta]], <nowiki>{{pasta}}</nowiki>
*{{sauce}}: [[template:sauce]], <nowiki>{{sauce}}</nowiki>
*{{advcocktail}}: [[template:advcocktail]], <nowiki>{{advcocktail}}</nowiki>
*{{armorcraft}}: [[template:armorcraft]], <nowiki>{{armorcraft}}</nowiki>
*{{supersmith}}: [[template:supersmith]], <nowiki>{{supersmith}}</nowiki>
'''Other'''
*{{supertinker}} [[template:supertinker]], <nowiki>{{supertinker}}</nowiki>
*{{starcombo}} [[template:starcombo]], <nowiki>{{starcombo}}</nowiki>
*{{pixel}} [[template:pixel]], <nowiki>{{pixel}}</nowiki>
*{{equals}} [[template:equals]], <nowiki>{{equals}}</nowiki>
 
*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.
 
<h4>When Consumed/Used</h4>
 
For food and booze, use when consumed. For usable items, use when used.
 
<nowiki>==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!}}</nowiki>
 
yields:
 
{{Food|full=2|adv=2-5|mus=gain 5-15|mys=gain 5-15|mox=gain 5-15|text=You eat the lime. Limetastic!}}
 
<nowiki>==When Consumed==
{{Booze|drunk=3|adv=3|mus=gain no|mys=gain no|mox=gain no|text=You drink the lime. Limetastic!}}</nowiki>
 
yields:
 
{{Booze|drunk=3|adv=3|mus=gain no|mys=gain no|mox=gain no|text=You drink the lime. Limetasitc!}}


<nowiki>==When Used==
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.
*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></nowiki>


yields:
If the page mainly needs formatting work:
   
  <nowiki>{{NeedsCleanup|comment=Insert your comment here}}</nowiki>
*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>


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.
If the page mainly needs confirmation of information:
<nowiki>{{NeedsConfirm|comment=Insert your comment here}}</nowiki>


<h4>Uses</h4>
If the page is missing information:
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.
  <nowiki>{{NeedsContent|comment=Insert your comment here}}</nowiki>
  <nowiki>==Uses==
*[[Jarlsberg's key lime pie]]
*[[Boris's key lime pie]]
*[[Sneaky pete's key lime pie]]</nowiki>


yields:
If the page needs more serious help:
<nowiki>{{rewrite|comment=Insert your comment here}}</nowiki>


*[[Jarlsberg's key lime pie]]
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.
*[[Boris's key lime pie]]
*[[Sneaky pete's key lime pie]]


Always put a bullet, and always link the item.
==Sorting==
All sections sorted ''as shown''. Any lists that don't have a special reason to be sorted otherwise should be sorted alphabetically.


<h4>Zapping</h4>
==Page Type Standards==
<nowiki>==Zapping==
{{ZAP lime}}</nowiki>


yields:
===[[A KoL Wiki:Established Standards/Item Pages|Item Pages]]===
Item pages should be formatted as such, containing the following elements as needed, in the order shown here.


{{ZAP lime}}
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 (1-Be)|Items by Name]] and [[Items by autosell price (1-25 Meat)|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.
 
Just include the item's zapping template, if applicable. It should already exist. If it doesn't, make it, rather than filling in the [[Template:ZAP tgen|generic template]].
<h4>References</h4>
<nowiki>==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]]</nowiki>
 
yields:
 
*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]].
 
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:Wikipedia|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 <nowiki><blockquote></blockquote></nowiki>, but this should not be used often.
 
<h4>Notes</h4>
The notes section contains any information that doesn't fit into any of the above sections.
 
<nowiki>==Notes==
*This lime variant does not exist.</nowiki>
 
yields:
 
*This lime variant does not exist.
 
Once again, always use a bullet, as more information may be added.
 
<h4>See Also</h4>
This section contains any links '''within''' the wiki that relate directly to the item, but don't fall into one of the above categories.
 
<nowiki>==See Also==
*[[lime]]</nowiki>
 
yields:


*[[lime]]
*[[A KoL Wiki:Established Standards/Item Pages#The Basic Item Entry|The Basic Item Entry]]
*[[A KoL Wiki:Established Standards/Item Pages#Other Information|Other Information]]
**[[A KoL Wiki:Established Standards/Item Pages#ItemDrop|Drop Location(s)]]
**[[A KoL Wiki:Established Standards/Item Pages#ItemRecipe|Recipe]]
**[[A KoL Wiki:Established Standards/Item Pages#ItemUsed|When Consumed/Used]]
**[[A KoL Wiki:Established Standards/Item Pages#ItemUses|Uses]]
**[[A KoL Wiki:Established Standards/Item Pages#ItemNotes|Notes]]
**[[A KoL Wiki:Established Standards/Item Pages#ItemHistory|History]]
**[[A KoL Wiki:Established Standards/Item Pages#Messages|Messages]]
**[[A KoL Wiki:Established Standards/Item Pages#ItemRefs|References]]
**[[A KoL Wiki:Established Standards/Item Pages#ItemSeeA|See Also]]
**[[A KoL Wiki:Established Standards/Item Pages#ItemZap|Zapping]]
**[[A KoL Wiki:Established Standards/Item Pages#ItemColl|Collection]]
**[[A KoL Wiki:Established Standards/Item Pages#ItemNav|Navigational Templates]]
**[[A KoL Wiki:Established Standards/Item Pages#Categorization|Categorization]]


As with almost every other section, use a bullet.
Follow the link for information on coding and contents for each element.


==Location Pages==
===[[A KoL Wiki:Established Standards/Location Pages|Location Pages]]===
The following template is for pages outlining a specific location.
Location pages should be formatted as such, containing the following elements as needed, in the order shown here.
*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:
*[[A KoL Wiki:Established Standards/Location Pages#Basic Information|Basic Information]]
*[[A KoL Wiki:Established Standards/Location Pages#Adventure Templates|Adventure Templates]]
**[[A KoL Wiki:Established Standards/Location Pages#Combat Adventure Template|Combat Adventure Template]]
**[[A KoL Wiki:Established Standards/Location Pages#Non-combat Adventure Template|Non-combat Adventure Template]]
*[[A KoL Wiki:Established Standards/Location Pages#Other Information|Other Information]]
*[[A KoL Wiki:Established Standards/Location Pages#Category|Category]]


<nowiki>{{Adventure|name=Sabre-toothed_lime|drops=[[lime]], [[Lime|totally different lime]]|meat=13-16|stat=2-3|image=biglime.gif}}</nowiki>
Follow the link for information on coding and contents for each element.
*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:
===[[A KoL Wiki:Established Standards/Adventure Pages|Adventure Pages]]===


{{Adventure|name=Limetastic!|drops=[[lime]], [[Lime|totally different lime]]|meat=83|stat=27|image=biglime.gif}}
====Combat Adventure Pages====


==Non-Combat Adventure Pages==
Combat adventure pages should contain the following elements in the order shown here.
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 <nowiki>(Wikicode: ----)</nowiki> 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==
<h3>Header</h3>
Begin with the following template:
<nowiki>{{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.}}</nowiki>


*Image is the monster's image, uploaded to the wiki with the same filename as in the Kingdom.
*[[A KoL Wiki:Established Standards/Adventure Pages#CombatHeader|Header]]
*A is the monster's [[Wikipedia:Article (grammar)|article]] - are you fighting '''a''' monster, '''an''' annoying monster?
*[[A KoL Wiki:Established Standards/Adventure Pages#CombatAttackM|Attack Messages]]
*Name is the monster's name.
*[[A KoL Wiki:Established Standards/Adventure Pages#CombatSpoils|Spoils of War]]
*Text is the monster's description, as it appears in the Kingdom.
*[[A KoL Wiki:Established Standards/Adventure Pages#CombatOtherI|Other Information]]
**Link to Location
**Notes, References, See Also


Our above example would yield:
Follow the link for information on coding and contents for each element.


{{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.}}
====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:


<h3>Attack Messages</h3>
*[[A KoL Wiki:Established Standards/Adventure Pages#NoncomHeader|Header]]
*[[A KoL Wiki:Established Standards/Adventure Pages#NoncomContent|Content]]
*[[A KoL Wiki:Established Standards/Adventure Pages#NoncomOtherI|Other Information]]


*Center all messages.
Follow the link for information on coding and contents for each element.
**If a monster hits you or tries to hit you in a body part, use the following syntax:
<nowiki>{{part}}</nowiki>


Which yields:
===[[A KoL Wiki:Established Standards/Effect Pages|Effect Pages]]===


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


*List successful attack messages first.
*[[A KoL Wiki:Established Standards/Effect Pages#EffectsHeader|Header]]
**Follow these up with the following syntax:
*[[A KoL Wiki:Established Standards/Effect Pages#EffectsObtained|Obtained From]]
<nowiki>'''<span style="color: red;">Eek! Oof! Ugh!</span>'''</nowiki>
*[[A KoL Wiki:Established Standards/Effect Pages#EffectsOtherI|Other Information]]
*[[A KoL Wiki:Established Standards/Effect Pages#EffectsCategory|Category]]


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


'''<span style="color: red;">Eek! Oof! Ugh!</span>'''
===[[A KoL Wiki:Established Standards/Skill Pages|Skill Pages]]===


You may replace the three exclamations with others of your choice from the Kingdom.
Skill pages should contain the following elements in the order shown here.


*If a monster misses, write that message down under the successful hit messages.
*[[A KoL Wiki:Established Standards/Skill Pages#SkillHeader|Header]]
*[[A KoL Wiki:Established Standards/Skill Pages#SkillOtherI|Other Information]]
*[[A KoL Wiki:Established Standards/Skill Pages#SkillCategory|Category]]


<h3>Spoils of War</h3>
Follow the link for information on coding and contents for each element.


*List the rewards in the order in which they appear in the Kingdom.
===[[A KoL Wiki:Established Standards/Familiar Pages|Familiar Pages]]===
*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.
**Use the [[Template:Substat|substat template]] for substats.


<nowiki><center>[[image:meat.gif|Meat]] You gain 160-240 Meat.
Familiar pages should contain the following elements in the order shown here.


[[image:lime.gif|lime]] You acquire an item: '''[[lime]]'''<br />
*[[A KoL Wiki:Established Standards/Familiar Pages#Header|Header]]
[[image:lime.gif|lime]] You acquire an item: '''[[lime]]'''
*[[A KoL Wiki:Established Standards/Familiar Pages#Combat Messages|Combat Messages]]
*[[A KoL Wiki:Established Standards/Familiar Pages#Other Information|Other Information]]
*[[A KoL Wiki:Established Standards/Familiar Pages#Category|Category]]


You gain 18-21 {{substat}}</center></nowiki>
Follow the link for information on coding and contents for each element.


Yields:
===[[A KoL Wiki:Established Standards/Outfit Pages|Outfit Pages]]===


<center>[[image:meat.gif|Meat]] You gain 160-240 Meat.
Outfit pages should contain the following elements in the order shown here.


[[image:lime.gif|lime]] You acquire an item: '''[[lime]]'''<br />
*[[A KoL Wiki:Established Standards/Outfit Pages#OutfitHeader|Header]]
[[image:lime.gif|lime]] You acquire an item: '''[[lime]]'''
*[[A KoL Wiki:Established Standards/Outfit Pages#OutfitOtherI|Other Information]]
*[[A KoL Wiki:Established Standards/Outfit Pages#OutfitCategory|Category]]


You gain 18-21 {{substat}}</center>
Follow the link for information on coding and contents for each element.


==Effect Pages==
===[[A KoL Wiki:Established Standards/Trophy Pages|Trophy Pages]]===
<h3>Header</h3>
Use the following template:
<nowiki>{{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}}</nowiki>


*Name is the name of the effect.
Trophy pages should contain the following elements in the order shown here.
*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:
*[[A KoL Wiki:Established Standards/Trophy Pages#TrophyHeader|Header]]
*[[A KoL Wiki:Established Standards/Trophy Pages#TrophyOtherI|Other Information]]
*[[A KoL Wiki:Established Standards/Trophy Pages#TrophyCategory|Category]]


{{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 to All Stats}}
Follow the link for information on coding and contents for each element.


<h3>Obtained From</h3>
===[[A KoL Wiki:Established Standards/Tattoo Pages|Tattoo Pages]]===


*List and wikilink the source of the effect.
Tattoo pages should contain the following elements in the order shown here.


<nowiki>==Obtained From==
*[[A KoL Wiki:Established Standards/Tattoo Pages#TattooHeader|Header]]
*[[Lime]]</nowiki>
*[[A KoL Wiki:Established Standards/Tattoo Pages#TattooOtherI|Other Information]]
*[[A KoL Wiki:Established Standards/Tattoo Pages#TattooCategory|Category]]


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


*[[Lime]]
===[[A KoL Wiki:Established Standards/Data Pages|Data Pages]]===
*[[A KoL Wiki:Established Standards/Data Pages#Combat Data Pages|Combat Data Pages]]
*[[A KoL Wiki:Established Standards/Data Pages#Effect Data Pages|Effect Data Pages]]
*[[A KoL Wiki:Established Standards/Data Pages#Item Data Pages|Item Data Pages]]
*[[A KoL Wiki:Established Standards/Data Pages#Location Data Pages|Location Data Pages]]


As always, bullet.
{{StandardsNav}}


<h3>Other Information</h3>
[[Category:Established Standards|*]]
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.
[[Category:Help]]

Latest revision as of 21:37, 4 September 2025

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

Outfit 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
Retrieved from "https://wiki.kingdomofloathing.com/index.php?title=A_KoL_Wiki:Established_Standards&oldid=730741"