Creating custom viewer apps for the iPad and iPhone

Provide a viewer name that appears below the App icon on the iPad. As a general rule, use 13 characters or fewer to avoid truncating the name.

Specify the most recent viewer.

The DPS App Builder includes a previous version for backup purposes.

Specify the viewer type (see Types of custom viewer apps). The availability of some options depends on the type of account.

This option no longer has any effect in DPS apps.

Provide the title that will appear at the top of the viewer library. For best results, use no more than 35 characters.

Provide the appropriate Adobe ID and password for your app. Specify the same Adobe ID you use to create folios for this title. Make sure that the Adobe ID is assigned the Application role in the Account Administration tool. The Title ID for the app can be different from the Adobe ID used to sign in to DPS App Builder.

Specify the custom URL scheme that launches the viewer app from Safari and other apps. To ensure uniqueness, Apple recommends that you use the reverse-domain format (com.publisher.publication). For best results with Twitter social sharing, use 32 characters or fewer.

For example, suppose you specify “com.sportspub.kayaking” as the URL scheme. If you embed a “com.sportspub.kayaking://” link on your webpage, clicking the link from the mobile browser opens the viewer app. For more information, see Apple’s developer website.

If you selected Built-in Single Edition App for App type, specify the .zip file to be built in with the viewer. To create a .zip file, use the Export option in the Folio Producer Organizer. See Export folios for single-folio viewers. (Instead of using the exported .zip file, you can select the folio in the Folio Builder panel and choose Create App.)

If you specify a privacy policy URL, "Privacy Policy" appears in the library settings menu. If a user taps Privacy Policy, the web page is displayed in an in-app browser.

(Enterprise only) You can create a .zip file that includes HTML assets for your iPhone viewer. This HTML page is displayed only the first time your customers start the iPhone viewer. The HTML page can contain links for restoring previous purchases and dismissing the welcome screen. For details on creating these links, see Custom HTML Store API Reference.

Select this option to allow your users to pinch and zoom non-interactive pages. Make sure that you select the PDF image format option when creating your folio.

Select this option to allow your users to bookmark their favorite articles in the app. If enabled, a Bookmarks icon appears on the upper right area of the viewer nav bar. Bookmarks are not yet available in the iPhone viewer.

By default, a 6-pixel scrollbar area appears on the right side of articles in a folio. If you select this option, the scrollbar appears only when the user is scrolling in the article.

When this option is selected, any folio that has been downloaded in the background since the previous viewing session opens on launch. If this option is not selected, the most recently viewed folio is opened in its previous reading position. This option is especially useful for daily and weekly magazines.

If you select this option, invisible hot zones appear on the left and right sides of every article (or page if the article scrolls only horizontally). Tapping a hot zone jumps to the next or previous article. Hot zones are especially useful for full-screen overlays, such as slideshows. Hot zones are enabled for both iPad and iPhone viewers.

If a button appears in the hot zone area, tapping the area triggers the button. For any other overlay that appears in the hot zone area, tapping the area triggers the hot zone.

If you select this option, tapping in the hot zone area at both the top and bottom of the page displays the navigation bars (also called the “HUD”). Tapping anywhere outside the hot zones does not display the navigation bars. Hot zones are enabled for both iPad and iPhone viewers.

Buttons take precedence over the folio-view hot zones, the folio-view hot zones take precedence over the left and right hot zones, and the folio-view hot zones take precedence over all non-button overlays.

If you select this option, only the bottom navigation bar is displayed when a user taps an article. This allows publishers to create a custom navigation bar on all article pages to navigate within the folio.

Select this option enable auto-archiving of folios when the customer downloads the maximum number of folios allowed. Indicate whether the archiving is turned on by default. Customers can use the device settings to turn auto-archiving on or off. Also specify the maximum number of downloaded folios (between 6 and 90) for your viewer app. When the threshold number is reached, the least recently updated folios are archived automatically. Customers cannot change the threshold number. Customers can re-download any archived folio.

Select this option to cache folio information such as the price of a folio. Selecting this option improves performance for apps with large libraries because the viewer does not check the Apple server each time the library is loaded. However, selecting this option can cause folio information to become out of date. For example, if you select this option and change the cost of retail folios, your library will display misleading information. This option is currently available only for subscription apps.

By default, the Sign In button appears in the upper left corner of the library in subscription apps with custom entitlement. You can hide the Sign In button if your custom library provides a different method for signing in.

