Creating an HTML implementation of the DPS default library

In this article you will learn how to modify a sample template to replace the default library. The sample files in this article contain an HTML implementation of the default library that is included with the viewer. This template enables you to replace the native implementation with an HTML implementation. Using this template, you can customize the library using HTML, JavaScript, and CSS to fit your needs. The template uses APIs that allow you to duplicate e-commerce functionality found in the default library and customize it to fit your project.

Begin by downloading the sample files that are provided at the beginning of this article. The sample contains the HTML implementation of the default library. The figures below show the various views of the library.

To use the provided template you must have folios published as public. The template uses the new library and store APIs to display folio data and images. All other images are packaged with your viewer.

Download and decompress the sample files folder to see the contents. Currently, the App Builder does not allow nested folders in HTMLResources. Because of this limitation, the template does not organize the files into folders.

During development, Adobe recommends that you first build and test your content on the desktop using Safari. This will allow you to adjust the user interface (UI) without having to generate a new viewer to see each change. When testing on your desktop, the API file is not available, so the viewer loads the data from the Adobe fulfillment XML feed.

While testing on the desktop, ensure that you remove the include for AdobeLibraryAPI.js in the index.html file—otherwise you will be unable to view the files in the desktop browser. When testing on the desktop, if nothing displays, open the debugger to check whether there are file paths that cannot be resolved. To use the debugger, use the following steps.

1. If you do have the debugger on Safari open, select the Develop menu option by going to Safari > Preferences > Advanced. Select the Show Develop menu in menu bar option. The Develop menu will display.
2. From the Develop menu, select Develop > Start Debugging JavaScript.
3. Click Console to see if there are any errors. (On Safari 6, select Develop > Show Error Console.)
4. Confirm that the template is running as expected on the desktop.
5. Add the AdobeLibraryAPI.js include into to the page once again, and test the template on your device.

The following list contains descriptions of the key files in the template:

• HTMLResources.zip – The file that is uploaded to App Builder. It is included as an example. This file can be uploaded to App Builder as-is for testing purposes.
• assets/AdobeLibraryAPI.js – The file that contains the library and store APIs.
• assets/backbone-min.js – An open-source application framework.
• assets/index.html — The HTML file used to display the custom slot.
• assets/jquery-1.7.2.min.js — The jQuery library.
• assets/library.css – The styles for the template.
• assets/main.js — The main JavaScript file that starts the application.
• assets/underscore-min.js — JavaScript library used by Backbone.
• assets/.png – The images for the template.
• assets/.js – The JavaScript files for the template.

Note: You must include files in the assets directory in the custom slot ZIP file that you upload to App Builder.

To use of this template with your own content, simply complete the following steps:

1. Modify assets/Config.js.
2. Change the images.
3. Upload files to App Builder.

The following sections describe each of these steps in more detail.

Modifying Config.js.

To modify assets/Config.js, use the following steps.

1. If your viewer is not an entitlement viewer, set IS_ENTITLEMENT_VIEWER to false. If you are creating an entitlement viewer, you will also need to add your own code to AppView.js (line 110) and LoginDialog.js for the “Forgot password?” and “Sign In” links.
2. Change FULFILLMENT_URL if you would like to test your account on the desktop. Since the API file is not available on the desktop, you can use this XML feed to display the folios. Modify FULFILLMENT_URL to match the accountId parameter with your accountId. If you need help finding your accountId, see the section titled “Connecting to fulfillment” in the article, Build a custom storefront. Once you have located your accountId, modify the value after http://edge.adobe-dcfs.com/ddp/issueServer/issues?accountId=[your value].
3. If you would like to display the one up view rather than the grid as the default view, set IS_ONE_UP_VIEW_DEFAULT to true.
4. If you do not want folios to automatically open when enough have been downloaded, set IS_AUTO_OPEN_DOWNLOADED_FOLIO to false.

Changing the images

If your viewer uses entitlement, the image used on the right side of the banner is banner_right.png. If your viewer uses subscriptions, the subscription tile images are subscription_tile_landscape.png and subscription_tile_portrait.png. To create new banners you will need to use an image editting tool such as Fireworks or Photoshop.

Uploading files to App Builder

Use the following steps to upload your files to the App Builder.

1. Create an archive that contains the files from the assets directory. When creating the archive, ensure that you archive the files at the file level rather than at the directory level of the assets directory.
2. Open the App Builder and navigate to the Navigation Toolbar section. For more information on the App Builder, watch the App Builder tutorial video.
3. In the Navigation Toolbar section, select the option to Use Custom Viewer Library.
4. In the Library HTML Resources ZIP field, navigate to your ZIP file to add it to your viewer.
5. Select an orientation if you would like to lock the orientation to portrait or landscape.
6. Select the Hide Title Bar option if you do not want to display the title bar. The label in the title bar uses the value defined in the HTML title tag in index.html.
7. Select the Auto Launch option if you would like the custom slot to be the first slot displayed.

8. When your IPA has finished building, install the viewer on your device and begin testing.

In this article you learned how to modify a sample template to replace the default library. If you would like more information on the JavaScript libraries used, check out the  documentation for Backbone, jQuery, and Underscore. See additional articles and videos available for Digital Publishing Suite on the Adobe Developer Connection.
I have written the following articles explaining how to use the library/store API:

• Implementing the iPhone library/store template using new DPS APIs
• Implementing separate library and store functionality using custom slot templates with new DPS APIs
• Working with the combined library/store custom slot template using new DPS APIs

11/09/2012

• API updates.