eea.epub 6.3

Asynchronous setup

By default all ePubs are NOT generated asynchronous. You’ll need eea.pdf installed in order to be able to enable asynchronous download or you can provide an os environment called EEACONVERTER_ASYNC.

Also some extra config is needed within your buildout in order for this to work properly.

First of all you’ll need a folder were to store generated ePub files. For this you can create it manually within buildout:directory/var/ or you can let buildout handle it:

[buildout]

parts +=
    media-downloads
    media-downloads-temp

media-downloads-path = ${buildout:directory}/var/downloads/pdf
media-downloads-temp = ${buildout:directory}/var/downloads/tmp

[media-downloads]
recipe = ore.recipe.fs:mkdir
path = ${buildout:media-downloads-path}
mode = 0700
createpath = true

[media-downloads-temp]
recipe = ore.recipe.fs:mkdir
path = ${buildout:media-downloads-temp}
mode = 0700
createpath = true

This will create a folder named downloads within buildout:directory/var/

Next, in order for this folder to be visible from your website and your users to be able to download generated ePubs you’ll need to tell to your zope instances about it:

[buildout]

media-downloads-name = downloads
media-downloads-path = ${buildout:directory}/var/downloads/pdf
media-downloads-temp = ${buildout:directory}/var/downloads/tmp

[instance]

environment-vars +=
  EEADOWNLOADS_NAME ${buildout:media-downloads-name}
  EEADOWNLOADS_PATH ${buildout:media-downloads-path}
  EEACONVERTER_TEMP ${buildout:media-downloads-temp}
  EEACONVERTER_ASYNC True

Also, don’t forget to setup plone.app.async

[buildout]

[instance]
eggs +=
    plone.app.async
zcml +=
    plone.app.async-single_db_worker

Import

From “Add new” menu select “EpubFile” and upload an epub file.

Export

Go to Home page and click on download as ePub icon at the bottom of the page

or directly access http://localhost:8080/Plone/front-page/download.epub

Can download ePub (eea.epub.download)

Assign this permission to roles that you want to be able to download content as ePub Default: Owner, Manager, Editor

Can customize ePub (eea.epub.customize)

Assign this permission to roles that you want to be able to contextually customize the output ePub look and feel Default: Manager, Site Administrator

ePub export succeeded

Notify the person who requested a ePub export that the ePub successfully exported and provide a link to the downloadable ePub

ePub export failed

Notify the person who requested a ePub export that the ePub export failed.

ePub export failed (admin)

Notify admin that there were issues while exporting ePub

${download_came_from_url}

The absolute URL of the Plone object which is downloaded as ePub

${download_email}

Email address of the user that triggered the download as ePub action

${download_error}

Error traceback when download as ePub job fails

${download_from_email}

Site Admin email address customizable via Plone > Site Setup > Mail

${download_from_name}

Site Admin name customizable via Plone > Site Setup > Mail

${download_title}

Title of the Plone object which is downloaded as ePub

${download_url}

The absolute URL where the generated output ePub can be downloaded

${download_type}

Download type. Default to EPUB for this package. It is package specific and it can be EPUB, PDF, etc.

6.3 - (2015-08-18)

• Change: Auto-include zcml within plone context in order to make this package work without having to add it within buildout zcml directive. [avoinea]

6.2 - (2015-03-17)