By default, the Subscribe button appears in the upper left corner of the library in subscription apps. You can hide the Subscribe button.

If this option is selected, the most recently entitled folio is downloaded automatically when the app is launched. Use the Account Administration tool make the first retail folio free to first-time downloaders. At this time, this option affects only retail folios, not free ones.

Select this option to display a “Rate the App” prompt after your customers have launched the app a specified number of times. For example, if you set the “Rate the App Dialog Count” value to 5, users are prompted to rate the app on the fifth launch of the app. If they select “Remind me later,” they’re prompted on the next launch.

Specify the 9-digit Application ID for your app. To obtain this ID, sign in to itunesconnect.apple.com, click Manage Your Applications, and then click your app. Copy the 9-digit Apple ID string (not the Bundle ID).

If you select this option, your customers can opt out of data tracking. They can use the library settings in the viewer app to opt in at any time. This option is especially useful for regions in which you are obligated to allow users to opt out of data tracking.

To edit the default text that appears, select Use Customized Strings, and download and edit the values for “Analytics Opt-In Dialog Title” and “Analytics Opt-In Dialog Text.”

Select this option if you have an older custom store configuration that you would like to use. If you select this option, you cannot specify a custom library.

iTunes displays the languages in which the viewer app is available. The viewer interface is translated into multiple languages, but your folio content most likely isn’t. Select at least one language in which your viewer should appear.

You can customize all strings stored in the viewer in all supported languages. For example, you can customize button text in the library and text in dialog boxes. Select this option, and then click Generate Template to download an XML template to your Documents folder. You can then edit this XML file and specify it in DPS App Builder. If you’re editing a viewer created for a previous version, download and edit the newest template for best results.

When you edit the XML file, each UI element includes a <key name> and one or more language strings (such as <en> for English). Edit the text in the language code (such as <en>); do not change the <key name> string.

Specify the URL in the form http://[:]/contextroot/api/, such as http://lighthouse.adobe.com/dps/entitlement_starter/api. For details, see the direct entitlement API documentation or contact your Adobe representative.

Specify the same information used for Service URL.

Adobe provides the Integrator ID when your entitlement account is provisioned within our servers. Contact your Adobe representative for information about the Integrator ID.

Specify the URL where customers can sign up for a subscription through the publisher, not through the Apple subscription process. This URL is used when users tap a “Subscribe” button that links to your entitlement service.

Specify the URL where customers can retrieve their forgotten password.

Specify the URL where customers can indicate an existing print subscription while signing up for a digital subscription. Leave this field blank to disable the print subscription link button in the viewer.

This option allows the Viewer app’s ID and Version strings to be sent in entitlement API calls.

Select this option to display a full-width subscription banner in the viewer library instead of the subscription tile. If this option is not selected, only the subscription tile appears in the library. If you use a banner instead of the tile, your HTML content should include links to subscription options.

Specify the URL that displays the subscription banner if the user is connect to the internet. This full-width banner appears in the upper section of the viewer library above the subscription tile and available folios.

Select the .zip file containing the assets to be used as the banner if the user is not connected to the internet. The .zip file should include a single HTML file, one or more image files, and optional CSS files. The .zip file should not contain subfolders; all content should be on the same level.

Specify the height of the banner that appears in the viewer library.

Specify background images that describe the Apple subscription options. For landscape tiles that appear when the device is rotated sideways, specify a 964x184-pixel image for iPad 1&2, and specify a 1928x368-pixel image for iPad3. For portrait tiles, specify 708x250 and 1416x500-pixel images for the two different iPad sizes.

Tapping any part of the tile launches the iOS subscription options. These options are determined by the subscription in-app purchase information you specify in iTunes Connect.

Note: If you enable an entitlement banner, the entitlement banner is displayed instead of—not in addition to— the subscription tiles. However, due to a bug in the DPS App Builder, it is still necessary to specify the subscription tiles.

Specify a URL that is displayed in an in-app browser window when the customer taps the subscription tile. This webpage can include messaging that is not necessarily related to subscriptions.

This URL loads when the customer completes the subscription process. For example, you can request user information or provide additional details about your products.

Select Paid if you have a retail subscription app. For Subscription Products, click the plus icon to specify at least one Apple iTunes Connect product ID and corresponding duration. These options appear when customers tap the subscription tile or the Subscribe button.

Select Free if you are creating a Newsstand app with Apple’s Free Subscription option. Specify the Free Subscription Product ID you specified in iTunes Connect.

To customize subscription strings, use the Use Customized Strings option in the App Details panel.

The icons that you specify will be used on the iPad home screen when installed, and on the device App Store when viewed from the iPad. Specify 29x29, 50x50, and 72x72 pixel icons in PNG format for iPad 1&2 devices. Specify 58x58, 100x100, and 144x144 pixel icons in PNG format for iPad3 devices. Specify 29x29, 57x57, 58x58, and 114x114 icons for the iPhone. Apple rounds the corners automatically. Do not scale up smaller artwork. Use 72ppi, RGB, flattened, high-quality PNG files.

When the Viewer is started, a splash screen (also known as a launch image) appears for approximately three seconds. For splash screens, specify the following images using 72 ppi, RGB, flattened, high-quality PNG files. To reduce file size, use Save for Web & Devices in Photoshop to save 8-bit PNG files.

• 1024x768 and 768x1024 pixel images for iPad 1&2

• 2048x1536 and 1536x2048 pixel images for iPad3

• 320x480 pixel image for iPhone 3GS

• 640x960 pixel image for iPhone 4/4S and 640x1136 pixel image for iPhone 5.

For best results, make your splash screen image different from your cover. If the cover and the splash screen are identical, users may think the app is frozen when they first start it. Some publishers add “Loading . . .” to the splash images.

The large app icon will be displayed for your app on the desktop App Store and if needed, will be used to feature your app on the App Store. Specify a 512x512-pixel image for low-resolution iPad and iPhone devices and a 1024x1024-pixel image for high-resolution iPad and iPhone devices. For best results, use Save for Web & Devices in Photoshop to create a 8-bit PNG files. You can also specify this image while submitting your app to the Apple Store. Do not scale up smaller artwork. Use 72ppi, 8-bit, RGB, flattened, high-quality PNG files. To reduce file size, create 8-bit instead of 24-bit PNG files.

Indicate whether you want your application icons to include the shine effect, which looks like a light is shining on the upper portion of the icon.

If you apply fonts to text in your HTML stacks or web view overlays, you can include them in either the .folio file or the Viewer. If you choose to include them in the Viewer, compress the fonts in a .zip folder. The .zip file should not contain subfolders; all content should be on the same level.

Select this option to allow your viewer to appear in the Newsstand folder.

Determine whether Newsstand should classify your viewer app as a magazine or newspaper.

Select an option to determine the adornment appearance on the Newsstand icon when a customer double-taps the Home button to display the active apps. For example, choosing Left binding displays a binding edge on the left and page adornments on the right.

Specify a PNG icon that appears in the Newsstand folder. Use a 72 ppi, RGB, flattened, high-quality PNG file at 96x128 pixels for the iPad 1&2 and 192x256 for iPad3. This icon is used as the cover image in Newsstand. This icon is replaced by the cover image of the most recently published folio.

If the Navigation Toolbar is displayed, tapping the Library button on the bottom navigation bar does the same thing as tapping the Library button in the upper left navigation bar. To avoid this redundancy, you can hide the Library button, but only if the bottom navigation toolbar is enabled.

Select this option to display the Navigation Toolbar at the bottom of the viewer.

Specify whether the Navigation Toolbar should appear in all views, including the library and folio view, or if it should be hidden when folios are viewed.

If Show Navigation Toolbar is selected, you can hide the Viewer icon that appears by default. Tapping the Viewer icon displays the previously viewed folio.

Select this option if you want folios to be available for purchase only through a subscription and not through individual purchase.

Selecting this option prevents the Sign In button from appearing in the upper left corner of the screen when a custom icon is tapped.

Select this option to hide free folios from your library. This option is especially useful if you want to use your custom server to entitle customers to specify folios based on their sign in account information.

For information on restricting folios, see Using restricted distribution with Digital Publishing Suite.

Select this option if you want a Sign In button to appear in the upper left corner of the web page that appears when users tap any of the custom icons.

Use this section to specify custom icons for the navigation toolbar of the default library or to specify a custom HTML library.

When you click the Library icon in the Navigation Toolbar section of DPS App Builder, the Use Custom Viewer Library option appears. If you click the option icon, you can specify the .zip file that includes your HTML code. See Creating a custom library (Enterprise).

