Testing Scenarios for Help

Objectives

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

Integration with the workbench

I1: Help preference page:

1. Launch "Window"->"Preferences".  Preferences dialog will open.
2. Choose "Help" on the left.  This should show help preference page on the right with list of browser adapters.  The list should have two or three browser adapter names, and the check box besides one of them should be selected: on Windows it should be the Embedded IE, on Linux it should be the Mozilla adapter, on Solaris/HP/Aix it should be the Netscape adapter.  Click "OK" or "Cancel".
3. Choose "Help"->"Help" Contents" from the workbench menu, ensure a browser opens and displays Help.
4. Go back to help preferences, select custom browser.  Click "Browse" at the bottom of a page and find an browser executable program (for example "C:\Program Files\mozilla.org\Mozilla\mozilla.exe".Click "OK".
5. Choose "Help"->"Help" Contents" from the workbench menu, ensure a browser opens and displays Help.
6. Go back to help preferences.  If you have more browser adapters available, try selecting each browser adapter and launch help.
7. When finished, change the browser preference to the original selection, i.e. Embedded IE on windows, or Mozilla on Linux.

1. Press "F1" key in the workbench "Navigator" view ("Resources" perspective). This should launch the info-pop with some text and two related links. Focus should be on the first link ("Views").
2. 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.

1. Without closing the browser that opened in test case I2, 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.

1. Choose "Search"->"Search..." from the workbench menu.  Click "Help Search" tab.  Help search page should open.
2. Type a query "open project" (without quotes), click "Search".
3. Assuming this is first help search since installing workbench, progress indicator will display status of document indexing.
4. Click "Cancel".   the indexing should stop, and the question dialog will pop up whether you want to restart indexing.  Click "No".
5. Choose "Search"->"Help...", The search dialog should open, turning to help page.
6. Choose "open project" from the "Search Expression" drop down. Click "Search".  Indexing should restart.  Wait for it to finish.  At the end, the "Search" dialog should close, and "Search" view should open.  The view will list search results sorted by relevance from 100%, descending.
7. Double click on the second item from the top.  The help browser should open showing "open project" in the search entry field, list of documents on the left, with second one selected and displayed on the right.

1. Choose "Search"->"Help..." in the workbench. The search dialog should open, turning to help page.
2. Choose "open project" from the "Search Expression" drop down.
3. Click "Choose" button, to open working set selection dialog.  Click "New", to define new working set.
4. Chose "Help", click "Next", name your working set, and select "Platform Plug-in Developer Guide" from the top level, expand it, and deselect "Examples Guide".  Click "Finish", and "OK".
5. Click "Search".  The "Search" view should open showing less hits than in test I4.
6. Double click any result.  Ensure that browser opens showing search results.  The search toolbar should display "open project" (without quotes) in the search field, and "Search scope:" should be set to the name of the new working set.

1. Choose "Search"->"Help...".  The search dialog should open, turning to help page.
2. Type a query "close project" (without quotes), click "Search".
3. The "Search" view should open showing hits.
4. Choose "open project" from the drop down menu in the "Search" view.
5. The search results list should update with the hits for "open project" query.

1. Type "active link below" (no quotes) in the search field in the browser, 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. Switch to the workbench window, and ensure that a "Hello World" is being displayed in a dialog.

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.

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 hidding 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 5 buttons on the content toolbar (the toolbar is located above the page displaying help pages): Go Back, Go Forward, Synchronize Navigation, Bookmark document and Print Page.
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. (IE only) Double click on the toolbar of the main content frame. This should maximize that particular frame. Double click on its toolbar again, 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.

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 "Workspace save participation".
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 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. Type 'close project' (no quotes) in the query field in the browser.
4. 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.
5. Type a name for your new scope.  Close dialog windows, ensure that the scope name appears on the search tool bar.
6. Click "Go".  Verify that the document selected in step 3 of test S2 does not appear in the list of search results.
7. Click the Search Scope again and remove the scope you just defined. Click OK to close the dialog. The search bar should not have "All topics" in the Search Scope.

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 slighlty different: if you use Mozilla 1.0 and 1.1, the keybinding are similar to those in Internet Explorer on Windows. If you use Mozilla 1.2 then 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 1.0, the default browser adapter for Netscape 4.x has very little accessibility support, both for fonts/colours and for keyboard navigation.

1. Observe if the colours and fonts match your system settings. Window backgrounds for navigation views (Contents/Search Results/Links/Bookmarks) should match the system window colour (usually white on Windows and gray on Linux). The toolbars should match the button face colour (usually gray). The font should match the system icon font. Highlight colour should match the system highlight colour.
2. Change your system colours/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 print the current page or active frame, press CTRL-P.

1. Press F1 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 in the Navigator view. When the infopop comes up, press tab to cycle around the link. 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_2.1.0/help.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, and with Advanced Search instead of Search Scope.
3. Perform ad-hoc testing or follow the steps for the regular workbench scenarios, with the exception of working sets, bookmarks, infopop and livehelp..
4. Shutdown the infocenter by running: java -cp plugins/org.eclipse.help_2.1.0/help.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_2.1.0/help.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 livehelp.
3. Shutdown the standalone help by running: java -cp plugins/org.eclipse.help_2.1.0/help.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.