Follow

Upgrading iOS 1.4.2 to 1.5.0

Merged code

The primary change since 1.4.2 is the merged code for Pugpig for Magazines and Pugpig for Continuous Publishing on iOS. We've merged code and UI to achieve a single product and template that can be be configured in the traditional edition based (PPfM) and continuous (PPfCP) ways but is now even more flexible and allows us to start offering a dual publishing configuration too (editions and continuous feeds). This work has led to changes across config, UI, server API, theming, and downloads so is a large upgrade. We therefore recommend reading the details below and planning some time to upgrade, test and submit.

Config changes

We have a new set of supported configuration keys in this upgrade. Most of these are supported on the server-side in our Server API feed spec however to help customers upgrade who may not be able to add these server changes quickly we have provided config.plist keys inside the app container. We may deprecate some of the app side config in future so we recommend planning the changes into your 2106 Server pipeline if you manage this.

New keys to be aware of and what to set in your config.plist when you upgrade:

  • Enable Storefront - this is one of the main config keys you need to use to determine a traditional edition based app or a continuous one. For Continuous based apps you should set this to False (NO).
  • Enable Auto Open Document - this is a another main config key you need to use to determine continuous app behaviour, you should set this to True (YES)
  • Enable Zoomed Pages - this is a different style of thumbnails supported in traditional edition based apps and should be set to False (NO) for continuous apps.
  • Enable Pull to Refresh TOC - this turns on Pull to refresh functionality inside the Table of Contents (typical feature in Continuous applications)
  • Enable Auto Open TOC - this will auto-open the Table of Contents panel every time you enter the edition
  • Enable Latest News - this turns on the Latest News ticker available inside the Tiled Table of Contents only

However, please note these keys can be set per edition server side, this will allow you to then support different editions with different Table of Contents types and behaviours.

Please also check if you make use of Overflow Theme key overrides you use the label 'reorder' and not 'edit.

Download changes

We now support progressive downloads based on the edition feed type. We had progressive download functionality on by default for Pugpig for Continuous Publishing and now we have merged the two, editions can also be downloaded progressively (as long as the feed type is compatible). What this means is you get into the document as soon as it has content that is ready, you can start reading page 1 before the other pages have completed. Previously the user would have to wait until the entire edition download had completed before they could start reading. We also made some improvements to the page loading view before all the content is ready. Progressive downloads will happen by default in iOS version 1.5.0 if the feed is classic ATOM or new page-per-zips (supported through our Distribution Service). Progressive downloads is not supported with older packaged zips and so with these style feeds you will fallback to the usual download where you wait until the whole edition has completed before you see any content.

IMPORTANT: Please note we do not currently support progressive downloads on Android - this will come in 2016. All types of feeds work on Android however the download will mean the user has to wait until the whole edition has completed before they can view content.

Alongside progressive downloads we have also supported some new download flows.  

Xcode 7 Notes

You should upgrade your environments to Xcode 7 (this is available in Apple's developer portal). Before building with Xcode 7 you should do the following:

  • Upgrade to latest Pugpig Products version available following any upgrade instructions
  • Turn off App Transport Security (ATS) - you can find instructions on how online - http://iosdevtips.co/post/121756573323/ios-9-xcode-7-http-connect-server-error
  • UIRequiresFullScreen to silence submission-time error caused by absence of Launch.xib
    <key>UIRequiresFullScreen</key>
    <true/>
  • Turn off bitcode in build settings
  • Ensure deployment target is iOS 7 +

UI Visual Changes

Here is an overview of the visual changes between 1.4.2 and 1.5.0 release:

  • The edition Table of Contents now appear over the content/page/view consistently across platforms and devices.
  • The Table of Contents can now be set to a full-screen width for all devices and orientations
  • The Tiled Table of Contents has been changed to be full-screen width for all devices on Android and iOS.
  • Removed the preload screen (which may affect sponsorship) - you now see the Storefront background, toolbar and brand themeing whilst the download of the OPDS feed is completed. Once edition or page content is ready it will be shown.
  • Added a page loading screen mask which can be themed. This will show out of the box for all your pages, it shows a logo, page title and summary when it is being downloaded & user waits for the content to display.

Other visual behaviour changes to note:

  • No longer filtered by section for Continuous apps - swipe off last page in one section onto first page of the next section. This is how magazine, edition based apps always worked.
  • One search result per pageThe search panel will only show one row entry per page even when the term exists multiple times in that page

We can share visuals for the above. If you want to see these before upgrading, just get in touch.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk