Bookviewer

From CollectiveAccess Documentation
Jump to: navigation, search

Using and configuring the Bookviewer

Using the Bookviewer

The Bookviewer allows all users to read multi-page documents or scroll through multiple images in a single record in a clean, user-friendly manner. The “Document” tab displays a single page at a time, ideal for reading. The “Pages” tab shows thumbnails for each document page for quick navigation. You may browse through the document by scrolling the page navigation at the bottom. Using the icons in the upper right corner of the bookviewer, you may download the file to your local machine, zoom in and out, and close the book viewer.

Book viewer.png

Configuration

Bookviewer settings are configured in the media_display.conf file for both the front-end and the back end. The Bookviewer is enabled on a per media-type basis, allowing you to isolate its use to images, PDFs, xcel documents, and other types if you wish to do so. You can also enable the Bookviewer to show only in certain parts of your site.

The configuration file for the front-end can be found here: app/conf/media_display.conf

The configuration file for the back-end can be found here: admin/app/conf/media_display.conf

Configuring the Bookviewer for Pawtucket (Front-End)

File location: app/conf/media_display.conf

“Detail” refers to how media is displayed on the detail page for an object record. “Media Overlay” refers to how media is displayed when it is opened up in the media viewer. You must declare settings for both Detail and Media Overlay if you decide to use the bookviewer in either of these places.

Bookviewer settings in the media_display.conf file:

use_book_viewer_when_number_of_representations_exceeds = [number of representations],

When an object has more than 1 image representation (multiple images), you may enable the Bookviewer when the number of images exceeds a certain limit. In the example below, the Bookviewer will be used in cases when the number of images per record exceeds 2.

use_book_viewer = 1,

This setting enables (1) or disables (0) the book viewer. Do this for each media type. See example below.

show_hierarchy_in_book_viewer = 1,

Enabling this setting will show a record's child records (if there are any) in the Bookviewer.

restrict_book_viewer_to_types = [],

This setting allows you to restrict the Bookviewer to specific object types in your configuration.

Example - Configuring detail page:

detail = {
	images = {
		mimetypes = {image/jpeg, image/tiff, image/png, image/x-dcraw, image/x-psd, image/x-dpx, image/jp2, image/x-adobe-dng},
		display_version = mediumlarge,
		alt_display_version = medium,
		viewer_width = 580, viewer_height = 450,
		use_book_viewer_when_number_of_representations_exceeds = 2,
		use_book_viewer = 1,
		show_hierarchy_in_book_viewer = 1,
		show_subhierarchy_in_book_viewer = 1,
		restrict_book_viewer_to_types = [],
		no_overlay = 0,
	},
documents = {
		mimetypes = {application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.ms-excel, 
		application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation},
		display_version = medium,
		alt_display_version = mediumlarge,
		use_book_viewer_when_number_of_representations_exceeds = 0,
		use_book_viewer = 1,
		show_hierarchy_in_book_viewer = 1,
		show_subhierarchy_in_book_viewer = 1,
		restrict_book_viewer_to_types = [],
		no_overlay = 0,
	},
	pdf = {
		mimetypes = {application/pdf},
		display_version = medium,
		alt_display_version = mediumlarge,
		width = 580, height = 450,
		use_book_viewer = 1,
		no_overlay = 0
	},


Example - Configuring media overlay:

media_overlay = {
	images = {
		mimetypes = {image/jpeg, image/tiff, image/png, image/x-dcraw, image/x-psd, image/x-dpx, image/jp2, image/x-adobe-dng},
		display_version = tilepic,
		alt_display_version = large,
		viewer_width = 100%, viewer_height = 100%,
		use_book_viewer_when_number_of_representations_exceeds = 2,
		use_book_viewer = 1,
		show_hierarchy_in_book_viewer = 1,
		show_subhierarchy_in_book_viewer = 1
	},
documents = {
		mimetypes = {application/postscript, application/msword},
		display_version = pdf,
		alt_display_version = large,
		viewer_width = 820, viewer_height = 520,
		use_book_viewer = 1,
		poster_frame_version = mediumlarge
	},
	pdf = {
		mimetypes = {application/pdf},
		display_version = large,
		alt_display_version = mediumlarge,
		width = 580, height = 450,
		use_book_viewer = 1
	},



Configuring the Bookviewer for Providence (Back-End)

File location: Admin/app/conf/media_display.conf

In the back-end, you can configure the Bookviewer for Media Overlay.

Bookviewer settings in the media_display.conf file:

use_book_viewer_when_number_of_representations_exceeds = 2,

When an object has more than 1 image representation (multiple images), you may enable the Bookviewer when the number of images exceeds a certain limit. In the example above, the Bookviewer will be used in cases when the number of images per record exceeds 2.

use_book_viewer = 1,

This setting enables (1) or disables (0) the book viewer for each media type.

show_hierarchy_in_book_viewer = 1,

Enabling this setting will show a media representation’s child records in the Book Viewer.

restrict_book_viewer_to_types = [],

This setting allows you to restrict the Book Viewer to specific object types in your configuration.

Example:

media_overlay = {
	images = {
		mimetypes = {image/jpeg, image/tiff, image/png, image/x-dcraw, image/x-psd, image/x-dpx, image/jp2, image/x-adobe-dng, image/x-dcraw},
		display_version = tilepic,
		alt_display_version = large,
		viewer_width = 100%, viewer_height = 100%,
		use_book_viewer_when_number_of_representations_exceeds = 2,
		use_book_viewer = 1,
		show_hierarchy_in_book_viewer = 1,
		show_subhierarchy_in_book_viewer = 1,
		restrict_book_viewer_to_types = []
	}, 
pdf = {
		mimetypes = {application/pdf},
		display_version = large,
		alt_display_version = mediumlarge,
		width = 580, height = 450,
		use_book_viewer = 1
	},
	documents = {
		mimetypes = {application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.ms-excel, 
		application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation},
		display_version = pdf,
		alt_display_version = large,
		viewer_width = 820, viewer_height = 520,
		poster_frame_version = mediumlarge,
		use_book_viewer = 1
	},



i_sphinx

Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools