Changes between Version 11 and Version 12 of GROUP_APP_HELP_R0


Ignore:
Timestamp:
04/14/09 19:19:11 (16 years ago)
Author:
mitex
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • GROUP_APP_HELP_R0

    v11 v12  
    1212== Task requirements == 
    1313 
    14  * The help information should be in HTML format and available online. This has the following advantages: 
    15   * quick access from everywhere 
    16   * easily updateable (fixed wrong help information, adding more information, etc.) 
    17   * easy to create rich text content with text formatting, links, images, menus with JavaScript, etc. 
    18   * searchable by google and other search engines (if we use a Sophie book for the help, this will be hard to achieve) 
    19  * Some help content is available at [wiki:ITERATION_06/Release/UserDocumentation]. 
     14 * The help information should be in HTML format and available both offline and online. 
     15 * Some help content is already available at [wiki:ITERATION_06/Release/UserDocumentation]. 
    2016 * For next revisions: Select a better place for the help files in the official website for Sophie 2. 
    2117 * For next revisions (or in another task): Provide search functionality in the site. 
    … …  
    3127   * Pros: displays all kind of rich content - HTML with JavaScript, flash, CSS, etc. 
    3228   * Impediments: platform dependency 
    33   * Another option is to use JEditorPane instead of a browser. 
     29  * Another option is to use JavaHelp which uses JEditorPane. 
    3430   * Pros: platform independent 
    35    * Cons: limited functionality, so the help content on the web site has to be compatible with it 
    36   * In future revisions we can use embedded browser. 
    37   * For this revision it's appropriate to use the user's default web browser. 
     31   * Cons: limited HTML support, so the help content on the web site has to be compatible with it 
     32  * In future revisions we can use Sophie book. 
     33  * For this revision it's appropriate to use JavaHelp. 
    3834 
    3935 * The Help menu in Sophie 2 should contain the following items: 
    4036  * &Help Contents - displays the start page of the help information. See the Extensibility section. 
    41   * &Search... - opens the search page in the website. 
    42    * for next revisions it will be good to have a Help tab similar to the Search tab - search box and list of results. 
    4337  * &Web site - opens the official website of Sophie 2 in the default web browser. 
    4438  * As&k for Help... - opens a web page (web form, forum, wiki, etc.) where the user can ask anything about the program or propose enhancements. This is related with the next section - the bug report form. 
    … …  
    4842  * in next revisions: Check for &Updates. 
    4943  * ("&" means that the following letter will be underlined and used as a keyboard shortcut). 
     44 * For next revisions it will be good to have a Help tab similar to the Search tab - search box and list of results. 
    5045 
    5146 * Extensibility 
    5247  * Modules should be able to attach help entries. 
    53   * Each Sophie module can provide (if appropriate) an extension with help information. This extension may contain: 
    54    * URL of the help information of the module. 
    55     * Can point to the sophie website 
    56     * Third-party modules can use their vendor's website, or local directory with help files. 
    57    * Help contents entries. For example, the {{{org.sophie2.main.view.menus module}}} can provide an entry with id="main.view.menus.file", title="File Menu" and parent="main.view.menus". The location of the HTML page should be something like {{{<sophie_website>/<help>/main/view/menus/file.html}}}. 
    58   * When selecting "Help Contents" in the Help menu, a content page is generated. 
    59    * The entries are gathered from each module's help extension. 
    60    * The generated page is in HTML format 
    61    * The page is created in the TEMP directory. Do not forget to delete it after closing the window. 
    62    * The page can 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. 
    63    * 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. 
     48  * Each Sophie module can provide (if appropriate) an extension with help information. 
     49  * The extension should contain the relative path of the HelpSet file. 
     50  * The HelpSets are dynamically merged into a single HelpSet. 
    6451 
    6552 * About dialog 
    … …  
    8875  
    8976 * Create a module {{{org.sophie2.main.func.help}}}. 
    90   * Create the menu and menu items. 
    91  
    92  * For the browser: 
    93   * browse(URI) in java.awt.Desktop can be used. 
    94   * but the Desktop API is from Java 6. 
    95  
    96  * For the content generator: 
    97   * Create two HTML files: 
    98    * Index page (index.html or similar) - frameset with two frames - actually it is the same every time, so you can use already created html file. 
    99    * Contents page - the help contents, arranged in a tree. Each link should be open in the right frame. 
    100     * Use CSS from the official website of Sophie 2. 
    101    * Use FileEntryManager.getWritableEntry 
    102    * For next revisions: cache the generated page, because it's the same most of the time. 
     77  * Create the menu items. 
    10378 
    10479 * For the about dialog: 
    … …  
    12297 
    12398= Design = 
    124 ^(Describe your design here.)^ 
     99 * Create a module {{{org.sophie2.main.func.help}}}. 
     100  * Create an extension point for help entries (see below). 
     101 
     102 * Create a class HelpEntry that represents the JavaHelp's HelpSet that a module can provide. 
     103 
     104 * Create an enum HelpLogic. 
    125105 
    126106= Implementation =