• Change: Switched to curl in the jenkins build install script [olimpiurob refs #22402]

• Change: Changed fetch url for jenkins build install script to the install script from the main EEA CPB repository [olimpiurob refs #22402]

• Bug fix: Added a way to know if the ePub is being generated even if the async worker is down or the queue is too busy. [voineali refs #23411]

6.1 - (2015-02-27)

• Bug fix: Fixed validation errors for exported ePubs (epubchecker) [avoinea]

6.0 - (2015-02-25)

• Upgrade step: I. Within “Plone > Site setup > Add-ons” install “EEA Converter” II. Within Plone > Site setup > Content Rules: 1. Filter by Async PDF Export (fail) and Async PDF Export (success) 2. Disable founded rules 3. Filter by Async Export (fail) and Async Export (success) 4. Update these rules email texts with previous disabled ones (PDF ones) by changing PDF with ${download_type} 5. Delete Async PDF Export (fail) and Async PDF Export (success) related rules [voineali refs #22971]

• Feature: Added possibility to download documents as ePub asynchronously [voineali refs #22971]

• Bug fix: fixed UnicodeDecodeError within download.epub template [voineali refs #23338]

5.9 - (2015-02-16)

• Feature: Added possibility to add a fallback ePub file within context called action-download-epub in order to temporarily stop dynamic ePub generation and statically return this item. [voineali refs #22970]

5.8 - (2015-02-03)

• Feature: Added “Download as ePub” action also within export_actions category [voineali refs #22686]

5.7 - (2014-09-15)

• Change: Made @@epub.support/can_download accessible from URL [voineali refs #20846]

5.6 - (2014-08-12)

• Bug fix: fixed tests [ghicaale refs #20451]

5.5 - (2014-08-12)

• Upgrade step: Assign “Can download ePub” permission to CommonEditor

• Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for eea.epub

• Change: Renamed epub_view to download.epub [voineali refs #20393]

• Feature: Added “Can download ePub” and “Can customize ePub” permissions [voineali refs #20436]

5.4 - (2014-07-15)

• Bug fix: Export to epub even if there is no PDF cover set for content-type [voineali refs #20268]

• Change: Removed collective.sendaspdf dependency [voineali refs #20268]

5.3 - (2014-06-06)

• Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for eea.epub [voineali refs #19882]

• Change: Moved EPUB related images and actions from eea.soercontent package [voineali refs #19882]

5.2 - (2014-01-21)

• Feature: adding Sphinx-generated documentation in Page Template format [batradav refs #9502]

• Bug fix: removed wrongly added blockquotes within README.rst [ichim-david refs #18064]

• Bug fix: Updated old URLs pointing Trac [ghicaale refs #18003]

5.1 - (2013-11-20)

• Bug fix: links were missing any style [simiamih refs #16799]

5.0 - (2013-10-22)

• Feature: improved epub - daviz reference, toc, styles, cover [simiamih refs #16799]

4.9 - (2013-10-07)

• Feature: major export improvements - image files, cover photo, css [simiamih refs #16799]

4.8 - (2013-10-04)

• Change: updated zope imports with the versions that require minimum Plone 4.1 for eea.epub [ichimdav refs #15651]

4.7 - (2013-06-17)

• Change: use BeautifulSoup4 instead of deprecated BS 3 [tiberich #14584]

4.6 - (2013-01-15)

• Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for eea.epub [ichimdav #9068]

• Feature: register epubs with application/epub+zip mimetype [ichimdav #9068]

4.5 - (2012-11-22)

• Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for eea.epub [ichimdav #3621]

• Feature: use filename id when creating plone content, cleaning the filename id when it contains illegal characters if boolean property clean_epub_filename is enabled at portal_properties/site_properties [ichimdav #3621]

4.4 - (2012-06-12)

• Bug fix: fixed markup of HISTORY.txt file [ciobabog refs #5231]

• Change: Change code in eea.epub to fix translation problem [prospchr refs #5159]

4.3 - (2012-04-26)

• Feature: import epubs that are not created by Adobe Indesign which have the images and the html pages in separate folder like those created by Sigil [ichimdav #5054]

4.2 - (2012-02-06)

• no changes

4.1 - (2012-02-06)

• Bug fix: Added dependencies to setup.py [voineali]

4.0-dev - (2011-11-06)

• Bug fix: proper parsing of html entities by using an html parser instead of an xml one [ichimdav #4523]

• Bug fix: cleaned spaces defined as &nbsp that can’t be read as xml [ichimdav #4271]

• Cleanup: fixed all pylint, pyflakes violations [voineali #4121]

• Feature: added upgrade steps [voineali @4392]

• Feature: Plone 4.0.4 compatible release [tiberich #4121]

0.6 - (2011-04-07)

• Bug fix: clean epub import to prevent navigation portlet from miss-behaving [ichimdav #4242]

• Bug fix: fixes #4242 Removed / clean up, the portlet epub and toc, we can use standard plone nav [demarant]

• Feature: force documents/chapters not to be renamed after title change [demarant]

0.5 - (2011-03-17)

• Bug fix: fixed wrong anchors that spanned over paragraphs [ichimdav #4196]

• Bug fix: added translation domain to ZCML files [voineali #4139]

0.4 - (2011-03-09)

• Change: cleaned test, added doctypes, fixed pylint violations warnings [ichimdav #4140]

0.3 - (2011-03-01)

• Change: surpressed error messages with an info status message [ichimdav #3883]

• Bug fix: fix epub file import [ichimdav #3883]

0.2 - (2010-10-29)

• Feature: add-to-folder menu item [thuliper #3627]

• Bug fix: image link fixes [thuliper #3711]

0.1 - (2010-10-11)

• Initial release