Trace: » tei 

TEI Book Viewer Project

Final Project Details

The Bookviewer project has been completed and has been moved into Production. Below you will find the associated files & parameters for the Book Viewer.

Pages & URL Structure

Files Location:

lib-web/approot-new/digitalcase/

Files:

  • Bookview.aspx / vb
  • CompareView.aspx / vb
  • TEIViewFullScreen.aspx / vb
  • TEIView.aspx / vb
  • TEIFrameSource.aspx / vb
  • ImageFrameSource.aspx / vb
  • ksl-tei.xsl

CSS Files

  • /css/primary/redefined.css
  • /css/secondary/custom.css

Project Parameters

Below are the standards required for the Bookviewer to function properly:

  • DSID Naming Scheme for Scanned Pages of Book: These should be the pid of the object, followed by a dash and then 5 digits representing the scanned page in sequence. For example, sanumb00-00001.jp2
  • DSID Naming Scheme for Book Cover: Book covers have the same naming structure as the rest of the scanned pages, however, the number should be all 0's. For example, sanumb00-00000.jp2
  • TEI Datastream Naming: The DSID name for the TEI datastream must be “TEIP5”
  • TEI Datastream MIME Type: The MIME Type must be “application/xml”

The Bookviewer currently only handles 1 application/xml and 1 application/pdf MIME type, which is used to designate the files to be downloaded through the bookviewer menu system.

External Resources

Integration into Digital Case front end

Digital Case needs to understand when an object has a TEI text, so that it can display a “Bookviewer” graphic that will link to the main URL above, but specific to the PID of that object. This will be handled similarly to how the menu system recognizes the ability to download a TEI document. Logic will be added to the datastreamDetail.aspx page, that will recognize these factors and display the linked image. The link should open the book viewer in a new window.

Down the road, we may look into using an additional datastream to designate the presence of a TEI document, especially in scenarios where multiple TEI files may be present.

Additional Notes

Toggle Images Menu Icon: Current there is a feature that allows for the turning on or off of images in the TEI. This feature was disabled as it's not natively supported in the standard P4 encoding of TEI. This option in the menu interface was turned off. To turn on the image icon, open up the page in visual studio. You need to set the visibility to “true”. You can do this by looking at the page in design view, clicking on the icon, and setting the visibility in the properties window - OR - look at the page in HTML/Code view, and find the following: <asp:ImageButton ID=“ibToggleImages” runat=“server” and then change Visible=“false” to Visible=“true”.

Overview

There is a requirement to create book browsing functionality to supplement existing features of digitalcase. This functionality will be used to take TEI Encoded files. These files today are just presented as XML files for patrons to download and do as they wish. We want to create functionality on our site to render these TEI encoded documents and allow patrons to experience these text files as if they were in their original book form.

Updated Quote from DeVore for Build - PDF

Milestones

  • Benchmark #2: A working initial TEI-only view, with pagination for the sample book now available in Fedora
    • Date: June 12, 2008
  • Benchmark #3: A working compare view, with pagination for the sample book now available in Fedora
    • Date: June 19, 2008
    • Note: At this time it would be ideal to have further data in Fedora, beyond this initial book that has been provided, to test against during the week that follows
  • Benchmark #4: Integration with other functionality (search and font resize)
    • Date: June 26, 2008

Requirements

Technical
  1. Must work in all browsers support by the library website. These browsers include: Safari on MAC, Firefox > 1.0 and Internet Explorer > 6.0
  2. Must support all components of the digitalcase technical architecture. Digital Case is an .Net 2.0 app running on IIS 6
  3. No technologies requiring an additional plug-in should be used - for example, AJAX usage Google Books example
  4. Page images are stored in JPEG2000 format but can be presented in the manor appropriate for the application
  5. TEI Encoding Level 4 should be the standard, and this application should be backward compatible with simpler levels of TEI encoding
Branding
  1. Must be visually appealing and follow the existing branding and color pallet of digitalcase
Functional
  1. 3 formats: Text View / Book View / Compare View
  2. Text View displays the entire text of the book (including in-book images) in a single, scrollable pane.
  3. Book View will only display the images of the pages.
  4. Compare View will display pages side by side, comparing the image version with the text
  5. Book View and Compare View will break out of the traditional Digital Case template, with a new header that will be thinner, including only CWRU Logo & KSL Text. It will also drop the Digital Case Menu.
  6. Book View will allow resizing (2-3 different sizes)
  7. Text View will include a linkable table of contents, that will jump the user to those parts of the book.
  8. Clicking “Image View” or “Text View” in either Text View or Book View will take you to the corresponding view while maintaining your current location in the document.
  9. “Turning pages” in Book View will occur by double-clicking pages, or using navigation
  10. Link to Download PDF and TEI versions of text should be made available on every view
  11. Ability to jump to page on every view via URL parameters (client side session)
  12. Need the ability to search text in every view. It's up for discussion if search results are displayed in the relative view, or if results are returned in a common view. Hit highlighting in the text view will show user where there search terms were found. Currently digitalcase search uses a webservice to search the lucene index. The webservice can be found at http://digitalcase.case.edu:9000/axis/FedoraSearcherWebService.jws?wsdl . The webservice method is called searchSimple accepting three parameters search term, number of hits per page and the page number.
  13. Menu options should include pop-up “tool tips” to instruct the user what the different views mean.
  14. A URL structure (client side session management) that allows for locating chapters or pages within a particular book. Users will use this to send URL's that will direct people to a specific chapter of a book.
  15. Ability to “turn off” images in Text View. Default view will be to display images
  16. All views will include the “Print This Page” “Email This Page” and Javascript Text Resizing functionality (as seen throughout website). Here are the functions for each view:
  • Text View: Text resizing will work on page & on TEI text. Email will email link to page. Print this page is a basic print function, not printing entire text.
  • Book View: Text resizing will not work. Email will email link to book (text view). Print this page will print the page as being viewed.
  • Compare View: Text resizing will work on compared text. Email will email link to book (text view). Print this page will print page as being viewed.

Examples

  1. Basic functionality: Cal State
  2. Advanced Functionality: British Library (NOTE:shockwave will not run on Mac OS 10)
  3. Case Example of XML Display (NOTE: Open in Internet Explorer): TEI Markup example from Linda Cantara
  4. Google Example of Loss of the Titanic
  5. Amazon Example of Reading Loss of the Titanic
  6. More Viewers Here: teiviewers.doc

Wire Frames

Text View

Text View

Book View

Book View

Compare View

Compare View

digitalcase/tei.txt · Last modified: 2009/07/06 14:45 by rez7 -
Backlinks