Future Editing Plans

Table of Contents 

This Page |  Other Pages:   ... Ready To Edit    ... To Be Reviewed    ... To Get Images    ... To Be Created
Global Change Notes   |  Ideas:   ... Help Buttons  ... Miscellaneous
Other Work  |  Glossary  |  Related Links

These plans are for the English help pages. The plans in the form of change notes are ready to implement. Some of the change notes are signed and dated.

The change notes for this page are in the usual place, that is, at the bottom of the page.

2) A) Ready To Edit

The change notes are either in the list below or they are at the bottom of the referenced page, or both. The Hot Link pages that need editing are listed first, followed by Help Editor Resource pages, followed by other pages.

• Index Box pages that are ready to edit
  
  
• Game window
  • (Insert a new screen image that has the "tagged game" dialog box in it. dj, 11/2010)
• CGoban main window
  • (Replace h3 section titles with h4 section titles. dj, 11/2010)

• Help Editor Resource pages that are ready to edit
  
  
• Help-Page History (under construction in Sandbox 9. dj, 11/2010)
  
  • Add skeleton tables.
  • Enter 1) file name, 2) creator user-name, 3) current title, and 4) current editing status for each help page in the tables. Enter them in logical, not alphabetical, order.

• Other pages that are ready to edit
  
  
• Automatch (dj. 2/2011)
  • Rework the English Automatch along the lines of the French Automatch.
  • Move some of the text from Automatch Overview to Automatch.
  • Replace primary links to Automatch Overview with links to Automatch. For example, the links mentioned in the Maintenance section of the Site Map design notes.
  • Replace the links to Automatch Overview in the Related Links sections with links to Automatch.
  • Decide what to do about the Automatch Notes.
  • Expand the TOC in Automatch.
• Enable footnote links #1, 2, and 3, in Chat Line Etiquette. Get good links for definitions, or, quote American Heritage Dictionary.

2) B) To Be Reviewed

These pages have not been reviewed since 2009. In particular, they have not been reviewed in the context of the Help Page Guidelines. dj 11/2010.

• Editor: Tools and Options
  Here are the kinds of questions that need to be addressed.
  • Does the "sgf-file editing tools" concept needs to be split out from the "demo-teaching-and-review tools" concept? Do people have to learn what sgf editing is to be able to understand this page?
  • Does the title need to be changed to get the sgf editing concept out of the title? Should sgf editing be presented "by way of explanation" rather than as the main topic of this page?
  • Is it important that the new user can quickly tell why this page is relevant to the text from which it was linked?
  • Is the layout of this page clear and easy to read?
  • Does the page layout support the user who is looking for something specific and wants to find it quickly?
    
    
• Trouble Shooting
  • Might need wordsmithing, editing, and reorganization.
    
    
• Rating System Math
  
  • It's probably OK, but, it might need some wordsmithing.

2) C) To Get Images

2) D) To Be Created

Since the first three pages in the following list need screen images with Help buttons, it makes sense for the Help buttons in the KGS windows before the pages are created.

• File Menu help page
  
  • Include a Help button in the File Menu window that links to the File Menu help page (a job for wms).
  • Include an image of the File Menu window in the File Menu help page.
  • Link from the KGS Main Window help page into the File Menu help page.
  • Copy the detailed File Menu description from the KGS Main Window help page into the File Menu help page.
  • Put a brief overview of the File Menu window in KGS Main Window help page.
• User Menu help page
  
  • Create and link a User Menu help page in the same way that the File Menu help page was created and linked.
• KGS Playback help page
  (The KGS Playback window is the window used for reviewing KGS+ lectures.)
  
  • Link to it from a Help button in the KGS Playback window (job for wms).
  • Put a link to the KGS+ help page in the Hot Links list.
  • Underneath that link, and indented a little, put a link to the KGS Playback help page. There already is a German (Deutsch) Playback page.
• "Please Delete.html" help file
  • Create a file called "Please Delete.html" and put the names of all the help pages that are marked for delete. Repeat this list in the 2010 "Files Marked for Delete" section of the PageHistory file.
  • This will put the message "Please Delete" in the right hand column of "List all files" page. The "Please Delete" file should be cleared (but not deleted) after the requested files are deleted. The list of names in the PageHistory file should not be links. Otherwise the deleted files might inadvertently be re-created.

3) A) Fun Stuff

This section (Section 3A) is intended to be permanent. Subsequent sections are intended to be deleted when the change notes are complete.

Information of a permanent nature may be moved to the Guidelines after the change has been implemented. Templates may be saved in in the Templates page.

(Copy guideline links from the "Help Editor's Resources" into the related links section of each guideline help page. Be sure to include the templates page. Insert the up-one-level and the top-of-page links for the guideline pages when this change note is implemented. dj, 12/2010)

(Try different browsers. dj, 12/2010)

The things in this section are either 1) not-as-concrete or 2) not-as-ready-to-be-implemented  as the things in the preceding sections, Sections 1, 2 and 3.

4) A) Help Buttons 

Make a screen-shot help page for every KGS window that needs a Help button.

• If a Help button is added later, make another screen-shot and update the Help page.
• Ideally, wms would add the Help button first. Then the screen shot would be taken. Then make the help page.
• Windows with Help buttons are particularly useful to first-time users.

• Windows with Help Buttons
  • Set Preferences
  • Server Stats
  • Game Window
  • CGoban Main Window
  • "New Game" Window
  • Main KGS Window
    
    
• Windows that need Help Buttons
  • File Menu                        (help file not created yet)
  • User Menu                      (help file not created yet)
  • KGS Playback                (help file not created yet)
    • The Playback Window is used for reviewing KGS+ lectures.
    • German version
  • Automatch Preferences    (the help file needs work)
  • User Information
  • Tools for Demos Teaching and Review
  • Automatch Preferences

See Section 2E, "To Be Created", for more information.

4) B) Miscellaneous Ideas

• Copy the code in the Welcome to KGS help page into the Sensei Library (SL) page with that same title. Put it near the top. Do not simply link to the KGS page instead of copying the code. People generally don't click on links, at least not until they finish reading the page they are on.
• Surf the SL pages, especially the SL KGS pages, and insert links to the KGS help pages where appropriate. Update SL links into the KGS pages that have broken as the KGS pages have evolved. Update any SL links that need to point to the interior of a KGS page. It helps to do this if the KGS page has a TOC and you use Firefox tabs.

This is a place for things that do not fit in the previous sections.