eea.epub 4.2

Publish Plone content in epub form

EEA Epub product

A product which allows you to import in Plone epub files.

Contents

Contents

• EEA Epub product

• Contents

• Introduction

• Main features

• Installation

• Getting started

• Dependecies

• Live demo

• Source code

• Copyright and license

• Links

• Funding

• Changelog

  • 4.2 - (2012-02-06)

  • 4.1 - (2012-02-06)

  • 4.0 - (2011-11-06)

  • 0.6 - (2011-04-07)

  • 0.5 - (2011-03-17)

  • 0.4 - (2011-03-09)

  • 0.3 - (2011-03-01)

  • 0.2 - (2010-10-29)

  • 0.1 - (2010-10-11)

Introduction

EEA Epub product allows you to import in Plone epub files. On upload, Epub content will imported as Plone folders, files, images and documents.

Export to Epub is also available.

Note that only epub files created with “Adobe InDesign CS4” are supported for import.

Main features

EEA Epub features:

1. Import epub files as Plone content.

2. Export into epub format.

EEA Epub makes the following assumptions:

1. You don’t use unicode or other special characters into the name of the epub, images or links

2. You’ve created the epub with “Adobe InDesign CS4” which uses some standards for thr following:

• The table of contents is named toc.ncx and is placed inside OEBPS

• Book text & images are placed inside the folder OEBPS or other folders that are children of OEBPS

• Items ids doesn’t contain the following characters . / ( if possible stick to letters, numbers and - _ )

Best practices when creating an epub:

1. Chapter names should not be all uppercase or use special characters

2. Image names should not contain spaces, periods, / or other special characters

Epubs that were created with “Adobe inDesign CS4” but failed to upload:

1. At this moment any errors that would appear on the site are surpressed by the info message: “An error occur during upload, your EPUB format may not be supported”

2. If you’ve made the epub with “Adobe InDesign CS4” and yet you get this info message then please reopen this ticket and upload there the troubleing epub: https://svn.eionet.europa.eu/projects/Zope/ticket/3883

More details about how to use this package can be found at the following link:

1. http://svn.eionet.europa.eu/projects/Zope/wiki/HowToEpub

Installation

The easiest way to get eea.epub support in Plone 4 using this package is to work with installations based on zc.buildout. Other types of installations should also be possible, but might turn out to be somewhat tricky.

To get started you will simply need to add the package to your “eggs” and “zcml” sections, run buildout, restart your Plone instance and install the “eea.epub” package using the quick-installer or via the “Add-on Products” section in “Site Setup”.

You can download a sample buildout at:

https://svn.eionet.europa.eu/repositories/Zope/trunk/eea.epub/buildouts

Getting started

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

Dependecies

1. Plone 4.x

2. BeautifulSoup

Live demo

Here some live production demos at EEA (European Environment Agency)

1. http://www.eea.europa.eu/soer/synthesis

Source code

Latest source code (Plone 4 compatible):

https://svn.eionet.europa.eu/repositories/Zope/trunk/eea.epub/trunk

Plone 2 and 3 compatible:

https://svn.eionet.europa.eu/repositories/Zope/trunk/eea.epub/branches/plone25

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

The EEA Epub (the Original Code) is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

More details under docs/License.txt

Links

1. EEA Epub wiki page: https://svn.eionet.europa.eu/projects/Zope/wiki/HowToEpub

Funding

EEA - European Enviroment Agency (EU)

Changelog

4.2 - (2012-02-06)

• no changes

4.1 - (2012-02-06)

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

4.0 - (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