Click the plus icon on the right side of the panel to create a custom button for the Navigation Toolbar. Or, select the Library or Viewer icons to replace the default Library and Viewer icons with default icons. Specify PNG files to be displayed as the normal button appearance. Use a 75x43-pixel image for iPad 1&2 and a 150x86-pixel image for iPad3.

When users tap a custom icon, an in-app browser displays the contents of the HTML file you provide, such as a website for a store, a news feed, or help page. Customers can tap a Close button to return to library view. You can specify as many as three custom toolbar buttons.

Specify PNG files to be displayed when the button is tapped. Use a 75x43-pixel image for iPad 1&2 and a 150x86-pixel image for iPad3. For example, you can change the image border from black to red.

Specify PNG files to be displayed when the button is not available, such as during a download. Use a 75x43-pixel image for iPad 1&2 and a 150x86-pixel image for iPad3. For example, you can display a dimmed version of a shopping cart for a “Store” button.

Select WebView to display the contents of an HTML file you specify. Select Navigation only if you’re publishing a Woodwing-based app in which you can use the Intent metadata to jump to a cover, table of contents, or help article. Specify the intent in the Label field.

This option lets you create article links that open the HTML content associated with the custom icon. For example, if your Label is “Store,” creating a button with a goto://ApplicationViewState/Store action opens the Store HTML. See Create goto links to custom icons.

Specify a .zip file containing the assets to be used for the web view that appears when users tap the toolbar button. The .zip file should include a single HTML file and any required image and CSS files. The .zip file should not contain subfolders; all content should be on the same level.

If you want the web view that appears when users tap the toolbar button to display in only one orientation, choose Horizontal or Vertical.

Select this option to hide the title bar that appears at the top of the viewer library when the custom icon’s HTML content is displayed.

One of the custom toolbar buttons can be set to Auto Launch. When Auto Launch is turned on, opening the viewer library displays the HTML page automatically.

Display navigation controls such as a Back button and a Refresh button for the web page. These options appear in the title bar above the HTML content.

Select this option to add Email to the social sharing menu in the upper right area of the viewer nav bar. Customers can select this option to send an email message with a link to the article or Publication URL.

Select this option to add Twitter to the social sharing menu. Customers can select this option to post a message to their Twitter feed.

Select this option to add Copy Link to the social sharing menu. Customers can select this option to copy the URL of the shared article or publication and paste it in a web page or other location.

Select this option to add Facebook to the social sharing menu. Customers can select this option to leave a comment and link on their Facebook wall.

Specify the App ID obtained from the Facebook developer site.

Specify the URL that contains information about your publication. The link to the Publication URL appears when customers share a protected article.

If the URL that links to the share article is no longer available, the Redirect URL specified in the Account Administration tool determines whether an error message or a different Website appears.

Select this option only if you want to use an enterprise provisioning certificate for a viewer to be distributed only within your organization. Specify an App ID and your enterprise mobileprovision file. See Creating an enterprise signed iPad viewer app.

The mobileprovision file determines which iPads can install and use your viewer app. The mobileprovision file for the development app includes a list of iPad IDs called UDIDs.

The mobileprovision file determines which iPads can install and use your Viewer app.

Select this option so that you can manually add .folio files to the development viewer through iTunes. You can use only .folio files, not .zip files created using the Export button in the Folio Producer Organizer.

Select this option to enable Adobe push notifications. If you select this option, a red badge appears on the viewer app icon and indicates the number of available folios, or Newsstand activates a push notification process. This option is required when Newsstand is enabled.

If you select this option, push notifications are handled through the Adobe server. Specify the production certificate and password that you create on the Apple developer site. To set up push notifications, configure your App ID, create new mobileprovision files, and create a productin push certificate. For detailed instructions, see the iPad Publishing Companion Guide PDF, which you can download from the Help menu in the DPS App Builder.

If you deselect this option (Enterprise only), you can specify a third-party push server. Specify the server in the Push URL field. Specify any additional server requests your server requires in the Custom Push Parameters field. For basic requirements in setting up your push server, see Push notifications.

If your developer app works as designed, submit the distribution app (.zip) to the Apple Store. For details, see the iPad Publishing Companion Guide PDF.

If you need to create different icons or make other changes, select the viewer app on the main page, and click Edit. Your information and selections remain intact. Make the necessary changes, and then submit the build again. Your app will be updated.

If you no longer need the developer and distribution apps, select the viewer app on the main page, and click Delete. You can create a new build at any time—just use the mobileprovision files based on the same App ID used for the app.