Bring your PDF online and make it highly readable

Short description

Composite.Media.IssuuPlayer displays a PDF document on a web page in a user-friendly and readable way by using the services of Issuu, a Web-based PDF viewing and sharing online service.

Prerequisites

Before you install and configure Issuu Player, you need to register with Issuu and get your API key and your API secret (if you have not yet). You will use them when configuring Issuu Player.

  1. Complete registration with Issuu
  2. Log in to your Issuu profile
  3. Go to your Account settings > Services
  4. Get your API key and API secret.

How to add Issue API key

  1. In the Content perspective, under Website Items, add a data item ("API key") to Issuu API Key (the Composite.Media.IssuuPlayer.ApiKey datatype).
  2. Specify the values of the following fields:
    • Title: The title of the Issuu API key (any string to refer to the key by).
    • API key: Your Issuu API key.
    • API secret: Your API secret key.

    Note: The first added key will be automatically set as default - it will appear under Issuu API Key with a checkmark icon along with the key itself. If you add another key, you will be able to set it default instead (right-click the key and click Set Default).

  3. Save the item.

Note: Normally, you shouldonlyadd the key to your website once, and then use the same key in many instances of Issuu Player.

How to implement Composite.Media.IssuuPlayer

  1. On the Content tab of a page, the Markup Code tab of a template or the Template tab of an XSLT function, insert the Composite.Media.IssuuPlayer function ( Insert > Function), or add the following code: 
     
<f:function name="Composite.Media.IssuuPlayer" xmlns:f="http://www.composite.net/ns/function/1.0"> 
  <f:param name="MediaFile" value="MediaArchive:c9de529b-b043-401d-bddd-bd3e416b932e" /> 
  <f:param name="ApiKey" value="cd8b979e-9d15-4247-b252-f4522c8378a3" /> 
  <f:param name="Height" value="450" /> 
  <f:param name="Width" value="600" /> 
</f:function>
  2. Specify its required parameter:
    • Media File: The PDF file in the Media Archive to display on a page with Issuu Player.
  3. If necessary, specify its optional parameters:
    • API Key: The title of the API Key you have added to Issuu API Key and made default . If you have more than 1 key added, you can select the key other than that used by default.
    • Height: The height of the Issuu Player on a page (450 by default).
    • Width: The height of the Issuu Player on a page (600 by default).

Note: The values in the sample above are used for illustration only and will be different in your case.

Important Notes

  • When PDF documents are displayed via Issuu for the first time, it may take several minutes before the Issuu service has converted your PDF for online use. Please be prepared for delay.

Requirements

Composite C1 version 2.0 or later

SHARE