Help:Contents: Difference between revisions

From A KoL Wiki
imported>JRSiebz
m added link to Special:Templates, w00t!
imported>Moonshoesmcbango
m Image was broken, replaced with functional one; corrected description of button location
 
(79 intermediate revisions by 27 users not shown)
Line 1: Line 1:
Looking for help?  We need some simple starter files to go in here.
Attn: New Wiki Editors. <span style="color:red;">Please read this page and all mentioned pages ''carefully''.</span>


For now, I've grabbed some info from Wikipedia and put it here:
For assistance playing the [http://www.kingdomofloathing.com/ Kingdom of Loathing] see [[:Category:Basics|Basics]].
How to [[make a Wiki page]]


Note:  When editing pages always fill in the "Summary" textbox saying what you did, it makes it easier to understand and navigate through a pages history. Before editng pages, look over the [[make a Wiki page]] so you understand the wiki's syntax, and as always, for KoL specific items, adventures, monsters, etc., look over the [[Proposed Standards]].  Feel free to test things out in the [[Sandbox]] or in your profile. Also, never end a page name with a period!
*Before editing pages, look over the [[make a Wiki page]] so you understand the wiki's syntax, and as always, for KoL specific items, adventures, monsters, etc., look over the [[TheKolWiki:Established Standards|Established Standards]] and its accompanying [[TheKolWiki:Proposed Standards|Proposed Standards]].
**See the mediawiki [http://www.mediawiki.org/wiki/Markup_spec markup spec] for a quick and comprehensive view of a mediawiki's syntax.
*Do not update the amount of adventures gained from food if you are born under [[The Opossum]] or are affected by [[Got Milk]] or have used a [[munchies pill]].
*Do not update the amount of adventures gained from booze if you are born under [[The Blender]] or are affected by the [[Ode to Booze]] or are wearing a [[tuxedo shirt]].
*Do not update the stats gained if it is a [[Stat Days|Stat Day]], if you have any effects active or items equipped that affect the [[Stat Gains from Fights]] or alter [[Monster Level]], and if you are using any [[Blood-Faced Volleyball|volleyball-type]] or [[Hovering Sombrero|sombrero-type]] [[:Category:familiars|familiar]].
*Do not update the stats gained until you take into account your [[Moon sign]] stat bonus.
*Do not add messages resulting from acquiring [[eleven|11]], [[twenty-three|23]], or [[thirty-seven|37]] of an item at once.
*If you want to add a Cultural Reference to a page, please review how to make a complete and useful one in the [[Established Standards: Item Pages#References|References section of the Established Standards]].
*When editing pages '''always''' fill in the "Summary" textbox saying what you did, it makes it easier for others to understand and navigate through a page's history.
*When editing a page, always use the button to preview the page before saving. That way, you have a second chance to look for and fix problems in the page before saving it. This is '''much''' better than saving a page multiple times for a few trivial edits in a short period of time.
*Always sign your comments when posting in talk pages. See [[#How to Post in Discussions/Talk Pages|below]] for more details.
*Mark a page for deletion, or for discussion about being deleted in [[TheKolWiki:Pages for deletion]].
*Please post in/start a [[discussion]] somewhere before initiating large scale changes on your own.
*Do not link to a page which redirects to another page. This is called a "double redirect". Link to the terminal page directly instead.
*Never put a page which is in the User namespace (starting with "User:") into the Player category!
*Feel free to test things out in the [[TheKolWiki:Sandbox|sandbox]] or in your User: page.
*Use the Talk: page for a page before making major changes to that page.


__TOC__
==How to Post in Discussions/Talk Pages==
*If you would like to view a page's associated "Talk page", click on its "Discussion" tab.
*It is customary to use bullets (<code>*</code> in wiki syntax) and indents (<code>:</code> in wiki syntax) to post in/under an ongoing discussion. When using nested bullets and indents, place your post ''on the line directly after'' the previous one for it to indent right. Although blank lines look good in the wiki source, they can mess up the final formatting.
*'''Always''' sign your posts by appending <code><nowiki>--~~~~</nowiki></code> to the end. That is four (4) tildes (~). With only three tildes, the signature will lack a date; with five, it will lack a name.
*:When the page is saved it will translate to to wiki code as <code><nowiki>--[[User:Jinya|jin]] TIME, DATE (TIMEZONE)</nowiki></code>.  Viewing it yields --[[User:Jinya|jin]] TIME, DATE (TIMEZONE), if your username were Jinya and your nickname jin.
*:The third button on the edit toolbar adds this signature automatically. It looks like this: [[File:Signaturetimestampbutton.png|frameless]]
*:When encountering an unsigned comment, there is a template you can use to attribute that comment: <code><nowiki>{{unsigned|Editor Name|edit date}}</nowiki></code> will add a block of text that says "{{unsigned|Editor Name|edit date}}".
*You can customize your timestamp in your [[Special:Preferences|Preferences]] by altering the textbox labeled "Nickname:". You're free to use wiki code in your signature, but please try to stay reasonable. Checking the box labeled "Raw signatures (without automatic link)" makes your signature translate to <code>--NICKNAME TIME, DATE (TIMEZONE)</code> allowing for a little freedom when choosing your signature.<br /><br />For more on nicknames [[MetaWikipedia:Help:Preferences#Signature|further documentation]] is available.
*Do not just randomly create discussions above other discussions. They should flow chronologically with recent discussions towards the bottom. Also, editing or deleting other people's comments is generally not allowed, although discussions may be archived. Your own "User Talk:" page is an exception.


__TOC__
==Marking Pages That Need Work==
*To mark a page that needs work, place <code><nowiki>{{</nowiki>[[Template:Rewrite|rewrite]]|comment=A comment on what needs work goes here.}}</code>. Using this template will automatically add the appropriate page to the [[:Category:Needs Work|Needs Work Category]]. Not marking unfinished/incomplete/nonformatted pages as ''Needs Work'' delays their completion, because of lack of attention. Instead of using the general <code>{{tl|rewrite}}</code> template, <code>{{tl|NeedsConfirm}}</code>, <code>{{tl|NeedsContent}}</code>, and <code>{{tl|NeedsCleanup}}</code> can be used to provide more specific "Needs Work" messages, working the same way as the first. In addition, feel free to place <code>{{tl|NeedsReview}}</code> by references that need review and then comment on that page's talk page as to why that reference needs review.
 
==Using the Clan Template==
*Use the following template <code><nowiki>{{clan|clan=CLAN NAME|link=CLAN LINK}}</nowiki></code>, where CLAN NAME is the name of a clan, spaces are allowed. CLAN LINK is a standard web link (<nowiki>http://www.server.com/dir/</nowiki>) which can be to a clan's web site, forums, etc. If one does not want to specify a link, the link variable may be omitted.
 
*For more information, see the [[Template:Clan|template itself]].


==Creating a Player Page==
*Clans may be listed in the [[Clan Directory]].
*Either create a new page by following a link to the uncreated player page, or manually go to <nowiki>http://kol.thraeryn.org/wiki/PLAYER_NAME</nowiki>, where PLAYER_NAME is the KoL player name with underscores replacing spaces.
*Edit the page from the edit tab, adding whatever content you so desire.  Don't forget to save the page.


===Adding a Player Page to the List of KoL Players===
==Linking==
*Use following category <nowiki>[[Category:Player]]</nowiki> to add a player page to the playercategory which lists KoL players.
*The first letter of all pages is automatically capitalized by the wiki.
*Note: Do not add <nowiki>[[Category:Player]]</nowiki> to a wiki user page, such as User:PLAYER_NAME. It will add the page User:PLAYER_NAME to the kol player categories, and that is very undesirable and leads to having a seasoned wiki editor grudgingly come and fix it for you. What you can do is to forward your User:PLAYER_NAME page to the PLAYER_NAME Kol character page. See the next section for details.  Don't forget to save the page.
*When linking to a page the case of the first letter does not matter, because the wiki knows all pages start with a capital letter. For example, <code><nowiki>[[Goat]]</nowiki></code> ([[Goat]]) and <code><nowiki>[[goat]]</nowiki></code> ([[goat]]) both link to the same page. Using the lowercase link is useful when linking to a page in mid-sentence. Try not to link pages to pages using inappropriate capitalization. If an item's name is lowercase (and most of them are), use lowercase.
*Wiki links and page names are case-sensitive on all characters besides the first. For example, <code><nowiki>[[Pet Rock]]</nowiki></code> ([[Pet Rock]]) and <code><nowiki>[[pet Rock]]</nowiki></code> ([[pet Rock]]) link to the same page, whilst <code><nowiki>[[Pet Rock]]</nowiki></code> ([[Pet Rock]]) and <code><nowiki>[[pet rock]]</nowiki></code> ([[pet rock]]) do not.
*Try not to link to a page using <code><nowiki>[</nowiki>{{fullurle:Main Page}}]</code> or even <code><nowiki>[</nowiki>{{fullurle:MetaWikipedia:Main Page}} Meta Main Page]</code>. Instead, use <code><nowiki>[[Main Page]]</nowiki></code>, and <code><nowiki>[[MetaWikipedia:Main Page|]]</nowiki></code>
*This is an intrawiki link: <code><nowiki>[[Page Name]]</nowiki></code>. Link directly to the page name; no need for _ or escaped characters (%20, etc). The wiki parser uses the page name to check if it exists anyways. No need trying to help it escape characters.
*This is an interwiki link: <code><nowiki>This item references [[Wikipedia:duck|]]s</nowiki></code>. An [[MetaWikipedia:Interwiki map|interwiki map]] can be found here. As a matter of style of consistency avoid escaping page names here too.
*Always link to the page you mean, not a redirect.
*Name links with pipes: <code><nowiki>[[hell ramen|my favorite food]]</nowiki></code> ([[hell ramen|my favorite food]]).
*Removing a namespace such as Template: or Wikipedia: from a link's name is easy as adding a pipe (<code>|</code>): <code><nowiki>[[wikipedia:ramen|]]</nowiki></code> ([[wikipedia:ramen|ramen]]).
*Removing a post-fixed disambiguation such as (familiar) or (effect) from a link's name is done in the same way: add a pipe (<code>|</code>): <code><nowiki>[[Barrrnacle (familiar)|]]</nowiki></code> ([[Barrrnacle (familiar)|Barrrnacle]]).
*Appending a string of letters to the end of a link's name is done as follows: <code><nowiki>[[Mosquito]]es</nowiki></code> ([[Mosquito]]es).
*To link to a section of a wiki page use an anchor <code>#</code>.
**Linking to a section within a page: <code><nowiki>[[#Linking]]</nowiki></code> ([[#Linking]]).
**Linking to a section on another page: <code><nowiki>[[Help:Contents#Linking]]</nowiki></code> ([[Help:Contents#Linking]]).
*Also, one specific TheKolWiki bit of neatness, use the plural template to automatically look up the in-game plural for items: <code><nowiki>{{plural|seal tooth}}</nowiki></code> yeilds {{plural|seal tooth}}.


===Forwarding a Wiki User Page to a KoL Player Page===
==Category Sorting==
*First, create a KoL player page using the above section.
*Pages within a category are sorted not alphabetically, but by their [[Wikipedia:ASCII|ASCII]] value, which is case sensitive.
*Now, open and edit you wiki user page, User:PLAYER_NAME, to redirect all traffic from coming to this User page to you player page, empty all text in the page and add only the text <nowiki>#REDIRECT [[PLAYER NAME]]</nowiki>, where PLAYER NAME is the KoL player page. Spaces are allowed: All spaces between the brackets will be read as underscores.  Wiki page names do not have spaces in them.  Now only one profile page has to be kept up to date.  Don't forget to save the page.


===Forwarding Player Page Discussion to a Wiki User Page Discussion===
{| cellspacing=5 cellpadding=5 style="border:1px solid black; background:silver; margin-left:1em"
*You may want to forward the player talk: page to the User talk: page.  Talk is a fancy way of leaving comments about a page (in this case player), or having a related discussion.  You can view or add to a pages discussion by clicking on the "Discussion" tab next to a pages "Edit" tab.  Wiki users are notified by the wiki when new talk shows up on their User talk: page, so it would just make sense to have the KoL Player page talk redirected there. To forward all new KoL Player talk to the wiki User Talk: page, open and edit the kol player talk page, Talk:PLAYER_NAME, and add only the text <nowiki>#REDIRECT [[User talk:PLAYER NAME]]</nowiki>, where PLAYER NAME is the wiki user name.  Now there will be only one talk page for PLAYER_NAME/User:PLAYER NAME, and the wiki user will be notfied of new discussion added.  Don't forget to save the page.
!Alphabetical Ordering !! ASCII Ordering
|- style="background:white"
|style="border:1px solid black;"|cherry<br />Grapes<br />lemon<br />Lime<br />olive<br />Orange
|style="border:1px solid black;"|Grapes<br />Lime<br />Orange<br />cherry<br />lemon<br />olive
|}


===Adding a Player Page to a Clan===
*When a page is placed in a category by using <nowiki>[[Category:CATEGORY_NAME]]</nowiki>, the default sort is by page name.
*Use the following template <nowiki>{{clan|clan=CLAN NAME}}</nowiki>, where CLAN NAME is the name of a clan, spaces are allowed.  After you save the page, you can follow the created wiki link to the clans page, which you can then view, edit, or create if it does not yet exist.
*You can override how the page is sorted by using <nowiki>[[Category:CATEGORY_NAME|SORT_AS]]</nowiki>, where SORT_AS is how you wish to have the page sorted within the category. An example of this is the [[:Category:Food (By Size)|Food By Size category]]. [[Hell ramen]] should not be sorted under "H", but under "6", so the category link should look like: <code><nowiki>[[Category:Food (By Size)|6, hell ramen]]</nowiki></code>.


==Creating a Clan Page==
==Wiki Parser==
*Either create a new page by following a link to the uncreated clan page, or manually go to <nowiki>http://kol.thraeryn.org/wiki/CLAN_NAME</nowiki>, where CLAN_NAME is the KoL player name with underscores replacing spaces.
The wiki [[Wikipedia:Parsing|parser]] is the internal wiki functionality which takes editor created pages and transforms them into the html web pages which are displayed. The parser will transform wiki functions – like images (<nowiki> [[file:image.gif|text]] </nowiki>), templates (<nowiki> {{template_name}} </nowiki>), headings (<nowiki> ==Heading== </nowiki>), etc. – into the appropriate html. The wiki also parses normal html formatting and tables within a wiki page.
*Edit the page from the edit tab, adding whatever content you so desire.
*The wiki parser may add extra spacing depending on white space. The wiki parser may either add a line break <nowiki><br /></nowiki> or create a new paragraph <nowiki><p></p></nowiki>.
*To add the clan to the categorical list of all clan, add <nowiki>[[Category:Clans]]</nowiki> to the end of the page. If the clan starts with a "a" or "the", you may want to add a sort term to the clan.  Defaultly, when page is added to a category, it is sorted by the page name, but if the clan starts with "the", the clan probably should not be listed under T for "the". To change where the clan is listed under the category add the following <nowiki>[[Category:Clans|SORT BY]]</nowiki> where SORT BY is what the clan will be listed under.  For example, <nowiki>[[Category:Clans|Kingdom of Loathing, The]]</nowiki> on a page named "The Kingdom of Loathing" would list "The Kingdom of Loathing" on the clan page under "K", instead of "T".  It does not change the name displayed, only how the list is sorted. As always, Don't forget to save the page.
*Avoid using center tags within lists (bulleted, numbered, etc.); they seem to break the html within the page. If necessary, put a couple carriage returns before and after what needs to be centered in a list. <code><nowiki><br /></nowiki></code> won't cut it.


==Useful References==
==Useful References==
*[[Proposed Standards]] - Proposed standards for all KoL type entries.
*[[Proposed Standards]] Proposed standards for all KoL type entries.
*[[Make a Wiki page|Make a Wiki Page]] - Demonstrates wiki syntax.
*[[Make a Wiki page]] – Demonstrates wiki syntax.
*[[Special:Specialpages|Special Pages]] - List of all special pages, including Unused Images, Most Wanted Pages (pages linked to but not created), Uncategorized Pages, etc.
*[[MetaWikipedia:Help:Contents|Wikimedia Help]] – Demonstrates wiki syntax.
*[[Special:Categories|Categories]] - List of all available Categories.
*[http://www.mediawiki.org/wiki/Markup_spec Mediawiki Markup Spec] Demonstrates wiki syntax.
*[[Special:Templates|Templates]] - List of all available Templates.
*[[Special:Specialpages|Special Pages]] List of all special pages, including Unused Images, Most Wanted Pages (pages linked to but not created), Uncategorized Pages, etc.
 
*[[Special:Categories|Categories]] List of all available Categories.
*[[:Category:Templates|Templates]] List of all available Templates.


[[Category:Help]]
[[Category:Help]]

Latest revision as of 02:00, 26 January 2021

Attn: New Wiki Editors. Please read this page and all mentioned pages carefully.

For assistance playing the Kingdom of Loathing see Basics.

  • Before editing pages, look over the make a Wiki page so you understand the wiki's syntax, and as always, for KoL specific items, adventures, monsters, etc., look over the Established Standards and its accompanying Proposed Standards.
    • See the mediawiki markup spec for a quick and comprehensive view of a mediawiki's syntax.
  • Do not update the amount of adventures gained from food if you are born under The Opossum or are affected by Got Milk or have used a munchies pill.
  • Do not update the amount of adventures gained from booze if you are born under The Blender or are affected by the Ode to Booze or are wearing a tuxedo shirt.
  • Do not update the stats gained if it is a Stat Day, if you have any effects active or items equipped that affect the Stat Gains from Fights or alter Monster Level, and if you are using any volleyball-type or sombrero-type familiar.
  • Do not update the stats gained until you take into account your Moon sign stat bonus.
  • Do not add messages resulting from acquiring 11, 23, or 37 of an item at once.
  • If you want to add a Cultural Reference to a page, please review how to make a complete and useful one in the References section of the Established Standards.
  • When editing pages always fill in the "Summary" textbox saying what you did, it makes it easier for others to understand and navigate through a page's history.
  • When editing a page, always use the button to preview the page before saving. That way, you have a second chance to look for and fix problems in the page before saving it. This is much better than saving a page multiple times for a few trivial edits in a short period of time.
  • Always sign your comments when posting in talk pages. See below for more details.
  • Mark a page for deletion, or for discussion about being deleted in TheKolWiki:Pages for deletion.
  • Please post in/start a discussion somewhere before initiating large scale changes on your own.
  • Do not link to a page which redirects to another page. This is called a "double redirect". Link to the terminal page directly instead.
  • Never put a page which is in the User namespace (starting with "User:") into the Player category!
  • Feel free to test things out in the sandbox or in your User: page.
  • Use the Talk: page for a page before making major changes to that page.

How to Post in Discussions/Talk Pages

  • If you would like to view a page's associated "Talk page", click on its "Discussion" tab.
  • It is customary to use bullets (* in wiki syntax) and indents (: in wiki syntax) to post in/under an ongoing discussion. When using nested bullets and indents, place your post on the line directly after the previous one for it to indent right. Although blank lines look good in the wiki source, they can mess up the final formatting.
  • Always sign your posts by appending --~~~~ to the end. That is four (4) tildes (~). With only three tildes, the signature will lack a date; with five, it will lack a name.
    When the page is saved it will translate to to wiki code as --[[User:Jinya|jin]] TIME, DATE (TIMEZONE). Viewing it yields --jin TIME, DATE (TIMEZONE), if your username were Jinya and your nickname jin.
    The third button on the edit toolbar adds this signature automatically. It looks like this:
    When encountering an unsigned comment, there is a template you can use to attribute that comment: {{unsigned|Editor Name|edit date}} will add a block of text that says "—Preceding unsigned comment added by Editor Name (talkcontribs) on edit date".
  • You can customize your timestamp in your Preferences by altering the textbox labeled "Nickname:". You're free to use wiki code in your signature, but please try to stay reasonable. Checking the box labeled "Raw signatures (without automatic link)" makes your signature translate to --NICKNAME TIME, DATE (TIMEZONE) allowing for a little freedom when choosing your signature.

    For more on nicknames further documentation is available.
  • Do not just randomly create discussions above other discussions. They should flow chronologically with recent discussions towards the bottom. Also, editing or deleting other people's comments is generally not allowed, although discussions may be archived. Your own "User Talk:" page is an exception.

Marking Pages That Need Work

  • To mark a page that needs work, place {{rewrite|comment=A comment on what needs work goes here.}}. Using this template will automatically add the appropriate page to the Needs Work Category. Not marking unfinished/incomplete/nonformatted pages as Needs Work delays their completion, because of lack of attention. Instead of using the general {{rewrite}} template, {{NeedsConfirm}}, {{NeedsContent}}, and {{NeedsCleanup}} can be used to provide more specific "Needs Work" messages, working the same way as the first. In addition, feel free to place {{NeedsReview}} by references that need review and then comment on that page's talk page as to why that reference needs review.

Using the Clan Template

  • Use the following template {{clan|clan=CLAN NAME|link=CLAN LINK}}, where CLAN NAME is the name of a clan, spaces are allowed. CLAN LINK is a standard web link (http://www.server.com/dir/) which can be to a clan's web site, forums, etc. If one does not want to specify a link, the link variable may be omitted.

Linking

  • The first letter of all pages is automatically capitalized by the wiki.
  • When linking to a page the case of the first letter does not matter, because the wiki knows all pages start with a capital letter. For example, [[Goat]] (Goat) and [[goat]] (goat) both link to the same page. Using the lowercase link is useful when linking to a page in mid-sentence. Try not to link pages to pages using inappropriate capitalization. If an item's name is lowercase (and most of them are), use lowercase.
  • Wiki links and page names are case-sensitive on all characters besides the first. For example, [[Pet Rock]] (Pet Rock) and [[pet Rock]] (pet Rock) link to the same page, whilst [[Pet Rock]] (Pet Rock) and [[pet rock]] (pet rock) do not.
  • Try not to link to a page using [https://wiki.kingdomofloathing.com/Main_Page] or even [https://wiki.kingdomofloathing.com/MetaWikipedia:Main_Page Meta Main Page]. Instead, use [[Main Page]], and [[MetaWikipedia:Main Page|]]
  • This is an intrawiki link: [[Page Name]]. Link directly to the page name; no need for _ or escaped characters (%20, etc). The wiki parser uses the page name to check if it exists anyways. No need trying to help it escape characters.
  • This is an interwiki link: This item references [[Wikipedia:duck|]]s. An interwiki map can be found here. As a matter of style of consistency avoid escaping page names here too.
  • Always link to the page you mean, not a redirect.
  • Name links with pipes: [[hell ramen|my favorite food]] (my favorite food).
  • Removing a namespace such as Template: or Wikipedia: from a link's name is easy as adding a pipe (|): [[wikipedia:ramen|]] (ramen).
  • Removing a post-fixed disambiguation such as (familiar) or (effect) from a link's name is done in the same way: add a pipe (|): [[Barrrnacle (familiar)|]] (Barrrnacle).
  • Appending a string of letters to the end of a link's name is done as follows: [[Mosquito]]es (Mosquitoes).
  • To link to a section of a wiki page use an anchor #.
    • Linking to a section within a page: [[#Linking]] (#Linking).
    • Linking to a section on another page: [[Help:Contents#Linking]] (Help:Contents#Linking).
  • Also, one specific TheKolWiki bit of neatness, use the plural template to automatically look up the in-game plural for items: {{plural|seal tooth}} yeilds seal teeth.

Category Sorting

  • Pages within a category are sorted not alphabetically, but by their ASCII value, which is case sensitive.
Alphabetical Ordering ASCII Ordering
cherry
Grapes
lemon
Lime
olive
Orange
Grapes
Lime
Orange
cherry
lemon
olive
  • When a page is placed in a category by using [[Category:CATEGORY_NAME]], the default sort is by page name.
  • You can override how the page is sorted by using [[Category:CATEGORY_NAME|SORT_AS]], where SORT_AS is how you wish to have the page sorted within the category. An example of this is the Food By Size category. Hell ramen should not be sorted under "H", but under "6", so the category link should look like: [[Category:Food (By Size)|6, hell ramen]].

Wiki Parser

The wiki parser is the internal wiki functionality which takes editor created pages and transforms them into the html web pages which are displayed. The parser will transform wiki functions – like images ( [[file:image.gif|text]] ), templates ( {{template_name}} ), headings ( ==Heading== ), etc. – into the appropriate html. The wiki also parses normal html formatting and tables within a wiki page.

  • The wiki parser may add extra spacing depending on white space. The wiki parser may either add a line break <br /> or create a new paragraph <p></p>.
  • Avoid using center tags within lists (bulleted, numbered, etc.); they seem to break the html within the page. If necessary, put a couple carriage returns before and after what needs to be centered in a list. <br /> won't cut it.

Useful References