Main Help Page
FAQ
The main client window
The new game window
The game window
The preferences window
The server stats window

Rating system
Rating system Math
Playing games
Games Types
Supported Rule Sets
Supported time systems
Tournaments
Swiss Pairings

Information for help editors
Help Discussion
Recent changes
Translations Available (click a flag to view):
German (Germany) English (United States) French (France) Polish (Poland) Russian (Russia) Turkish (Turkey)

Editing KGS Help Pages

Becoming an Editor

We need more editors. If you know KGS well, and know how to write HTML, then we want you! Please email admin@gokgs.com to request editing access: add both your KGS username and the language you want to work in. Note that only people who are able to write correct English will be accepted as editors for the English pages.

How to Edit

Unlike most wikis, the KGS help pages uses raw XHTML to edit. So if you are used to the [i]...[/i], etc., tags of other wikis, this will be a bit different. If you have edited HTML or XHTML in the past, it will be easy!

What is XHTML

If you have only used HTML, then you will notice some changes. KGS uses XHTML, which has these as the main differences from HTML:

  1. Tags which affect text need closing tags. So, for example, when you use a <p> tag, you must have a </p> tag at the end of the paragraph.
  2. Tags that don't have closes need to have a "/" at the end of them. For example, instead of <br> or <hr>, you need to use <br/> and <hr/>.

In addition, KGS uses XHTML/strict. This means that many attributes that affect the "look" of the text aren't available. CSS styles need to be used instead. (Reference on CSS styles needed here.)

When you edit, you don't have to type the whole page. Everything up to and including the <body> tag is done for you, so you just need to type in what goes between the two body tags.

Editing a Page

When you visit any KGS help page, if you have editing control, there will be a "edit this page" link at the bottom. Just click it, and you can edit!

After you make your changes, press the "update help page" link at the bottom. If you made any XHTML mistakes, they will be listed. Note that some things aren't allowed; anything with a script, or that can be used to hide a script, is not allowed. This is to prevent editors from adding password-stealing scripts, etc., to the pages. Stay with just text and you'll be fine.

Creating New Pages

If you want to add a new page, just add a link to it from a current page. All links to other help pages must be in the format <a href="/help/newPage.html">. Don't forget the /help/! Once the link is made, just follow the link, and there will be your blank page, ready to edit.

Editing the Table of Contents

To add things to the table of contents box (that appears to the side of the page you type), click the link to edit any page, then click the "List all Help Pages" link at the top. You'll see a page named "toc.html". This is the table of contents. Edit it like any page, but instead of typing XHTML to go inside a body tag, this text will go inside a div tag on every page.

Adding Images

When you need to add an image, you can upload it to the server. Click on the "upload image" link at the top of the page you are editing. Directions are there. But remember: the KGS help images are named by the file name and the language, but not by the extension, so if you upload "screenShot.png" as an English picture, it will overwrite an English "screenShot.jpg"! But if there is a French image named "screenShot", that's OK, that will not be overwritten.

Things that Need Improvement

Collisions

Right now the system has no "collision detection." That is, if two people edit the same page and the same time, whoever updates first will have all their changes replaced by the person who updates second. If this happens, you can see your old changes by clicking on an older version of the page on the editing system; please try to merge your changes in. In a future release I'll add code to detect when this is happening and warn you before you start editing.


Edit this page (requires admin or translator privilege)

KGS