Changes between Version 10 and Version 11 of GROUP_APP_HELP_R0

Timestamp:

03/31/09 16:44:13 (16 years ago)

Author:

mitex

Comment:

--

GROUP_APP_HELP_R0

@@ -8 +8 @@
 The goal of this task is to provide the ability for Sophie 2 to display help information for the end user. The actual writing of the help content is for another tasks.
 
+Note: if you are writing analysis of a next revision of this task, please read carefully all proposals in this page.
+
 == Task requirements ==
 
@@ -15 +17 @@
   * easy to create rich text content with text formatting, links, images, menus with JavaScript, etc.
   * searchable by google and other search engines (if we use a Sophie book for the help, this will be hard to achieve)
- * Select a place for the help files in the official website for Sophie 2.
- * Provide search functionality in the site.
  * Some help content is available at [wiki:ITERATION_06/Release/UserDocumentation].
+ * For next revisions: Select a better place for the help files in the official website for Sophie 2.
+ * For next revisions (or in another task): Provide search functionality in the site.
 
  * Since we'll have different versions of Sophie, for example 2.0, 2.01, 2.1, 2.2, etc., we should support different help content for each of them.
   * In the root directory of the online help information create subdirectory named "2.0".
   * When a new version is released, create a subdirectory, named according to that new version.
-  * Each subdirectory should contain the whole HTML content (and only the HTML content, because images can be shared). It is error prone to have only the new pages, because HTML pages from a previous version may have links to pages from that old version, instead of the new. (example: 2.0/a.htm, 2.0/b.htm with link to a.htm; 2.1/a.htm, if we use 2.0/b.htm, there is a link to 2.0/a.htm instead of 2.1/a.htm). 
+  * Each subdirectory should contain the whole HTML content (and only the HTML content, because images can be shared). It is error prone to have only the new pages, because HTML pages from a previous version may have links to pages from that old version, instead of the new. (example: 2.0/a.htm, 2.0/b.htm with link to a.htm; 2.1/a.htm, if we use 2.0/b.htm, there is a link to 2.0/a.htm instead of 2.1/a.htm).
+  * If the changes are minor, for example a menu item is renamed, then there is no need to copy the whole content; instead, use the previous version, with updated help page, for example: "The MegaTetris menu (Tetris menu in version 2.0)..." or something similar.
 
  * There are several ways to display the help content. Some of their pros and cons are listed too.
@@ -70 +73 @@
   * The dialog does not have a button to close. Clicking elsewhere hides the dialog.
   * [[Image(source:/trunk/sophie2-platform/doc/spec-diagrams/AboutDialog.png, 20%)]]
+  * Discuss each change with Nick first.
 
  * Tooltips - we already have them, just check for inconsistency.
@@ -83 +87 @@
 == Implementation idea ==
  
- * Create a module {{{org.sophie2.main.help}}}.
+ * Create a module {{{org.sophie2.main.func.help}}}.
   * Create the menu and menu items.
 
@@ -95 +99 @@
    * Contents page - the help contents, arranged in a tree. Each link should be open in the right frame.
     * Use CSS from the official website of Sophie 2.
+   * Use FileEntryManager.getWritableEntry
+   * For next revisions: cache the generated page, because it's the same most of the time.
 
  * For the about dialog:
@@ -101 +107 @@
   * Currently AboutDialog just calls OldAboutDialog.
   * Use setUndecorated(true) in JFrame to remove the about dialog window border.
-  * Add mouse listener so the window can be closed with a mouse click.
+  * Handle the mouse clicking in R3 style (OperationDef) so the window can be closed with a mouse click.
 
 == Related ==