Repository Full Text Search and Delivery Functional Specifications

1.      Main Screen: Text Collections

a.       A brief description of the Text Collections will appear at the top.

b.      Provide a keyword search box to search full text in centrally indexed text collections.

                                                   i.      Paired with radio buttons to select options to match all words ("All words") or any words ("Any word") when multiple words are entered in the keyword box.  "All words" is the default.

1.      Phrase searching (entering an entire phrase within quotation marks to be matched) is supported.

                                                 ii.      A drop-down box to select search scope.  The user may select to search across the entire text collection ("All Texts") or select one or more sub-collections (hard coded at this time) for more limited searches.  The default search will be "All Texts." 

                                                iii.      Drop-down option to select the number of results to appear on each screen of results ("25", "50", "100")

                                               iv.      No results display options are presented - results are automatically displayed in the Group by Work results format.

c.       Link to a Help Screen ("Search Tips")

                                                   i.      The Help Screen includes general description of the site navigation, basic search help, advanced search help, help for the results set navigation, including the Page Turner, and for the Resizer Applet.  The link from the basic search screen goes directly to the basic search help section via an anchor.

d.      Advanced search link ("Advanced Search")

                                                   i.      The Advanced Search Screen will contain a keyword box paired with a series of drop-down box containing element options for advanced searching, and providing support for performing either a compound or simple searching in a single form..

1.      Constraint by author name.

2.      Constraint by title.

3.      Date limiter; with two separate boxes to fill in a beginning year and an ending year.

4.      Search by Region limiter (varies by collection and markup; may not be a possible option for all texts).

5.      Search with Proximity settings:  A drop down box for the operator ("near", "not near", "followed by", "not followed by"), a drop down box with three or four options for character offset (TBD), and a box to enter the second word or words for the proximity match.

6.      A drop-down box to select search scope.  The user may select to search across the entire text collection ("All Texts") or select one or more sub-collections (hard coded at this time) for more limited searches.  The default search will be "All Texts." 

7.      Phrase searching (entering an entire phrase in quotation marks to be matched) is supported.

8.      Drop-down option to display results as grouped lists by work ("Group by work"), or of all matches ("group by match"), with grouped by work as the default.

9.      Drop-down option to select the number of results to appear on each screen of results ("25", "50", "100")

                                                 ii.      The screen will include brief advanced search instructions, and a link ("Search Tips") to more detailed advanced search help on the Help Screen via an anchor.

                                                iii.      The screen will include a link ("Basic Search") to the main basic search screen to search across all texts.

e.       Links to browse individual text collections ("Browse Text Collections").

                                                   i.      Users follow the link to a General Text Collections screen.  Each collection (hard-coded in this implementation) has a very brief phase to describe it and a link to a Specific Text Collection Screen.

1.      An option to browse the content of all Text Collections combined may be implemented.

                                                 ii.      Users may follow the link to a Specific Text Collection Screen, which will contain a brief narrative describing the collection and links to each of the texts within that collection (hard coded in this implementation), sorted by author, and within author by title.

1.      Clicking on a link takes the user to the Table of Contents for the full text, or to the first screen of the Page Image Browse if that is the only version available.

f.        Top navigation and institutional footer should be as small as possible throughout the site to provide the most screen real estate possible for the results.

                                                   i.      Top navigation will include links to Simple search across all collections ("Search all Collections"), and to each full-text collection interface ("Integrated Image Collection", "Electronic Text Collection", "Special Collection Finding Aids")

 

2.      Results Screens

a.       Grouped by Work Results Screen (default for Basic and Advanced Search)

                                                   i.      Reiterate the search term (in red and within quotation marks (e.g. "ghost"), and supply numeric details for the results ("241 total hits in 68 texts")

                                                 ii.      Results are sorted by relevance.

                                                iii.      Results may present texts that are full-text or page images only.  Page image only texts must be identified within the results set by a page icon.

                                               iv.      Listing of results by work with a notation of the number of matches within that work ("Twice-Told Tales: 10 matches")

1.      If the result is full-text, the link goes to a Grouped by Match list of all matches within that work with results in context, sorted by sequence as they occur in the work.

2.      If the result is page image only, the link goes to the first page image for the work within the Page Turner.

                                                 v.      The option to change the display to the Grouped by Match format.

                                               vi.      If there are more results than appear on the first screen, navigation to additional results screens.

                                              vii.      A link to perform a new search.

b.      Grouped by Match Results Screen

                                                   i.      Results are sorted by author, and within author by title.  Within a single title, the results are sorted by sequence as they occur in the work.

1.      The results are sorted by sequence as they occur in the work.

2.      Each result appears on a single line, formatted with the title and the result highlighted in context within a byte offset
(e.g. "Twice-Told Tales: forward at a ghostly pace, and stood beside the wido"

a.       The title provides the link to the location within the text delivered through a Result in Context Screen.

                                                 ii.      The option to change the display to the Grouped by Work format.

                                                iii.      If there are more results than appear on the first screen, navigation to additional results screens.

c.       Result in Context Screen

                                                   i.      The Results in Context screen present the styled text region from the work where a result is found.  The word or phrase is highlighted in red within the text.

                                                 ii.      The author and title of the work are presented at the top of the screen.

                                                iii.      The screen contains a link to the higher level or organization in the work ("View Entire Section").

1.      Clicking on that link takes the user to a Text Section containing the higher level of structure in the work.

                                                 v.      The screen contains a Table of Contents ("Table of Contents") link.

1.      Clicking on that link will take the user to the TOC for that work.

                                               vi.      If there are page numbers, the page number will appear above the text ("Page 486" or "unnumbered page"). 

1.      If the work contains page images, there will be a notation of the link to the page image following the page number ("Page 486 [view image]")

a.       Clicking on a page image link will take the user to the Page Turner.

d.      Text Section

                                                   i.      The standard delivery screen for an electronic text.

1.      The author and title of the work are presented at the top of the screen.

2.      Delivers the styled text, read through scrolling.

3.      Navigational links to previous ("Previous Section") and next ("Next Section") sections, e.g. chapters or other organization.

4.      A link to a presentation of the entire work/volume on a single scrolling screen ("Entire work").

5.      A link to the TOC ("Table of Contents") for that work.

6.      If there are page numbers, the page number will appear above the text ("Page 486" or "unnumbered page"). 

7.      If the work contains page images, there will be a notation of the link to the page image following the page number ("Page 486 [view image]")

a.       Clicking on a page image link will take the user to the Page Turner.

e.      Table of Contents

                                                   i.      A presentation of the highest-level divisions of the entire work, including front matter and back matter if identified.

1.      The author and title of the work are presented at the top of the screen.

2.      Each division will link directly to that section of the work.

a.       The section will be presented as a Text Section screen.

f.        Page Turner

                                                   i.      The Page Turner presents page images to allow browsing through the text through images of its pages.

1.      The author and title of the work are presented at the top of the screen.

2.      The location within the text will be presented ("Page 2 of 55")

3.      Arrow graphics will present options to move through the text.

a.       << - first page, < - previous page, > - next page, >> final page.

4.      An option is presented to open the page image in a new window using the Image Resizer applet.

a.       The Image Resizer applet will allow users to perform simple manipulations of the image.

                                                                                                                           i.      Need improved UI and help to explain the tools, especially panning, which can be done without clicking on a button. 

                                                                                                                         ii.      Pan throughout the image at any level of viewing or zoom.

                                                                                                                        iii.      "Info" button should bring up descriptive and possibly technical metadata for the image object. 

                                                                                                                       iv.      "100%" button resizes the image to its full size.

                                                                                                                         v.      "Fit to Frame" button to resize the image to the size of the window frame.

                                                                                                                       vi.      Zoom into the image in 25% increments up to 1000%.  Button is labeled with next available Zoom status (e.g., "+25%). 

                                                                                                                      vii.      Zoom out of the images in 25% increments to 0%. Button is labeled with next available Zoom status (e.g., "-25%)

1.      Current image size view percentage (e.g., "75%") is displayed between the two Zoom buttons.

                                                                                                                    viii.      "Rotate" button to rotate images in 90% increments clockwise. 

                                                                                                                       ix.      "About" button should instead be labeled "About this Tool".

b.      The Applet does not support page-turning navigation through the images.

g.       Page Image Browse screen

                                                   i.      For texts with page images only and no transcription, the user navigates through the book with a Page Image browse.

1.      The author and title of the work are presented at the top of the screen.

2.      The Screen has a grid of < 10 images.

3.      The location in the sequence of images is noted ("Images 1 through 10")

4.      Navigation is presented textually.

a.       "Start of book", "Previous 10 images", "Next 10 images", "End of book"

                                                                                                                           i.      On the first screen, only the "next" options are available as active links.

                                                                                                                         ii.      On the final screen, only the "previous" options are available as links.

b.      When a user clicks on an image, the user is taken to a Page Turner screen for that image with the same functionality as listed above, including an option to open a separate Image Resizer window.