platform-help-home/testing/scenarios.html

Parent Directory Parent Directory | Revision Log Revision Log

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

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