Coding Style Guidelines

Guidelines

Guidelines are suggestions. They are not rules.

Preferred Tags
- For italics, use the ,  pair instead of the ,  pair.
- For bold, use the ,  pair instead of the ,  pair.
- Some browsers display the differently than the tags. The same thing holds for the and the tags
Headings
- Use h1 for titles
- Use h2 for subtitles
- Use h4 for section titles
  - See the Page Formatting guidelines for an example of an exception to this guideline.
- Sometimes sections need to be grouped into "chapters". Here are two examples.
  1. Information for Help Editors (h2 used for chapter titles)
  2. Help Page Templates (h3 and double "hr"s separate chapters from sections.)
- Sometimes a section needs to be broken up into subsections. Unordered lists are used for this purpose on the Page Formatting Guidelines page.
Every page will have a title, but there might not be any section titles or subtitles.
Links
- Use relative links.
  - Do not use the full URL for help pages in the "http://www.gokgs.com/" directory. Use only the part of the name that follows the directory name.
  - For links from a page into the interior of that same page, use only the "#name" portion of the URL
#Link Names
#Links point to the interior of a page. #Links are used in the Table of Contents. For the names of these links:
- Use all small letters: no spaces, no hyphens, no special characters.
- For short section titles, use the full section title.
- For long section titles, pick a key word or phrase within the section title.
- Wait until the section title is stable before creating a #link name.
New Pages
- The "page titles" in the code appear in the Foxycode tabs. Make them similar to the title of the page.
Nested Lists
- The third level of an unordered nested lists uses a square bullet.
  - This is the default bullet for the third level of a nested list.
  - Once again for emphasis.
- The KGS help pages normally use a solid circle.
  - This is a typical bullet for the third level of a nested list in the KGS help pages.
  - It is a little less bulky than the square bullet.
- The Unfinished Games help page uses solid circles (discs) for its third level bullets.
- Cut and paste the code to use a solid circles for bullets from the list-style-type section of the CCS Cheat Sheet.

Glossary

URL
- Uniform Resource Locator. For example, "http://www.gokgs.com/help/CodingStyles.html#glossary" is the URL for this Glossary.
Relative URL
- A relative URL inherits its initial part of the URL from the context in which the URL is used. For example, the TOC would refer to this section with the relative URL "#glossary". The full URL for this example is given in the "URL" entry in this glossary.
- Links in the KGS help pages must use relative URLs if possible. For example, a KGS help page link to this section would use the URL "/help/CodingStyles.html#glossary".

Coding Style Guidelines

Guidelines

Glossary

Related Links