Error: Macro BackLinksMenu(None) failed

compressed data is corrupt

Error: Macro TicketQuery(summary=GROUP_APP_HELP_R0, format=table, col=summary|owner|status|type|component|priority|effort|importance, rows=description|analysis_owners|analysis_reviewers|analysis_score|design_owners|design_reviewers|design_score|implementation_owners|implementation_reviewers|implementation_score|test_owners|test_reviewers|test_score|) failed

current transaction is aborted, commands ignored until end of transaction block

Analysis

Overview

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.

Task requirements

• The help information should be in HTML format and available online. This has the following advantages:
  • quick access from everywhere
  • easily updateable
  • 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 ITERATION_06/Release/UserDocumentation.
• 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).

• Help content should be displayed in user's default web browser.
  • Search for a platform independent way to open the browser.
  • 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.
  • &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.
  • &Web site - opens the official website of Sophie 2.
  • As&k for Help... - opens a web page (forum, wiki, etc.) where the user can ask anything about the program or propose enhancements.
  • Send an &Error Report... - opens the bug report form (see APP_BUG_REPORT_FORM_R0).
  • (separator)
  • &About - displays the about dialog window.
  • in next revisions: Check for &Updates.
  • (& means that the following letter will be underlined and used as a keyboard shortcut).

• About dialog
  • Currently there is existing simple about dialog (OldAboutDialog), which displays textual information about the product.
  • Current about dialog should be refactored in order to match the new design of the application.
  • Add the official Sophie 2 logo to the about dialog.
  • It should show the license used in Sophie 2.
  • It's good to have a changelog.
  • In next revisions may be it is good to display the version of each installed plug-in.
  • The dialog does not have a button to close. Clicking elsewhere hides the dialog.
  • 

• Tooltips - we already have them, just check for inconsistency.

Task result

• source code
• partial help information in html pages

Implementation idea

^{(Provide some rough implementation idea(s).)}

Related

• APP_BUG_REPORT_FORM_R0
• APP_HELP_GENERAL
• APP_HELP_ABOUT_DIALOG

How to demo

• Start Sophie 2
• Show the Help menu
• Open the contents

Design

^{(Describe your design here.)}

Implementation

^{(Describe and link the implementation results here (from the wiki or the repository).)}

Testing

^{(Place the testing results here.)}

Comments

^{(Write comments for this or later revisions here.)}