Testing Scenarios for Help
Author: eclipse.org

# Tests which have been converted to cheat sheets

Last updated 5/24/2007

## These tests have all been converted to cheat sheets. If possible use the cheat sheet instead which contains the most current version of these tests.

## Help

### Scenario A: Integration with the workbench

These tests exercise interactions with help system from workbench.

NOTE this scenario is part of the UA test cheatsheet.

#### A1: Help browser preferences:

1. Launch "Window"->"Preferences" ("Eclipse"->"Preferences" on Mac). 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. On Mac, the external browser is always used, so this option is omitted.

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.

#### A2: Displaying help preferences:

1. Press "F1" key (Ctrl+F1 on GTK, Help on Mac) 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 Mac) 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.

#### A3: Opening / closing help browser:

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

#### A4: Search:

1. Choose "Search" from the workbench Help menu. 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.

#### A7: Live help:

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 on the "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.

#### A8: Appserver preferences:

1. Launch "Window"->"Preferences" ("Eclipse"->"Preferences" on Mac). 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.

#### A9: Workbench Capabilities in Help

1. Launch "Window"->"Preferences" ("Eclipse"->"Preferences" on Mac). 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.

#### A10: Dialog help:

1. Open the preferences dialog

2. Click on the help button (?) at the lower left part of the dialog

3. Confirm the help tray opens and is usable. Try All Topics, search, bookmarks.

4. Close the tray.

5. Verify that clicking the help button (?) behaves the same way as pressing F1.

6. Try with a dialog that is not resizable. It should show the yellow sticky.

7. Try with a resizable dialog that is short. The dialog should grow a bit to accommodate the tray, then go back to original size when closed.

8. Open the help tray, then close the dialog without explicitly closing the tray.

9. Confirm the dialog properly remembers its size (if applicable to that dialog) and does not include the tray as part of its size.

#### A11: Dynamic content:

1. Find some XHTML docs in the help system (you’ll have to import plugin in workspace and look for the .xhtml file extension)

2. Open these docs in the help window and help view; make sure they appear correctly.

3. Open the markup and find the parts that are filtered (e.g. there might be a windows only section)

4. Confirm the parts are filtered from the non-applicable platforms. E.g. if it’s windows only, should only be visible on windows

5. Search for a word in the XHTML doc. It should show up as a potential hit.

6. Change preferences (Help preferences page) to show actual hits.

7. Repeat the same search. It should only find the result if the word is visible in the doc. E.g. on windows it should find it, on linux it shouldn’t.

#### A12: Keyword Index:

1. Download and extract the test files zip from http://www.eclipse.org/eclipse/platform-ua/testing/test_files.zip

2. Extract the /help/org.eclipse.help.index.test.zip and place the test plugin in your plugins dir; restart workbench

3. Open Help -> Help Contents

4. Verify that there’s a new index tab at the bottom left.

5. Open it, verify the proper functioning of the index view; make sure it’s usable, easy to understand

6. Type some keywords, open the docs, etc.

7. Do the same in the help view.

#### A13: Command links:

1. Browse the platform user docs and look for links that perform actions. For example, opening a preference page, etc.

2. Click on the links in both the help window and help view

3. Confirm: The actions are performed successfully

4. Confirm: The command links have a special appearance that distinguish them from other links

5. When clicking on a link to open a dialog from help window, dialog is visible

### Scenario B: Navigation and browsing

NOTE this scenario is part of the UA test cheatsheet.

1. The main things to look for here are:

2. moving around the navigation views (Contents, Search Results, Links, Bookmarks)

3. opening a book, expanding/collapsing/selecting topic nodes

4. navigating links inside the help pages

5. using toolbar actions for displaying the main table of contents, for hiding or maximizing the navigation frame, for topic/navigation synchronization, printing

6. 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.

#### B1: 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.

#### B2: Document toolbar actions:

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.

#### B3: Searching documentation, basic scenario:

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.

### Scenario C: Search

NOTE this scenario is part of the UA test cheatsheet.

This part test support for advanced search. Perform search either from "Help" page on Eclipse "Search" dialog opened by "Search"->"Search..." and turning to Help page or from the browser opened by "Help"-"Help Contents".

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.

5. Exact search:

6. Search for ' "close project" ' (in double quotes). The search results list should be shorter than in step 1.

7. The documents should contain consecutive words close and project (possibly separated by a punctuation).

8. Search scope

9. Search for 'close project' (no quotes). The search results list will show hits.

10. 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.

11. 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 unchecked.

12. Type a name for your new scope. Close dialog windows, ensure that the scope name appears on the search tool bar.

13. Click "Go". Verify that the document selected in step 3 does not appear in the list of search results.

14. 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.