How To: IPaper plugin

Jump to: navigation, search

The iPaper plugin embeds iPaper document viewers into your Omeka item pages.

Developed by the document sharing company Scribd, iPaper is a "document format built for the Internet." With Omeka's iPaper plugin you'll be able to automatically convert your documents to the iPaper format and embed them into your website. All you need is to register for a free Scribd Platform API account, install and configure the Omeka iPaper plugin, and your documents will be available for browsing and searching directly in your web browser. Supported documents include Portable Document Format (pdf), Microsoft Word (doc), PowerPoint (ppt), and most OpenDocument formats.

Installation

  1. Register for a free Scribd Platform API account (a third party web service)
  2. Upload and activate the iPaper plugin (see Installing_a_Plugin)
  3. Configure the plugin in Omeka (see below)

Using the iPaper plugin

The iPaper plugin has several configurations:

  • Scribd Publisher ID (required)
    • Enter the publisher ID given to you when you registered for a Scribd Platform (API) account
  • Make your documents public on Scribd?
  • Select the default iPage view mode
    • 'list' (the default)
    • 'book' (two-page spread)
    • 'slideshow' (the default for presentations)
    • 'tile'
  • Select the formats you want iPaper to display
    • There are currently 16 supported formats, including pdf, doc, ppt, and xls.
  • The height of the iPaper, in pixels
    • Leave this blank if you want iPaper to size itself for the webpage it's embedded in.
  • The width of the iPaper, in pixels
    • Leave this blank if you want iPaper to size itself for the webpage it's embedded in.

If you want to include the iPaper functionality in your public theme, follow these steps:

Within your items/show.php template file write the following code anywhere you want the iPaper document viewer(s) to appear:

<?php
if (function_exists('iPaper_embed')):
    iPaper_embed($item);
endif;
?>

Personal tools

Toolbox