Testing Scenarios for Help System

Objectives

1. integration with the workbench: launching help browser and help view from help menu, help search, and context-sensitive help (F1)
2. navigation and browsing of topics in the help browser and view
   
3. search support in the help browser and view
   
4. accessibility

Integration with the workbench

I1: Help browser preferences:

1. Launch "Window"->"Preferences".  Preferences dialog will open.
2. Choose "Help" on the left.  This should show help preference page on the right
3. On Windows and Linux help uses embedded browser, and the preference should contain a checkbox to use external browser.
4. Choose "Help"->"Help" Contents" from the workbench menu, ensure a browser opens and displays Help browser.
5. Go back to help preferences, select "Use external browser".  Follow hyperlink to Workbench Browsers preference page.  Choose a browser to use, Click "OK".
6. Choose "Help"->"Help" Contents" from the workbench menu, ensure a browser selected opens and displays Help.
7. Go back to help preferences.  If you have more browser adapters available, try selecting each browser adapter and launch help.

1. Press "F1" key (Ctrl+F1 on GTK, Help on carbon) in the workbench "Navigator" view ("Resources" perspective). This should open help view in the workbench, turned to Related Topics page.  Verify "About ..." section displays description of workbench part in focus.
2. Click on one of the related links.  A topic should open in the help view.
3. Change help preferences to open context help in an infopop, dialog context help in an infopop, help view document open mode - in editor.
4. Click "back" in the help view to arrive at Related Topics page.  Select a link from Dynamic Help section.  Verify it opens in the editor area.
5. Press "F1" key (Ctrl+F1 on GTK, Help on carbon) in the workbench "Navigator" view ("Resources" perspective) again. 
   
<>This time it should open an infopop with a description and related links.  Focus should be on the first link ("Views").
6. Click "Navigator View" link.  This should launch help web browser, and display "Navigator View" document on the right and the list of related topics on the left.  The link called "Navigator View" should be selected.
7. Open help preferences, press "F1".  and infopop should open.
8. Restore defaults in the the browser preference page, and apply.
9. Press F1 again.  A small help view with Related Topics should open adjacent to the preferences dialog.
   

1. Without closing the browser that opened in test case I1.4, choose "Help"->"Help" Contents" from the workbench menu.  No new browser window should launch, and the existing help browser should load the table of contents, with lists of books on the left, and "Welcome to Eclipse help" document on the right.
2. Close the help browser.  Browser window should close.
3. Open a workbench preferences, press F1 (Ctrl+F1 on GTK, Help on carbon). Select a related link. Help should open in external browser (even when help preference "always use external browser" checkbox is present on preference page and deselected).

1. Choose "Hep Search" from the workbench Help menu.  Click "Help Search" tab.  Help search page should open.
2. Type a query "open project" (without quotes), click "Go".
3. Choose a result.  The document should open with occurrences of the words "open" and "project" highlighted.
   

1. TODO

1. Type "active link below" (no quotes) in the search field in the help view, and search.
2. Choose a document titled "Active help" from the search results.
3. Click once "Click here for a Message" link at the bottom of the document.
4. Ensure that a "Hello World" is being displayed in a dialog on top of the workbench.

1. Launch "Window"->"Preferences".  Preferences dialog will open.
2. Choose "Help/Help Server" on the left.  Enter a port number (for example 2003), in the second field.  Click O.K.
3. Restart workbench. Launch help from the menu.  Ensure browser opens and displays help content.
4. Go back to Help Server preferences, click "Restore defaults" button, click "OK", restart workbench.

1. Launch "Window"->"Preferences".  Open "General"->"Capabilities" preference page.
2. Select all capabilities and deselect "Development".
3. Launch help , by selecting Help->Help Contents from the menu.  Verify only two workbench books appear.
   
4. Select "Show All Topics" button in the navigation toolbar.  Confirm.
5. Verify "Show All Topics" toolbar button appears pressed, and all books (including PDE Guide are displayed).
6. Search for "PDE".  There should be large number of hits
   
7. Turn off showing all topics. Verify that PDE Guide disappeared, since it is does not belong to enabled workbench capabilities.
8. Perform search for "PDE". Verify search results were redisplayed and there are no or next to no results.

Navigation and browsing

• moving around the navigation views (Contents, Search Results, Links, Bookmarks)
• opening a book, expanding/collapsing/selecting topic nodes
• navigating links inside the help pages
• using toolbar actions for displaying the main table of contents, for hiding or maximizing the navigation frame, for topic/navigation synchronization, printing
• performing simple searching.

Note: this test is to be done on browser adapters that are based on Internet Explorer or Mozilla. For other browser, refer to the "basic" test.

N1: Basic topic navigation:

1. Launch help from the workbench menu: Help->Help Contents. This should open the help view to the main bookshelf that lists the available books.
2. In the Contents page select the Workbench User Guide book. This should expand that book and show it contents. All the other books must still be available in the navigation frame (i.e. only the select book expands).
3. In the table of contents tree navigate to Concepts ->Workbench. Selecting the "Workbench" topic should show some content in the main help area.
4. Click on the "Features" link in the displayed document. This should load a new document.

1. Identify the 6 buttons on the content toolbar (the toolbar is located above the page displaying help pages): Go Back, Go Forward, Show in table of contents, Bookmark document, Print Page, and Maximize.
2. Click the Back button in the content toolbar. This should reload the previous document (Workbench).
3. Click the Forward button in the content toolbar. This should reload the document ("Features").
4. Click maximize icon on the toolbar of the main content frame. This should maximize that particular frame, and "Restore" icon should be shown in place of "Maximize". This time double click on the toolbar, it should restore the original layout. The behavior should be similar to that of the eclipse views.
5. Click on the "Synchronize Navigation" button on the toolbar. This should highlight the "Features" topic in the navigation tree.
6. Print the topic by clicking on the "Print Page" button on the toolbar. This should launch the system print dialog and if you click OK it should print the help page
7. Bookmark the current page, by pressing the "Bookmark document" button on the toolbar.
8. Turn to the Bookmarks tabs and verify it is added there.
9. Turn to the Contents tab and select another topic
10. Turn to the Bookmarks tab and click on the bookmarked topic (Features). This should load that topic in the main content area.
11. Remove bookmark: Select the bookmark topic, right click and select Remove, or choose "Delete bookmark" from the bookmark view toolbar.
12. Add more bookmarks, delete them all using "Remove all bookmarks" button or action on the pop-up menu.

1. In the Search entry field enter the word "participation" without the double quotes. The navigation frame should turn to the Search Results view, and if this was the first time you search the docs, you should see the indexing progress monitor in that page. When indexing is finished (or right away if other searches were performed before) you should get the results. In my case, I got 14 hits, starting with "Synchronize View Integration".
2. Select a search result: "Workspace save participation". You should see the "participation" string highlighted, as well as "particip". This is because the search engine uses word stemming on English, so the highlighting respects the same stemming algorithm.
3. Click on each results. You should see the toolbar title changing to show the book containing the document.
4. Let's narrow the results by book: click on the "Scope" link in the search bar. This should launch the Select Scope Search dialog that let's use define search list. Click on "New" to launch the dialog for defining a new search list. Enter the name "workbench" and select the "Workbench User Guide", click OK to close the dialog. The name "workbench" should now be visible in the list in the Select Scope Search dialog. Select it, and click OK (or double click instead).
5. This should close the dialog and the Search Scope should now display the name "workbench". Note: Sometimes the search bar is not updated right away, so you may have to wait a bit. Search again for the same word, "participation". You should see fewer results (I see 2 hits only).
6. Select the "Crash recovery" hit, and click on "Synchronize Navigation" button on the navigation or content toolbar. This should switch the navigation view to the Contents view, and expand the Workbench User Guide down to the "Crash recovery" topic.
7. Click the "Search Results" tab at the bottom of the navigation tree. This should redisplay the search result you've seen in step 5.
8. Click on the "Contents" tab at the bottom of the navigation tree. This should redisplay the navigation tree as you left it after step 6.

Search

S1: Boolean search:

1. Search for 'project close' (no quotes).  Documents should be found containing both words.  Selecting document should show its contents with occurrences of both words highlighted.
2. Search for 'project AND close' (no quotes).  The results should be same as for the previous query
3. Search for 'project OR close' (no quotes).  The list of hits should be much longer, with some documents at the top containing both words, and documents down the list containing only one of them.
4. Search for 'project close not navigator' (no quotes).  The list of hits should be smaller than in step 1 of test S1.

1. Search for ' "close project" ' (in double quotes).  The search results list should be shorter than in step 1 of test S1.
2. The documents should contain consecutive words close and project (possibly separated by a punctuation).

1. Search for 'close project' (no quotes).  The search results list will show hits.
2. Select a document.  Note the book the topic belongs to.  The book name is displayed on the toolbar in the browser, directly above the document.
3. Click "Search scope:".  The scope selection window will open.  Click "New", Select some books or sections, but leave the book that was noted in step 2 of test S3 unchecked.
4. Type a name for your new scope.  Close dialog windows, ensure that the scope name appears on the search tool bar.
5. Click "Go".  Verify that the document selected in step 3 of test S2 does not appear in the list of search results.
6. Click the Search Scope again and remove the scope you just defined. Click OK to close the dialog. The search bar should now have "All topics" in the Search Scope.

Customization

C1: Help preferences / large book browsing

Edit the file and paste the following key/values pairs:

org.eclipse.help/baseTOCS=/org.eclipse.pde.doc.user/toc.xml,/org.eclipse.jdt.doc.isv/toc.xml
org.eclipse.help/ignoredTOCS=/org.eclipse.platform.doc.user/toc.xml,/org.eclipse.jdt.doc.user/toc.xml,/org.eclipse.platform.doc.isv/toc.xml

org.eclipse.help.base/banner=/org.eclipse.help.webapp/advanced/banner.html
org.eclipse.help.base/banner_height=60
org.eclipse.help.base/help_home=http://www.eclipse.org
org.eclipse.help.base/linksView=false
org.eclipse.help.base/bookmarksView=false
org.eclipse.help.base/windowTitlePrefix=false
org.eclipse.help.base/loadBookAtOnceLimit=10
org.eclipse.help.base/dynamicLoadDepthsHint=2
org.eclipse.help.base/advanced.toolbarBackground=green
org.eclipse.help.base/advanced.viewBackground=yellow
org.eclipse.help.base/advanced.toolbarFont=bold
org.eclipse.help.base/advanced.viewFont=italic
org.eclipse.help.base/showDisabledActivityTopics=never
org.eclipse.help.base/activeHelp=false

1. Launch Eclipse, pointing to the ppreferences customization, e.g. eclipse -pluginCustomization plugin_customization.ini
2. From the workbench menu: Help->Help Contents. This should open the help browser. Verify existence of banner frame above search toolbar.
3. The page displayed in the content frame should be eclipse.org page.
4. There should be only two Eclipse books displayed PDE Guide and JDT Development Guide, in that order.  Other Eclipse books should not appear.
5. Search for "workbench".  Verify there are no hits from Workbench User Guide that is not present.
   
6. Verify there is only Contents and Search tabs at the bottom of navigation frame, other views (Links and Bookmarks) are not present.
7. Verify the browser title shows product name.
8. Browse navigation tree. There can be small delay expanding second, fourth, etc level of topics. Verify branches expand correctly.
9. Verify help UI background is yellow, and green in the toolbars.
10. Verify fonts are bold in the toolbars, and italic in the rest of the UI.
11. Launch "Window"->"Preferences".  Open "Workbench"->"Capabilities preference page. Select all capabilities and deselect "Development".
12. Re launch Help. Verify no books are displayed and "Show All Topics" button is not displayed.
13. Type "active link below" (no quotes) in the search field in the browser, and search.
14. Choose a document titled "Active help" from the search results.
15. Click once "Click here for a Message" link at the bottom of the document.
16. Verify a message informing that active help is not enabled is displayed, and "Hello World" workbench dialog does not appear.

C2: BIDI

1. Launch eclipse passing "-dir rtl" option on the command line. Open Help.
2. Verify Help UI is rendered right to left.

Accessibility

• uses system colors and fonts,
• uses browser's accessibility support,
• can be navigated using only the keyboard.

