CHANGELOG.md

CHANGELOG

Changes on master

Compare changes

Breaking Changes

• The internal links page type has been extracted to the pageflow-internal-links gem. (#316) To keep using it, follow the instructions found in the gem's README.

Deprecations

• The configuration API for registering new page types has changed. Turn calls of the form

    config.register_page_type(Pageflow::Some.page_type)
  

  into

    config.page_types.register(Pageflow::Some.page_type)
  

  The old method still exists for now, but will be removed before version 1.0. (#297)

Manual Update Step

• Some of the new features have to be enabled manually via the new feature toggle UI inside the admin. Visit the Features tab on the account's admin page to view a list of available feature toggles. Note that some of the graphical features currently have no effect in the default theme.

Public Site

• Password protection for published entries. (#301, #304)
• Atmo audios spanning multiple pages. (#332, #361)
• Option to automatically change page on video end. (#334, #339)
• Option to fade in page titles after a delay. (#338)
• Additional page transitions. (#326, #363)
• Improve display of file rights. (#300)
• Slideshow optimization to improve initial load time in large entries. (#330, #352)
• Minor improvements to the video page type. (#355, #333, #357, #353, #331)
• Bug fix: Fix copyright links in mobile navigation. (#377)
• Bug fix: Find share target page in published revision (#375)
• Bug fix: Improve local storage detection to prevent failure in Safari. (#360)

Admin/Editor

• Duplicating entries. (#372)
• Hotkey to edit the current page. (#340)
• Optimized video resouce management in editor for large entries. (#337)

Rails Engine

Public APIs to be used by Pageflow plugins:

• Introduce features API. (#297, #320, #325)
• Introduce API for audio playback. (#319, #356)
• Enhance API for page types to configure their scroller. (#321, #327, #336)
• Introduce API to display multimedia alert. (#359)
• Introduce API to register new page transitions. (#326)
• Introduce history API with adapters for hash, push state and simulation. (#322)
• Introduce page type API to manage internal links. (#324)
• Introduce API to customize page change behavior via scrolling. (#323)
• Promote pageflow.Object to application.js. (#296, #298)
• Dispatch page:update event via pageflow.events. (#302)
• Panorama image file style. (#344)

Theme options:

• Add theme option to disable page change by scrolling. (#349)
• Let themes disable hide text on swipe functionality. (#358)
• Add options to configure orientation and display of scroll indicators. (#329)
• For themes that support non-linear Pagefows, chapters can now be organized in a hierachy. (#318, #345, #348)

Extracted reusable jQuery widgets:

• Fullscreen button. (#350)
• Parent page button. (#347)
• Additional player controls buttons. (#346, #362, #354)
• Use top button to go to landing page. (#351)
• Extract social share links into reusable partials. (#335)

Reusable components for the editor Backbone application:

• Generic button and list views. (#343)
• Generic reference input view. (#342)
• Add visible option for input backbone views. (#341)
• Options for configuration editor tab groups. (#328)
• Allow displaying custom views in the editor main region. (#317)
• Add appendSubview method. (#310)
• Improve SubsetCollection. (#309)
• Bug fix: Set isDestroying before triggering destroying event. (#312)
• Bug fix: Save TextiInputView on close. (#311)

Enhancements for app development:

• Allow overriding attachments scope name. (#303)
• Bug fix: Add spec fixtures required by factory girl to gem files. (#370, #371, #368)
• Use environment variables for api keys in generated initializer. (#306)

Internals

• Include pageflow version in entry css url to invalidate CDN on gem updates. (#376)
• Improve stability of feature specs. (#299)
• Disable bandwidth feature detection in test environment. (#308)
• Bug fix: Fix paperclip version to 4.2 until 4.3 issues are resolved. (#307)

Version 0.8.0

2015-05-28

Compare changes

Public Site

• Bug fix: Do not hang at loading spinner if local storage is not available. (#295)
• Bug fix: Ensure correct social sharing images and descriptions are used. (#288)
• Bug fix: Ensure audio page text is not hidden by player controls on mobile. (#263, #267)

Admin/Editor

• Use locale from request header if user has not selected one. (#265)
• Performance improvement: Speed up file polling requests in editor. (#276)

Rails Engine

• Allow exluding widgets from being rendered in the preview. (#271)
• Authorize display of entry admin tabs. (#272)
• Trigger pageflow.events Event when the multimedia alert is closed. (#260)
• Pass page widget in context option of media events. (#273)

Internals

• Upgrade to Paperclip 4.2 to improve temp file removal. (#289)
• Include teaspoon javascript tests in travis run. (#264, #294)
• Use container based travis infrastructure and cache gem bundle between test runs. (#270)
• Improve install instructions in README. (#283, #285, #293)
• Bug fix: Reset capybara session before cleaning the database in tests. (#269)
• Bug fix: Prevent order dependent test suite failures. (#274)

Version 0.7.2

2015-02-25

Compare changes

• Bug fix: Depend on version 1.x of aws-sdk gem. (#259)

Version 0.7.1

2015-02-19

Compare changes

• Bug fix: Make gem versions more specific. (#254, #256)
• Bug fix: Loosen JBuilder dependency. (#257)
• Bug fix: Make custom Backbone Marionette renderer accept functions as templates. (#252)

Version 0.7.0

2015-02-03

Compare changes

Manual Update Step

• The locale can now be changed on a per user and per entry basis. (#220)

  For language selection to work inside the admin, you need to add the following line to the setup block inside your config/initializers/active_admin.rb file:

    ActiveAdmin.setup do |config|
      Pageflow.active_admin_settings(config)
  
      # ...
    end
  

  So far en and de locales are supported. The default locale can be configured in your config/application.rb file just like for any other Rails app:

    config.i18n.default_locale = :de
  

  If you do not wish to allow users to change the locale setting, add the following line to your config/initializers/pageflow.rb file:

    # Make only some locales available
    config.available_locales = [:de]
  

• DOM Change: The overview close button and the scroll/hidden text indicators now use localizable texts instead of relying on text in images. Custom themes must either hide or style these texts.

Public Site

• Twitter share cards support. (#218)
• Bug fix: Cache head fragment for different share targets. (#243)
• Bug fix: Improve social sharing buttons. (#246)
• Bug fix: Ensure target blank for content links. (#233)
• Bug fix: Improve top margin of pages without title. (#223)
• Bug fix: Correct width of title elements with text position right. (#224)
• Bug fix: Correct logo height on mobile devices. (#234)
• Bug fix: Prevent illegal UTF8 characters from causing javascript syntax errors. (#238, #239)

Admin/Editor

• Improved page type select drop down menu. (#249)
• Improved extensible help dialog. (#248)
• Update rich text editor. (#232)
• Allow mailto protocol in content links. (#245)
• Bug fix: Remove unused additional info box fields for background audio page type. (#226)
• Bug fix: Allow unsetting the custom share image. (#230)
• Bug fix: Do not display outdated data when visiting editor with browser back. (#239)
• Bug fix: Stop edit lock polling when session expires. (#240)
• Bug fix: Add missing en translations. (#237, #247)

Rails Engine

• New plugin method for configuration API. (#244)
• Refactor default theme to ease importing additional files. (#229)
• Dispatch media events on video/audio playback. (#227)
• Remove unused page type engine base class. (#225)
• Bug fix: Depend on working jquery-fileupload-rails patch level version. (#235)

Version 0.6.0

2014-12-15

Compare changes

Public Site

• Allow displaying a different poster image for video pages on mobile devices where autoplay is not supported. (#143)
• Animate scrolling indicator initially. (#144)
• Improve Facebook open graph meta tags. (#157)
• Allow sharing individual pages and changing the share image. (#206)
• Allow configuring position of background videos. (#176)
• Allow emphasizing recently added pages. (#195, #214)
• Start at bottom of page when scrolling backwards. (#178, #184, #185)
• Prevent search engine indexing of video/audio file pages. (#219)
• Improve iOS 8 compatability. (#186, #199)
• Improve IE 11 compatability. (#189)
• Bug fix: Let Favicon path point into theme directoy. (#164)
• Bug fix: Correct position of video loading spinner. (#141)
• Bug fix: Audio loop page did not loop. (#147)
• Bug fix: Prevent resolving ready promise before dom ready event. (#167)

Admin/Editor

• New background positioning dialog. (#212)
• Extensible tab concept for account and entry admin view. (#165)
• Improve editor preview when sidebar causes narrow display. (#196)
• Editor UI improvements. (#182, #194, #200, #203, #207, #208, #210, #215)
• Bug fix: Audio kept playing in editor when chaning page type. (#149)
• Bug fix: Do not display edit lock warning after reopening an entry in the same tab. (#202)
• Bug fix: Do not pass obsolete page configurations to page type hooks. (#204)
• Bug fix: Return to correct tab after file selection. (#211)

Rails Engine

• Rails 4.1 compatibility. (#161, #162, #197)
• Introduce plugin concept for ui widgets. (#170, #198)
• Dispatch global events for Pageflow extensions. (#171)
• Allow widget types to add content to page head. (#217)
• Richer CSS classes for theming of progress bars. (#177)
• Allow special theming of first page of chapter. (#151, #209)
• Allow page types to control whether an inverted scrolling indicator is used. (#180)
• Give page types access to scroller properties. (#181)

Internals

• Extract reusable Backbone views from editor. (#163)
• Improve Backbone form and tab views. (#166, #169)
• Include capybara webkit tests in travis run. (#201)

Version 0.5.0

2014-10-14

Compare changes

Manual Update Step

To enable the new built in audio loop page type, you need to add the following line to your config/initializers/pageflow.rb file:

  config.register_page_type(Pageflow::BuiltInPageType.audio_loop)

Public Site

• Improve playback of certain videos in Firefox. (#116)
• Add audio loop page type. (#120)
• Allow page thumbnails to be explictly defined. (#121)
• Reword multimedia alert. (#122)
• Background shadow position always left on phones. (#123)
• Do not display chapter headings in overview if only one chapter exists. Improve display of multiline chapter titles in overview. (#130)
• Improve styling of player controls on mobile platforms. (#132)
• Allow hiding social media links in themes by adding a CSS class. (#135)
• Add data-theme attribute to DOM so page types can determine the current theme name. (#136)
• Bug fix: Correct color of links in additional info box. (#117)
• Bug fix: iOS 8 window.onload bug workaround. (#119, #131)
• Bug fix: Add missing overview pictogram for internal links page. (#137)

Admin/Editor

• Display an error message if an uploaded file cannot be matched to a file type. (#133)
• Bug fix: Spelling error in form input label. (#128)
• Bug fix: Do not escape HTML in preview of thumbnail hover texts in internal links page. (#134)

Rails Engine

• Allow page types to introduce new file types. (#124)
• Allow page types to customize their thumbnail representation. (#138)
• Remove some unused images from default theme. (#139)
• Make zencoder urls configurable. (#145)

Version 0.4.0

2014-09-08

Compare changes

Breaking Changes

• The <meta name="description" /> tag now uses the Entry#summary attribute which can be edited in the editor. If you have a custom layouts/pageflow/_meta_tags.html.erb partial in your project, remove the description meta tag there to prevent duplicate tags. (#112)

Public Site

• Improve generation of credits box. (#99)
• Bug fix: Respond with 404 for unknown format. (#101)
• Bug fix: Decrease margin of links in text in default theme. (#108)
• Bug fix: Ensure top margin in additional info box even if no title is present. (#109)
• Bug fix: Logo was no longer left aligned at certain window widths. (#111)

Admin/Editor

• Improve order of files in editor. (#105)
• Improve order of items in select boxes of membership form. (#107)
• Blank slate for editor. (#110)
• Improve encoding confirmation workflow in editor. (#113)
• Improve entry publication workflow in editor. (#114)
• Bug fix: Editing a newly created page altered the default attribute values of subsequently created pages. (#103)
• Bug fix: Update positions of chapters and pages when an item is removed. (#104)
• Bug fix: Do not send bad request by trying to save order of empty chapter. (#104)
• Bug fix: Link dialog of rich text editor was broken. (#108)

Version 0.3.0

2014-08-22

Compare changes

Breaking Changes

• Requiring pageflow/seeds in your db/seeds.rb file no longer automatically creates database records. Instead, you can include the Pageflow::Seeds module to configure your database seed via a DSL. (#73)

  To keep seeding your database with the same default users and sample entry as before, re-running the pagflow:seeds generator and choose to overwrite your your db/seeds.rb file:

  $ cd your_pageflow_app/
  $ rails generate pageflow:seeds
  

• DOM change: .navigation a.navigation_home has been renamed to .navigation a.navigation_top. You need to update corresponding selectors inside custom themes. Instead, a new .navigation a.navigation_home button is now supported, which links to a configurable external site. (#98)

  If you do not wish to use this new home button with your custom theme, you can disable it when registering themes in your config/initializers/pageflow.rb:

  config.themes.register(:custom, no_home_button: true)
  

  This will cause Pageflow to only render the a.navigation_top link in entries using your theme.

Public Site

• Bug fix: Audio player timestamps were flickering on play. (#74)
• Bug fix: Link IE stylesheets/javascripts correctly. (#81, #92)
• Bug fix: Improve SSL support (#88)
• Bug fix: Ensure entry stylesheets are not cached after re-publication. (#94)

Admin/Editor

• Audio/video autoplay is now configurable. (#95)
• Bug fix: Rich text editor added <p> instead of <br> tags in IE 11. (#91)

Rails Engine

• Paths of files generated by Zencoder are now configurable. (#71)
• Zencoder output to Akamai NetStorage. (#78)
• Generate protocol relative Zencoder urls when :s3_protocol in zencoder_options is empty string. (#83)
• public_entry_url_options option to configure urls of published entries. (#84, #97)
• Placeholder partial to integrate analytics in editor. (#93)
• Editor JavaScript API to allow new page types to provide new editor features. (#96)
• Bug fix: Update jbuilder gem dependency (#79)

Version 0.2.1

2014-07-25

Compare changes

• Update Zencoder gem to fix Zencoder SSL issue (#70).

Version 0.2.0

2014-07-18

Compare changes

Breaking Changes

• Themes have been splitted in Themes and Themings. Themings exist per account in the database containing configuration like copyright/imprint link urls and reference a theme. Themes represent available CSS and correspond directly to directories under pageflow/themes. Themes are registered in the Pageflow initializer. (#45)

  To update your application:

  • Add the following line to your config/initializers/pageflow.rb:

      config.themes.register(:default)
    

  • Install and run the migrations to convert your database.

Public Site

• Bug fix: Improve video playback support on iOS and Android. (#32, #33)

Admin/Editor

• Theming attributes can now be edited via the accounts admin. (#45)
• Option to require explicit confirmation of video/audio encoding by user before submitting jobs to Zencoder. (#52)
• Preview draft revision via admin. (#62)
• Bug fix: Missing translations for attribute/model names in admin. (#36, #58)
• Bug fix: Reusing files from other entries was broken in editor. (#59)

Rails Engine

• Theme CSS files are automatically registered for asset precompilation. (#45)
• pageflow:theme generator to copy theme template to main application. (#45)
• More configurable default theme. (#35)
• public_entry_request_scope option to restrict the published entries available under a certain host name. (#61)

Internals

• Tests now use MySQL. The dummy application used to test the Pageflow Gem against now uses MySQL. To run the testsuite you need to have a MySQL database called pageflow_dummy_test You can configure user and password by setting the environment variables PAGEFLOW_DB_USER and PAGEFLOW_DB_PASSWORD. If they are not present root is assumed as user and the password is left blank. (#56)
• The Accounts admin show template has been splitted into multiple partials. (#65)
• Bug fix: Specify jquery-ui-rails major version in gemspec. (#67)

Version 0.1.0

2014-05-16

Compare changes

• pageflow:install generator now creates resque rake tasks.
• Configuration option to change email address user invitations are sent from.
• Improved asset precompilation for production environment.

Version 0.0.1

2014-05-05

• Initial release