Changes between Version 7 and Version 8 of GROUP_APP_HELP_R0

Timestamp:

03/26/09 17:37:40 (16 years ago)

Author:

mitex

Comment:

--

GROUP_APP_HELP_R0

@@ -25 +25 @@
  * Help content should be displayed in user's default web browser.
   * Search for a platform independent way to open the browser.
+  * Another option is to use JEditorPane instead of a browser. It has limited functionality, so the help content on the web site has to be compatible with it.
   * In future revisions we can use embedded browser.
 
  * The Help menu should contain the following items:
-  * &Help Contents - displays the start page of the help information.
+  * &Help Contents - displays the start page of the help information. See the Extensibility section.
   * &Search... - opens the search page in the website.
    * for next revisions it will be good to have a Help tab similar to the Search tab - search box and list of results.
@@ -38 +39 @@
   * in next revisions: Check for &Updates.
   * (& means that the following letter will be underlined and used as a keyboard shortcut).
+
+ * Extensibility
+  * Modules should be able to attach help entries.
+  * Create a module org.sophie2.main.help.
+  * Each Sophie module can provide (if appropriate) an extension with help information. This extension may contain:
+   * URL of the help information of the module.
+    * Can point to the sophie website
+    * Third-party modules can use their vendor's website, or local directory with help files.
+   * Help contents entry. For example, the main.view.menus module can provide an entry with id=menus and title="Menus".
+  * When selecting "Help Contents" in the Help menu, a content page is generated.
+   * The entries are gathered from each module's help extension.
+   * The generated page is in HTML format
+   * The page is created in the TEMP directory. Do not forget to delete it after closing the window.
+   * The page cam consist of a frameset with left frame - the generated menu, and right frame - the remote help page that is invoked by clicking on a menu entry.
+   * We should use locally generated help contents menu instead of the website's help index page, because each Sophie installation may have different plugins installed.
 
  * About dialog
@@ -50 +66 @@
 
  * Tooltips - we already have them, just check for inconsistency.
+
+ * Author and Reader
+  * They need different help information.
+  * Currently there is no Reader, only an idea.
 
 == Task result ==