• on Windows things should work as described;
• on Linux using the Mozilla browser adapter keyboard navigation works slightly different: Ctrl-Tab and Ctrl-Shift-Tab are to be replaced by Ctrl-F6 and Ctrl-Shift-F6 (this is for frame navigation, see below).
• on Solaris/AIX/HP, unless you use Mozilla, the default browser adapter for Netscape 4.x has very little accessibility support, both for fonts/colors and for keyboard navigation.

1. Observe if the colors and fonts match your system settings. Window backgrounds for navigation views (Contents/Search Results/Links/Bookmarks) should match the system window color (usually white on Windows and gray on Linux). The toolbars should match the button face co lour (usually gray). The font should match the system icon font. Highlight co lour should match the system highlight co lour.
2. Change your system colors/font settings and see if the changes take effect.
3. On Windows, try the high contrast settings: Control Panel -> Accessibility Options -> Display - > Use high contrast.

1. Windows: in IE - > Tools-> Internet Options -> General ->Accessibility play with the settings for Format. Help should behave accordingly.
2. DO NOT turn off style sheet support, help will not work well.

- To move to the next topic in the left frame, press TAB or DOWN arrow.
- To move to the previous topic , press SHIFT-TAB or UP arrow.
- To expand/collapse a tree node press RIGHT/LEFT arrow.
- Press Enter to select a topic and have its content displayed
- To scroll all the way up/down press HOME/END.
- To go back/forward press ALT-LEFT/RIGHT ARROW
- To go to the next frame (there are quite a number of frames in the help
system) press CTRL-TAB (On Mozilla 1.2 press Ctrl-F6).
- To move to previous frame, press SHIFT-CTRL-TAB (On Mozilla >1.2 press Ctrl-Shift-F6).
- To move to content frame, press ALT-K, and press Tab to place focus inside the topic
- To print the current page or active frame, press CTRL-P.

1. Press F1 (on GTK - Ctrl-F1, on carbon - Help key) in the workbench Navigator view (Resources perspective). This should launch the infopop with some text and two related links. Focus should be on the first link ("Views"). Click and the help view should open to the selected topic.
2. Get back to the workbench and press F1 again, in the Navigator view. When the infopop comes up, press down/up arrows (or tab) to cycle around the links. Press Esc to dismiss the infopop.

Other Scenarios

In addition to the eclipse workbench help scenario, there are two other help uses scenarios: standalone help and info-center (server based) help.


IC: Infocenter

1. Assuming eclipse is installed as d:\eclipse, change directory to d:\eclipse and run the following command: java -cp plugins/org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command start -data infocenter -port 8888
2. Open a browser and navigate to http://localhost:8888/help. You should see the help system, but without the links and bookmarks tabs.
3. Define a working set, search help. Close the browser and reopen. Verify working sets are remembered.
4. Perform ad-hoc testing or follow the steps for the regular workbench scenarios, with the exception of bookmarks, infopop and active help.
5. Shutdown the infocenter by running: java -cp plugins/org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command shutdown -data infocenter

SA: Stand-alone help

1. Assuming eclipse is installed as d:\eclipse, change directory to d:\eclipse and run the following command: java -cp plugins/org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp -data standalone
2. The above command should automatically open the browser so you can browse the help. Perform ad-hoc testing or follow the steps in the regular workbench scenario, with the exception of infopop and active help.
3. Shutdown the standalone help by running: java -cp plugins/org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command shutdown -data standalone

B: Basic help ui (any browser with Javascript disabled or browsers other than IE, Mozilla or Netscape6+)

1. Disable javascript in the browser that is used by the default browser adapter (normally, that's IE on Windows, Mozilla on Linux and Netscape6+ on others)
2. Launch help and you should see a simple 3-frame layout with links instead of tabs and just the synchronize navigation button available. Books are always expanded and there is no state preservation across views (i.e. when switching between contents/links/search/bookmarks) the page always reloads)
3. Try ad-hoc testing or follow the regular workbench scenario steps above.
4. Instead of step 1, you can launch Netscape 4.7 and navigate to the help system URL. To get this URL, right click in the help browser and select "Properties". Check what the URL is.