EPUB Export Application
 | Export pages as epub books. |
| Type | XAR |
| Category | Application |
| Developed by | |
| Active Installs | 9 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
Table of contents
Description
This application makes it possible to export pages as epub books.
Tutorial
In order to create an epub book, once the application is installed, go to the EPUB Export Application home page from the applications menu. From there, hit the standard "Create" button and choose the "EPUB book" template. Let's create a book named "Yves Klein" which is about Yves Klein, painter.
Book general properties
Fill in the form as follows:
| Property | Value |
|---|---|
| Title | Yves Klein |
| Identifier | yves-klein |
| Author | Wikipedia |
| Cover image | Leave emtpy for now |
| Chapters and sections | * [[Biography]] * [[Pot-pourri]] ** [[Anthropometries]] ** [[IKB]] ** [[Fire Paintings]] |
Book sections
Leave the other fields as is. Then, create the pages mentioned in the Chapters and sections. In each page, use either some placeholder content or content from the Yves Klein Wikipedia page and other web sites. Attach an image to the Biography page and include it the page content, for instance:
figure in post-war European art. He was a leading member of the French artistic movement of Nouveau réalisme
founded in 1960 by art critic Pierre Restany. Klein was a pioneer in the development of performance art, and
is seen as an inspiration to and as a forerunner of minimal art, as well as pop art.
image:Yves_Klein.jpg
Source: Wikipedia - License: Creative Commons Attribution-ShareAlike License
https://en.wikipedia.org/wiki/Yves_Klein -
Book cover image
Get back to the book page, edit it in order to set a cover image, for instance with the value, then save the page.
| Property | Value |
|---|---|
| Cover image | [email protected]_Klein.jpg |
Export the book
Hit the button "Create EPUB" at the bottom of the book page. You should get a prompt for downloading an epub file, which can then be read with any EPUB 3 reader, such as Calibre.
Viewing the generated EPUB in Calibre
Next steps
- Use the book identifier or title for the epub filename
- Integrate the code with the XWiki Filter Framework
- Integrate an epub viewer in XWiki
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.
You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
Dependencies
Dependencies for this extension (org.xwiki.contrib:xwiki-epub-export-pages 0.2):
- org.xwiki.contrib:xwiki-epub-export-lib 0.2
