alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

<?xml version="1.0" encoding="UTF-8"?>
<cheatsheet title="Searching documentation, basic scenario">
   <intro>
      <description>
         Basic tests for search
      </description>
   </intro>
   <item title="Simple search" dialog="false" skip="false">
      <description>
         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.
      </description>
   </item>
   <item title="Select result" dialog="false" skip="false">
      <description>
         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.
      </description>
   </item>
   <item title="Highlighting Button" dialog="false" skip="false">
      <description>
         Test that highlighting can be turned on and off
      </description>
      <subitem label="Verify that there is an enabled button "Highlight search items"" skip="false">
      </subitem>
      <subitem label="Turn off highlighting by pressing the button." skip="false">
      </subitem>
      <subitem label="Turn on highlighting by pressing the button again." skip="false">
      </subitem>
   </item>
   <item title="Open result" dialog="false" skip="false">
      <description>
         Click on each result. You should see the page for that result open.
      </description>
   </item>
   <item title="Narrow Search" dialog="false" skip="false">
      <description>
         Let's narrow the results by book.
      </description>
      <subitem label="Click on the "Scope" link in the search bar. This should launch the Select Scope Search dialog that let's use define search list." skip="false">
      </subitem>
      <subitem label="Click on "New" to launch the dialog for defining a new search list." skip="false">
      </subitem>
      <subitem label="Enter the name "workbench" and select the "Workbench User Guide", click OK to close the dialog." skip="false">
      </subitem>
      <subitem label="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)." skip="false">
      </subitem>
   </item>
   <item title="Check search scope" dialog="false" skip="false">
      <description>
         The dialog should be closed 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.
      </description>
   </item>
   <item title="Search again" dialog="false" skip="false">
      <description>
         Search again for the same word, "Workspace save participation". You should see fewer results.
      </description>
   </item>
   <item title="Select an item" dialog="false" skip="false">
      <description>
         Select the "Minimizing data loss from crashes" hit, and click on the "Refresh" 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 "Minimizing data loss from crashes" topic.
      </description>
   </item>
   <item title="Redisplay search results" dialog="false" skip="false">
      <description>
         Click the "Search Results" tab at the bottom of the navigation tree. This should redisplay the search result you've seen in "Search Again"
      </description>
   </item>
   <item title="Show TOC" dialog="false" skip="false">
      <description>
         Click on the "Contents" tab at the bottom of the navigation tree. This should redisplay the navigation tree as you left it before switching to the search results tab.
      </description>
   </item>
</cheatsheet>
... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2024 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.