platform-help-home/testing/scenarios.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.42 - (view) (download) (as text)

1 : kkolosow 1.13 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
2 : dbirsan 1.1 <html>
3 : dbirsan 1.6 <head>
4 : kkolosow 1.13 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5 :     <meta name="Author" content="eclipse.org">
6 :     <meta name="GENERATOR" content="Mozilla/4.79 [en] (Windows NT 5.0; U) [Netscape]">
7 :     <title>Testing Scenarios for Help</title>
8 :     <link rel="stylesheet" href="http://www.eclipse.org/default_style.css" type="text/css">
9 : dbirsan 1.6 </head>
10 : kkolosow 1.13 <body>
11 :    
12 : dbirsan 1.6 <h1 style="background-color: rgb(0,128,192); background-image: none; background-repeat: repeat; background-attachment: scroll; color: rgb(255,255,255); ">
13 : kkolosow 1.35 Testing Scenarios for Help System</h1>
14 : kkolosow 1.13
15 :     <h2>
16 :     <b>Objectives</b></h2>
17 :     This is a quick run through most of the end-user functionality of the eclipse
18 :     help system and the info-center scenario. The following are the main focus
19 :     areas for testing help:
20 :     <ol>
21 :     <li>
22 :     integration with the workbench: launching from help menu, help search,
23 :     and context-sensitive help (F1)</li>
24 :    
25 :     <li>
26 :     navigation and browsing of topics in the help view</li>
27 :    
28 :     <li>
29 :     search support: in the workbench and in the help view</li>
30 :    
31 :     <li>
32 :     accessibility</li>
33 :     </ol>
34 : kkolosow 1.38 <BR>
35 : kkolosow 1.13 <h3>
36 :     Integration with the workbench</h3>
37 : kkolosow 1.15 These tests exercise interactions with help system from workbench.
38 : kkolosow 1.13 <p>I1: Help preference page:
39 :     <ol>
40 :     <li>
41 :     Launch "Window"->"Preferences".&nbsp; Preferences dialog will open.</li>
42 :    
43 :     <li>
44 :     Choose "Help" on the left.&nbsp; This should show help preference page
45 : kkolosow 1.34 on the right</li>
46 : kkolosow 1.25
47 : kkolosow 1.34 <li> On Windows and Linux help uses embedded browser, and the preference
48 :     should
49 :     contain
50 :     a
51 :     checkbox
52 :     to
53 :     force
54 :     external
55 :     browser.</li>
56 :     <li>The preference page should also display a
57 :     list
58 :     of
59 :     external
60 :     browser
61 :     adapters. The
62 :     list
63 :     should
64 :     have
65 :     one or two browser adapter names, and the radio button besides one of them
66 :     should be selected: on Windows it should be the &quot;Default System Browser&quot;,
67 :     on Linux/Solaris/HP/Aix it should be the &quot;Mozilla Adapter&quot; or &quot;Netscape
68 :     Adapter&quot; if Mozilla is not installed and Netscape is, on MacOS it should be
69 :     &quot;Default Web Browser&quot;.</li>
70 : kkolosow 1.25 <li>
71 :     Choose "Help"->"Help" Contents" from the workbench menu, ensure a browser
72 :     opens and displays Help.</li>
73 :    
74 :     <li>
75 : kkolosow 1.34 Go back to help preferences, select &quot;Always use external browser&quot; and select
76 :     &quot;custom browser&quot; adapter.&nbsp; Click "Browse"
77 : kkolosow 1.25 at the bottom of a page and find an browser executable program (for example
78 :     "C:\Program Files\mozilla.org\Mozilla\mozilla.exe".Click "OK".</li>
79 :    
80 :     <li>
81 :     Choose "Help"->"Help" Contents" from the workbench menu, ensure a browser
82 :     opens and displays Help.</li>
83 :    
84 :     <li>
85 :     Go back to help preferences.&nbsp; If you have more browser adapters available,
86 :     try selecting each browser adapter and launch help.</li>
87 :    
88 : kkolosow 1.13 <li>
89 : kkolosow 1.34 When finished, restore defaults in the the browser preference page.</li>
90 : kkolosow 1.13 </ol>
91 : kkolosow 1.25 I2: F1 info-pop:
92 : kkolosow 1.13 <ol>
93 :     <li>
94 : kkolosow 1.38 Press "F1" key (Ctrl+F1 on GTK, Help on carbon) in the workbench "Navigator" view
95 :     ("Resources" perspective).
96 : kkolosow 1.25 This should launch the info-pop with some text and two related links. Focus
97 : kkolosow 1.13 should be on the first link ("Views").</li>
98 :    
99 :     <li>
100 :     Click "Navigator View" link.&nbsp; This should launch help web browser,
101 : kkolosow 1.15 and display "Navigator View" document on the right and the list of related
102 :     topics on the left.&nbsp; The link called "Navigator View" should be selected.</li>
103 : kkolosow 1.13 </ol>
104 : kkolosow 1.15 I3: Opening / closing help browser:
105 : kkolosow 1.13 <ol>
106 :     <li>
107 :     Without closing the browser that opened in test case I2, choose "Help"->"Help"
108 : kkolosow 1.15 Contents" from the workbench menu.&nbsp; No new browser window should launch,
109 : kkolosow 1.13 and the existing help browser should load the table of contents, with lists
110 :     of books on the left, and "Welcome to Eclipse help" document on the right.</li>
111 :    
112 :     <li>
113 : kkolosow 1.15 Close the help browser.&nbsp; Browser window should close.</li>
114 : kkolosow 1.34 <li>Open a workbench preferences, press F1 (Ctrl+F1 on GTK, Help on carbon).
115 :     Select a related link. Help should open in external browser (even when help
116 :     preference &quot;always use external browser&quot; checkbox is present on preference
117 :     page and deselected).</li>
118 : kkolosow 1.13 </ol>
119 :     I4: Search Dialog:
120 :     <ol>
121 :     <li>
122 :     Choose "Search"->"Search..." from the workbench menu.&nbsp; Click "Help
123 :     Search" tab.&nbsp; Help search page should open.</li>
124 :    
125 :     <li>
126 :     Type a query "open project" (without quotes), click "Search".</li>
127 :    
128 :     <li>
129 : kkolosow 1.15 Assuming this is first help search since installing workbench, progress
130 :     indicator will display status of document indexing.</li>
131 : kkolosow 1.13
132 :     <li>
133 : kkolosow 1.34 Click "Cancel".&nbsp;&nbsp; the indexing should stop.</li>
134 : kkolosow 1.13
135 :     <li>
136 : kkolosow 1.39 Choose "Search"->"Search..." from the workbench menu.&nbsp; Turn to Help Search page.</li>
137 : kkolosow 1.13
138 :     <li>
139 :     Choose "open project" from the "Search Expression" drop down. Click "Search".&nbsp;
140 : kkolosow 1.34 The "Search" dialog should close, and progress dialog open.&nbsp;
141 :     Click to move progress to the background. Wait for
142 :     indexing to finish.&nbsp; The search results view should be activated and populated
143 : kkolosow 1.39 with search results sorted by relevance from 100%, descending.</li>
144 : kkolosow 1.13
145 :     <li>
146 : kkolosow 1.15 Double click on the second item from the top.&nbsp; The help browser should
147 : kkolosow 1.13 open showing "open project" in the search entry field, list of documents
148 : kkolosow 1.15 on the left, with second one selected and displayed on the right.</li>
149 : kkolosow 1.13 </ol>
150 : kkolosow 1.34 I5:&nbsp; Search dialog help books filtering:
151 : kkolosow 1.13 <ol>
152 :     <li>
153 : kkolosow 1.34 Choose "Search"->"Search..." from the workbench menu.&nbsp; Click "Help
154 :     Search" tab.</li>
155 : kkolosow 1.13
156 :     <li>
157 :     Choose "open project" from the "Search Expression" drop down.</li>
158 :    
159 :     <li>
160 : kkolosow 1.25 Click "Choose" button, to open working set selection dialog.&nbsp; Click
161 :     "New", to define new working set.</li>
162 :    
163 :     <li>
164 :     Chose "Help", click "Next", name your working set, and select "Platform
165 :     Plug-in Developer Guide" from the top level, expand it, and deselect "Examples
166 :     Guide".&nbsp; Click "Finish", and "OK".</li>
167 : kkolosow 1.13
168 :     <li>
169 :     Click "Search".&nbsp; The "Search" view should open showing less hits than
170 :     in test I4.</li>
171 : kkolosow 1.25
172 :     <li>
173 :     Double click any result.&nbsp; Ensure that browser opens showing search
174 :     results.&nbsp; The search toolbar should display "open project" (without
175 :     quotes) in the search field, and "Search scope:" should be set to the name
176 :     of the new working set.</li>
177 : kkolosow 1.13 </ol>
178 :     I6:&nbsp; Search from search view:
179 :     <ol>
180 :     <li>
181 : kkolosow 1.34 Choose "Search"->"Search..." from the workbench menu.&nbsp; Click "Help
182 :     Search" tab.&nbsp; </li>
183 : kkolosow 1.13
184 :     <li>
185 :     Type a query "close project" (without quotes), click "Search".</li>
186 :    
187 :     <li>
188 :     The "Search" view should open showing hits.</li>
189 :    
190 :     <li>
191 :     Choose "open project" from the drop down menu in the "Search" view.</li>
192 :    
193 :     <li>
194 :     The search results list should update with the hits for "open project"
195 :     query.</li>
196 : kkolosow 1.25 </ol>
197 :     I7:&nbsp; Live help:
198 :     <ol>
199 :     <li>
200 :     Type "active link below" (no quotes) in the search field in the browser,
201 :     and search.</li>
202 :    
203 :     <li>
204 :     Choose a document titled "Active help" from the search results.</li>
205 :    
206 :     <li>
207 :     Click once "Click here for a Message" link at the bottom of the document.</li>
208 :    
209 :     <li>
210 :     Switch to the workbench window, and ensure that a "Hello World" is being
211 :     displayed in a dialog.</li>
212 :     </ol>
213 :     I8:&nbsp; Appserver preferences:
214 :     <ol>
215 : kkolosow 1.35 <li> Launch "Window"->"Preferences".&nbsp; Preferences dialog will open.</li>
216 :     <li> Choose "Help/Help Server" on the left.&nbsp; Enter a port number (for
217 :     example 2003), in the second field.&nbsp; Click O.K.</li>
218 :     <li> Restart workbench. Launch help from the menu.&nbsp; Ensure browser opens
219 :     and displays help content.</li>
220 :     <li> Go back to Help Server preferences, click "Restore defaults" button, click "OK",
221 :     restart workbench.</li>
222 :     </ol>
223 :     I9:&nbsp; Workbench Capabilities
224 :     in Help
225 :     <ol>
226 : kkolosow 1.36 <li> Launch "Window"->"Preferences".&nbsp; Open &quot;Workbench&quot;-&gt;&quot;Capabilities preference
227 : kkolosow 1.35 page.</li>
228 :     <li>Select all capabilities and deselect &quot;Plug-in Development&quot;.</li>
229 :     <li>In the workbench Open Intro, by selecting Help-&gt;Welcome from the menu.</li>
230 :     <li>Follow &quot;Overview&quot;-&gt;&quot;Eclipse Plug-in Development&quot; links. This should open
231 :     help (without &quot;PDE Guide&quot; book displayed), and a dialog asking whether all
232 :     topics should be shown.</li>
233 :     <li>Click &quot;Yes&quot;. Verify that PDE Guide appeared and a topic was selected. Check
234 :     that &quot;Show All Topics&quot; button in the navigation toolbar is pressed.</li>
235 :     <li> Turn off showing all topics. Verify that PDE Guide disappeared, since
236 : kkolosow 1.36 it is not enabled in workbench capabilities.</li>
237 : kkolosow 1.35 <li>Perform search for &quot;PDE&quot;. Verify there no or next to no results.</li>
238 :     <li>Select &quot;Show All Topics&quot;. Confirm when a dialog pops up. Verify that search
239 :     results were populated with more hits (coming from PDE Guide).</li>
240 : kkolosow 1.13 </ol>
241 : kkolosow 1.38 <BR>
242 : kkolosow 1.13 <h3>
243 :     Navigation and browsing</h3>
244 :     The main things to look for here are:
245 : dbirsan 1.9 <ul>
246 : kkolosow 1.13 <li>
247 : dbirsan 1.23 moving around the navigation views (Contents, Search Results, Links, Bookmarks)</li>
248 : kkolosow 1.13
249 :     <li>
250 :     opening a book, expanding/collapsing/selecting topic nodes</li>
251 :    
252 :     <li>
253 :     navigating links inside the help pages</li>
254 :    
255 :     <li>
256 : kkolosow 1.36 using toolbar actions for displaying the main table of contents, for hiding or
257 :     maximizing the navigation frame, for topic/navigation synchronization, printing</li>
258 : kkolosow 1.13
259 :     <li>
260 : dbirsan 1.23 performing simple searching.</li>
261 : dbirsan 1.9 </ul>
262 : kkolosow 1.13
263 : dbirsan 1.23 <P>Note: this test is to be done on browser adapters that are based on Internet Explorer or Mozilla. For other browser, refer to the &quot;basic&quot; test.</P>
264 : kkolosow 1.13 <p><br>N1: Basic topic navigation:
265 : dbirsan 1.6 <ol>
266 : kkolosow 1.13 <li>
267 :     Launch help from the workbench menu: Help->Help Contents. This should open
268 :     the help view to the main bookshelf that lists the available books.</li>
269 :    
270 :     <li>
271 :     In the Contents page select the Workbench User Guide book. This should
272 : dbirsan 1.23 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).</li>
273 : kkolosow 1.13
274 :     <li>
275 : dbirsan 1.24 In the table of contents tree navigate to Concepts ->Workbench. Selecting
276 :     the &quot;Workbench&quot; topic should show some content in the main help area.</li>
277 : kkolosow 1.13
278 :     <li>
279 : dbirsan 1.24 Click on the "Features" link in the displayed document.
280 : kkolosow 1.13 This should load a new document.</li>
281 : dbirsan 1.23 </ol>
282 :    
283 :    
284 :     N2: Document toolbar actions:
285 : kkolosow 1.13
286 : dbirsan 1.23 <ol>
287 :     <li>
288 : kkolosow 1.13
289 : kkolosow 1.34 Identify the 6 buttons on the content toolbar (the toolbar is located above
290 : dbirsan 1.23 the page displaying help pages): Go Back, Go Forward, Synchronize Navigation,
291 : kkolosow 1.34 Bookmark document, Print Page, and Maximize.</li>
292 : dbirsan 1.23 <LI>Click the Back button in the content toolbar. This should reload
293 : dbirsan 1.24 the previous document (Workbench).</LI>
294 : kkolosow 1.13
295 : dbirsan 1.23 <li>
296 :     Click the Forward button in the content toolbar. This should reload the
297 : dbirsan 1.24 document ("Features&quot;).</li>
298 : kkolosow 1.13
299 : kkolosow 1.34 <LI>Click maximize icon on the toolbar of the main content
300 :     frame. This should maximize that particular frame, and &quot;Restore&quot; icon should
301 :     be shown in place of &quot;Maximize&quot;. This time double click on the toolbar,
302 :     it should restore the original layout. The behavior should be similar to that
303 :     of the eclipse views.</LI>
304 : dbirsan 1.23
305 :     <LI>Click on the "Synchronize Navigation" button on the toolbar. This
306 : dbirsan 1.24 should highlight the &quot;Features&quot; topic in the navigation tree.</LI>
307 : dbirsan 1.23
308 :     <LI>Print the topic by clicking on the "Print Page" button on the
309 :     toolbar. This should launch the system print dialog and if you click OK
310 :     it should print the help page</LI>
311 : dbirsan 1.24 <LI>Bookmark the current page, by pressing the &quot;Bookmark document&quot; button on the toolbar.</LI>
312 :     <LI>Turn to the Bookmarks tabs and verify it is added there.</LI>
313 :     <LI>Turn to the Contents tab and select another topic</LI>
314 :     <LI>Turn to the Bookmarks tab and click on the bookmarked topic (Features). This should load that topic in the main content area.</LI>
315 : kkolosow 1.34 <LI>Remove bookmark: Select the bookmark topic, right click and select Remove,
316 :     or choose &quot;Remove bookmark&quot; from the bookmark view toolbar.</LI>
317 :     <LI>Add more bookmarks, delete them all using &quot;Remove all bookmarks&quot; button
318 :     or action on the pop-up menu.</LI>
319 : kkolosow 1.13 </ol>
320 : dbirsan 1.23 N3: Searching documentation, basic scenario:
321 : kkolosow 1.13 <ol>
322 :     <li>
323 : dbirsan 1.23 In the Search entry field enter the word "participation" without the double
324 :     quotes. The navigation frame should turn to the Search Results view, and if this was the
325 : kkolosow 1.13 first time you search the docs, you should see the indexing progress monitor
326 :     in that page. When indexing is finished (or right away if other searches
327 : dbirsan 1.23 were performed before) you should get the results. In my case, I got 14
328 : kkolosow 1.34 hits, starting with "Synchronize View Integration".</li>
329 : kkolosow 1.13
330 :     <li>
331 : dbirsan 1.23 Select a search result: "Workspace save participation". You should
332 :     see the "participation" string highlighted, as well as &quot;particip&quot;. This is because the search engine
333 : kkolosow 1.13 uses word stemming on English, so the highlighting respects the same stemming
334 :     algorithm.</li>
335 :    
336 :     <li>
337 : kkolosow 1.14 Click on each results. You should see the toolbar title changing to show
338 : dbirsan 1.12 the book containing the document.</li>
339 : kkolosow 1.13
340 :     <li>
341 : dbirsan 1.23 Let's narrow the results by book: click on the "Scope" link in the search
342 :     bar. This should launch the Select Scope Search dialog that let's use define search list. Click on &quot;New&quot; to launch the dialog for defining a new search list. Enter the name &quot;workbench&quot; and select the &quot;Workbench User Guide&quot;, click OK to close the dialog. The name &quot;workbench&quot; should now be visible in the list in the Select Scope Search dialog. Select it, and click OK (or double click instead).</li>
343 : kkolosow 1.13
344 :     <li>
345 : dbirsan 1.23 This should close the dialog and the Search Scope should now display the name &quot;workbench&quot;. Note: Sometimes the search bar is not updated right away, so you may have to wait a bit. Search again for the same word, &quot;participation&quot;. You should see fewer results (I see 2 hits only).</li>
346 : kkolosow 1.13
347 :     <li>
348 : dbirsan 1.23 Select the &quot;Crash recovery&quot; hit, and click on "Synchronize Navigation" button
349 : kkolosow 1.34 on the navigation or content toolbar. This should switch the navigation view
350 :     to
351 :     the
352 :     Contents
353 : dbirsan 1.23 view, and expand the Workbench User Guide down to the "Crash recovery" topic.</li>
354 : kkolosow 1.13
355 :     <li>
356 :     Click the "Search Results" tab at the bottom of the navigation tree. This
357 : dbirsan 1.23 should redisplay the search result you've seen in step 5.</li>
358 : kkolosow 1.13
359 :     <li>
360 :     Click on the "Contents" tab at the bottom of the navigation tree. This
361 : dbirsan 1.23 should redisplay the navigation tree as you left it after step 6.</li>
362 : kkolosow 1.13 </ol>
363 :    
364 : kkolosow 1.38 <BR>
365 : kkolosow 1.36 <h3>Search</h3>
366 : kkolosow 1.14 This part test support for advanced search.&nbsp; Perform search either
367 : kkolosow 1.34 from "Help" page on Eclipse "Search" dialog opened by "Search"->"Search..." and
368 :     turning to Help page
369 : kkolosow 1.14 or from the browser opened by "Help"-"Help Contents".
370 :     <p>S1: Boolean search:
371 :     <ol>
372 :     <li>
373 :     Search for 'project close' (no quotes).&nbsp; Documents should be found
374 :     containing both words.&nbsp; Selecting document should show its contents
375 :     with occurrences of both words highlighted.</li>
376 :    
377 :     <li>
378 : kkolosow 1.30 Search for 'project AND close' (no quotes).&nbsp; The results should be
379 :     same as for the previous query</li>
380 : kkolosow 1.14
381 :     <li>
382 :     Search for 'project OR close' (no quotes).&nbsp; The list of hits should
383 :     be much longer, with some documents at the top containing both words, and
384 :     documents down the list containing only one of them.</li>
385 :    
386 :     <li>
387 :     Search for 'project close not navigator' (no quotes).&nbsp; The list of
388 : dbirsan 1.18 hits should be smaller than in step 1 of test S1.</li>
389 : kkolosow 1.14 </ol>
390 : kkolosow 1.30 S2: Exact search:
391 : kkolosow 1.14 <ol>
392 :     <li>
393 :     Search for ' "close project" ' (in double quotes).&nbsp; The search results
394 : dbirsan 1.18 list should be shorter than in step 1 of test S1.</li>
395 : kkolosow 1.14
396 :     <li>
397 : kkolosow 1.30 The documents should contain consecutive words close and project (possibly
398 :     separated by a punctuation).</li>
399 : kkolosow 1.14 </ol>
400 : kkolosow 1.30 S3: Search scope
401 : kkolosow 1.14 <ol>
402 :     <li>
403 :     Search for 'close project' (no quotes).&nbsp; The search results list will
404 :     show hits.</li>
405 :    
406 :     <li>
407 :     Select a document.&nbsp; Note the book the topic belongs to.&nbsp; The
408 :     book name is displayed on the toolbar in the browser, directly above the
409 :     document.</li>
410 :    
411 : kkolosow 1.34 <li> Click "Search scope:".&nbsp; The scope selection window will open.&nbsp;
412 : kkolosow 1.30 Click "New", Select some books or sections, but leave the book that was
413 :     noted in step 2 of test S3 unchecked.</li>
414 : kkolosow 1.14
415 :     <li>
416 : kkolosow 1.30 Type a name for your new scope.&nbsp; Close dialog windows, ensure that
417 :     the scope name appears on the search tool bar.</li>
418 :    
419 :     <li>
420 :     Click "Go".&nbsp; Verify that the document selected in step 3 of test S2
421 :     does not appear in the list of search results.</li>
422 : kkolosow 1.40 <LI>Click the Search Scope again and remove the scope you just defined. Click OK to close the dialog. The search bar should now have &quot;All topics&quot; in the Search Scope.</LI>
423 : kkolosow 1.14 </ol>
424 :    
425 : kkolosow 1.38 <BR>
426 : kkolosow 1.37 <h3>Customization</h3>
427 :     <p>C1: Help preferences / large book browsing
428 : kkolosow 1.42 <p>Back up a file eclipse/plugins/org.eclipse.help.base_3.0.0/preferences.ini. Open
429 :     the preferences.ini and change values of selected options listed below to
430 : kkolosow 1.37 the values shown here:
431 : kkolosow 1.36 <p>banner=/org.eclipse.help.webapp/advanced/banner.html
432 :     <br>
433 :     banner_height=60
434 :     <br>help_home=http://www.eclipse.org
435 :     <br>linksView=false
436 :     <br>bookmarksView=false
437 :     <br>windowTitlePrefix=false
438 :     <br>loadBookAtOnceLimit=10
439 :     <br>dynamicLoadDepthsHint=2
440 :     <br>advanced.toolbarBackground=green
441 :     <br>advanced.viewBackground=yellow
442 :     <br>advanced.toolbarFont=bold
443 :     <br>advanced.viewFont=italic
444 :     <br>showDisabledActivityTopics=never
445 :     <br>activeHelp=false
446 :     <ol>
447 :     <li> Launch help from the workbench menu: Help->Help Contents. This should
448 :     open the help browser. Verify existence of banner frame above search toolbar.</li>
449 :     <li> The page displayed in the content frame should be eclipse.org page.</li>
450 :     <li> Verify there is only Contents and Search tabs at the bottom of navigation
451 :     frame, other views (Links and Bookmarks) are not present.</li>
452 :     <li> Verify the browser title shows product name.</li>
453 :     <li>Browse navigation tree. There can be small delay expanding second, fourth,
454 :     etc level of topics. Verify branches expand correctly.</li>
455 :     <li>Verify help UI background is yellow, and green in the toolbars.</li>
456 :     <li>Verify fonts are bold in the toolbars, and italic in the rest of the UI.</li>
457 :     <li>Launch "Window"->"Preferences".&nbsp; Open &quot;Workbench&quot;-&gt;&quot;Capabilities
458 :     preference page. Select all capabilities and deselect &quot;Plug-in Development&quot;.</li>
459 :     <li>Re launch Help. Verify &quot;PDE Guide&quot; book is not displayed and &quot;Show All
460 :     Topics&quot; button is not displayed.</li>
461 :     <li> Type "active link below" (no quotes) in the search field in the browser,
462 :     and search.</li>
463 :     <li> Choose a document titled "Active help" from the search results.</li>
464 :     <li> Click once "Click here for a Message" link at the bottom of the document.</li>
465 :     <li>Verify a message informing that active help is not enabled is displayed,
466 :     and &quot;Hello World&quot; workbench dialog does not appear.</li>
467 : kkolosow 1.37 <li>Restore plugins/org.eclipse.help.base_3.0.0/preferences.ini from the backup
468 :     file.</li>
469 : kkolosow 1.36 </ol>
470 : kkolosow 1.37 <p>C2: BIDI
471 :     <ol>
472 :     <li> Launch eclipse passing &quot;-dir rtl&quot; option on the command line. Open Help.</li>
473 :     <li>Verify Help UI is rendered right to left.</li>
474 :     </ol>
475 : kkolosow 1.38 <BR>
476 : kkolosow 1.37 <h3>Accessibility</h3>
477 : kkolosow 1.14 Accessibility support should test for how the help view
478 : dbirsan 1.9 <ul>
479 : kkolosow 1.13 <li>
480 : kkolosow 1.15 uses system colors and fonts,</li>
481 :    
482 :     <li>
483 :     uses browser's accessibility support,</li>
484 :    
485 :     <li>
486 :     can be navigated using only the keyboard.</li>
487 :     </ul>
488 :     <b>Note: Platform considerations for the accessibility tests:</b>
489 :     <ul>
490 :     <li>
491 :     <b>on Windows things should work as described;</b></li>
492 : kkolosow 1.13
493 :     <li>
494 : kkolosow 1.36 <b>on Linux using the Mozilla browser adapter keyboard navigation works slightly
495 : kkolosow 1.34 different: Ctrl-Tab and Ctrl-Shift-Tab are to be replaced by Ctrl-F6 and Ctrl-Shift-F6
496 :     (this is for frame navigation, see below).</b></li>
497 : kkolosow 1.13
498 :     <li>
499 : kkolosow 1.34 <b>on Solaris/AIX/HP, unless you use Mozilla, the default browser adapter
500 : kkolosow 1.36 for Netscape 4.x has very little accessibility support, both for fonts/colors
501 : kkolosow 1.15 and for keyboard navigation.</b></li>
502 : dbirsan 1.9 </ul>
503 : kkolosow 1.36 A1: System colors and fonts:
504 : dbirsan 1.9 <ol>
505 : kkolosow 1.13 <li>
506 : kkolosow 1.36 Observe if the colors and fonts match your system settings. Window backgrounds
507 :     for navigation views (Contents/Search Results/Links/Bookmarks) should match the
508 :     system
509 :     window co lour (usually white on Windows and gray on Linux). The toolbars
510 :     should match the button face co lour (usually gray). The font should match
511 :     the system icon font. Highlight co lour should match the system highlight co
512 :     lour.</li>
513 : kkolosow 1.13
514 :     <li>
515 : kkolosow 1.36 Change your system colors/font settings and see if the changes take effect.</li>
516 : kkolosow 1.13
517 :     <li>
518 :     On Windows, try the high contrast settings: Control Panel -> Accessibility
519 :     Options -> Display - > Use high contrast.</li>
520 :     </ol>
521 : kkolosow 1.15 A2: Browser accessibility support:
522 : kkolosow 1.13 <ol>
523 :     <li>
524 :     Windows: in IE - > Tools-> Internet Options -> General ->Accessibility
525 : kkolosow 1.15 play with the settings for Format. Help should behave accordingly.</li>
526 : kkolosow 1.13
527 :     <li>
528 : kkolosow 1.15 DO NOT turn off style sheet support, help will not work well.</li>
529 : kkolosow 1.13 </ol>
530 : kkolosow 1.15 A3: Navigation with keyboard only:
531 : kkolosow 1.13 <br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Here are the keyboard navigation rules
532 :     for help (as supported by browsers):
533 : kkolosow 1.34 <blockquote>
534 :     <p>- To move to the next topic in the left frame, press TAB or DOWN arrow.
535 :     <br>
536 :     - To move to the previous topic , press SHIFT-TAB or UP arrow.
537 :     <br>
538 :     - To expand/collapse a tree node press RIGHT/LEFT arrow.
539 :     <br>
540 :     - Press Enter to select a topic and have its content displayed
541 :     <br>
542 :     - To scroll all the way up/down press HOME/END.
543 :     <br>
544 :     - To go back/forward press ALT-LEFT/RIGHT ARROW
545 :     <br>
546 :     - To go to the next frame (there are quite a number of frames in the
547 : kkolosow 1.13 help
548 : kkolosow 1.34 <br>
549 :     system) press CTRL-TAB (On Mozilla 1.2 press Ctrl-F6).
550 :     <br>
551 :     - To move to previous frame, press SHIFT-CTRL-TAB (On Mozilla &gt;1.2 press
552 :     Ctrl-Shift-F6).<br>
553 :     - To move to content frame, press ALT-K, and press Tab to place focus inside
554 :     the topic<br>
555 :     - To print the current page or active frame, press CTRL-P.</p>
556 :     </blockquote>
557 : kkolosow 1.13 A4: F1 infopop keyboard accessibility:
558 :     <ol>
559 :     <li>
560 : kkolosow 1.38 Press F1 (on GTK - Ctrl-F1, on carbon - Help key) in the workbench Navigator
561 :     view (Resources perspective). This should launch the infopop with some text
562 :     and
563 : kkolosow 1.36 two related
564 :     links. Focus
565 :     should
566 : kkolosow 1.15 be on the first link ("Views"). Click and the help view should open to
567 :     the selected topic.</li>
568 : kkolosow 1.13
569 :     <li>
570 : kkolosow 1.38 Get back to the workbench and press F1 again, in the Navigator view. When the
571 : kkolosow 1.34 infopop comes up, press down/up arrows (or tab) to cycle around the links. Press
572 :     Esc to dismiss
573 : kkolosow 1.13 the infopop.</li>
574 :     </ol>
575 :    
576 : kkolosow 1.34 A5: On Windows, use Windows Narrator (or JAWS if installed ), repeat
577 :     the
578 :     same
579 :     tests
580 :     and
581 :     see
582 :     if
583 : kkolosow 1.36 description an links read out correctly.<br>
584 : dbirsan 1.28 <BR>
585 :     <H3>Other Scenarios</H3>
586 : kkolosow 1.38 <P>In addition to the eclipse workbench help scenario, there are two other
587 : dbirsan 1.28 help uses scenarios: <A
588 :     href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/org.eclipse.platform.doc.isv/reference/misc/help_standalone.html">standalone
589 :     help</A> and <A
590 :     href="http://dev.eclipse.org/viewcvs/index.cgi/%7Echeckout%7E/org.eclipse.platform.doc.isv/reference/misc/help_infocenter.html">info-center</A>
591 : kkolosow 1.38 (server based) help.<BR><BR>
592 : dbirsan 1.28 <BR>
593 : kkolosow 1.38 IC: Infocenter</P>
594 : dbirsan 1.28 <OL>
595 : kkolosow 1.35 <LI>Assuming eclipse is installed as d:\eclipse, change directory to d:\eclipse
596 :     and run the following command: java -cp plugins/org.eclipse.help.base_3.0.0/helpbase.jar
597 :     org.eclipse.help.standalone.Infocenter -command start -data infocenter
598 :     -port 8888</LI>
599 :     <LI>Open a browser and navigate to http://localhost:8888/help. You should see
600 :     the help system, but without the links and bookmarks tabs.</LI>
601 :     <LI>Define a working set, search help. Close the browser and reopen. Verify
602 :     working sets are remembered.</LI>
603 :     <LI>Perform ad-hoc testing or follow the steps for the regular workbench scenarios,
604 : kkolosow 1.36 with the exception of bookmarks, infopop and active help.</LI>
605 : kkolosow 1.35 <LI>Shutdown the infocenter by running: java -cp plugins/org.eclipse.help.base_3.0.0/helpbase.jar
606 :     org.eclipse.help.standalone.Infocenter -command shutdown -data infocenter</LI>
607 : dbirsan 1.28 </OL>
608 :     <P><BR>SA: Stand-alone help
609 :     </P>
610 :     <OL>
611 : kkolosow 1.35 <LI>Assuming eclipse is installed as d:\eclipse, change directory to d:\eclipse
612 :     and run the following command: java -cp plugins/org.eclipse.helpbase_3.0.0/helpbase.jar
613 :     org.eclipse.help.standalone.Help -command displayHelp -data standalone</LI>
614 : kkolosow 1.36 <LI>The above command should automatically open the browser so you can browse
615 :     the help. Perform ad-hoc testing or follow the steps in the regular workbench
616 :     scenario, with the exception of infopop and active help.</LI>
617 : kkolosow 1.35 <LI>Shutdown the standalone help by running: java -cp plugins/org.eclipse.help.base_3.0.0/helpbase.jar
618 :     org.eclipse.help.standalone.Help -command shutdown -data standalone</LI>
619 : dbirsan 1.28 </OL>
620 :     <P><BR>B: Basic help ui (any browser with Javascript disabled or browsers other than IE, Mozilla or Netscape6+)
621 :     </P>
622 :     <OL>
623 :     <LI>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)</LI>
624 :     <LI>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)</LI>
625 :     <LI>Try ad-hoc testing or follow the regular workbench scenario steps above.</LI>
626 :     <LI>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 &quot;Properties&quot;. Check what the URL is.</LI>
627 :     </OL>
628 : kkolosow 1.13 </body>
629 :     </html>