eea.epub 4.3

Publish Plone content in epub form

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

Contents
========

.. contents::


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.

As of version 4.3 epub files created with **Adobe InDesign CS4** and **Sigil** are tested and known
to work with this package, previous versions of this package only supported epubs created with InDesign.


Main features
=============

EEA Epub features:

1. Imports epub files as Plone content.
2. Stores the original epub in the main folder for easy retrieval.
3. Exports the Plone content back into an epub.

Epub compatibility
==================

EEA Epub makes the following assumptions about the loaded epub:

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" or "Sigil" which uses some standards for the 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

Debugging
=========

At this moment any errors that would appear on the site are surpressed with a info message.

If you want to see the detailed error check the Plone instance log usually found in buildout-folder/var/log.

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".

.. _`zc.buildout`: http://pypi.python.org/pypi/zc.buildout/

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. BeautifulSoup
2. Lxml
3. Plone 4.x


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)

.. _EEA: http://www.eea.europa.eu/


Changelog
=========

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