| | 1 | [[BackLinksMenu]] |
| | 2 | |
| | 3 | [[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|)]] |
| | 4 | |
| | 5 | = Analysis = |
| | 6 | |
| | 7 | == Overview == |
| | 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. |
| | 9 | |
| | 10 | == Task requirements == |
| | 11 | |
| | 12 | * The help information should be in HTML format and available online. This has the following advantages: |
| | 13 | * quick access from everywhere |
| | 14 | * easily updateable |
| | 15 | * easy to create rich text content with text formatting, links, images, menus with JavaScript, etc. |
| | 16 | * searchable by google and other search engines (if we use a Sophie book for the help, this will be hard to achieve) |
| | 17 | * Select a place for the help files in the official website for Sophie 2. |
| | 18 | * Help content should be displayed in user's default web browser. |
| | 19 | * Search for a platform independent way to open the browser. |
| | 20 | * In future revisions we can use embedded browser. |
| | 21 | |
| | 22 | * About dialog |
| | 23 | * Currently there is existing simple about dialog (OldAboutDialog), which displays textual information about the product. |
| | 24 | * Current about dialog should be refactored in order to match the new design of the application. |
| | 25 | * Add the official Sophie 2 logo to the about dialog. |
| | 26 | * In next revisions may be it is good to display the version of each installed plug-in. |
| | 27 | |
| | 28 | == Task result == |
| | 29 | * source code |
| | 30 | * partial help information in html pages |
| | 31 | |
| | 32 | == Implementation idea == |
| | 33 | ^(Provide some rough implementation idea(s).)^ |
| | 34 | |
| | 35 | == Related == |
| | 36 | ^(Add links to related tasks that could be useful or helpful.)^ |
| | 37 | |
| | 38 | == How to demo == |
| | 39 | ^(Provide instructions for demonstration of the task.)^ |
| | 40 | |
| | 41 | = Design = |
| | 42 | ^(Describe your design here.)^ |
| | 43 | |
| | 44 | = Implementation = |
| | 45 | ^(Describe and link the implementation results here (from the wiki or the repository).)^ |
| | 46 | |
| | 47 | = Testing = |
| | 48 | ^(Place the testing results here.)^ |
| | 49 | |
| | 50 | = Comments = |
| | 51 | ^(Write comments for this or later revisions here.) |
