From version 3.2
edited by Admin
on 2019/11/05 01:56
To version 4.1
edited by slauriere
on 2019/11/07 09:13
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.Admin
1 +xwiki:XWiki.slauriere
ExtensionCode.ExtensionClass[0]
Description
... ... @@ -1,1 +1,72 @@
1 -Export pages as [[epub>>https://en.wikipedia.org/wiki/EPUB]] books. Documentation in progress.
1 +
2 +This application makes it possible to export pages as [[epub>>https://en.wikipedia.org/wiki/EPUB]] books.
3 +
4 +== Tutorial
5 +
6 +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>>https://en.wikipedia.org/wiki/Yves_Klein]], painter.
7 +
8 +=== Book general properties
9 +
10 +Fill in the form as follows:
11 +
12 +|=Property|=Value
13 +|=Title|Yves Klein
14 +|=Identifier|yves-klein
15 +|=Author|Wikipedia
16 +|=Cover image|//Leave emtpy for now//
17 +|=Chapters and sections|(((
18 +{{code}}
19 +* [[Biography]]
20 +* [[Pot-pourri]]
21 +** [[Anthropometries]]
22 +** [[IKB]]
23 +** [[Fire Paintings]]
24 +{{/code}}
25 +)))
26 +
27 +=== Book sections
28 +
29 +Leave the other fields as is. Then, create the pages mentioned in the //Chapters and sections//. Beware these pages must be terminal pages for now, that's a limitation of the application at the moment. In each page, use either some placeholder content or content from [[the Yves Klein Wikipedia page>>https://en.wikipedia.org/wiki/Yves_Klein]] and other web sites. Attach an image to the Biography page and include it the page content, for instance:
30 +
31 +{{code language="text"}}
32 +Yves Klein (French pronunciation: [iv klɛ̃]; 28 April 1928 – 6 June 1962) was a French artist and an important
33 +figure in post-war European art. He was a leading member of the French artistic movement of Nouveau réalisme
34 +founded in 1960 by art critic Pierre Restany. Klein was a pioneer in the development of performance art, and
35 +is seen as an inspiration to and as a forerunner of minimal art, as well as pop art.
36 +
37 +image:Yves_Klein.jpg
38 +
39 +Source: Wikipedia - License: Creative Commons Attribution-ShareAlike License
40 +https://en.wikipedia.org/wiki/Yves_Klein -
41 +{{/code}}
42 +
43 +
44 +=== Book cover image
45 +
46 +Get back to the book page, edit it in order to set a cover image, for instance with the value, then save the page.
47 +
48 +|=Property|=Value
49 +|=Cover image|[email protected]_Klein.jpg
50 +
51 +=== Export the book
52 +
53 +(% class="row" %)(((
54 +(% class="col-md-6" %)(((
55 +
56 +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>>https://en.wikipedia.org/wiki/Calibre_(software)]].
57 +
58 +)))
59 +(% class="col-md-6 text-center" %)(((
60 +image:yves-klein-epub-sample.jpg
61 +
62 +//Viewing the generated EPUB in [[Calibre>>https://en.wikipedia.org/wiki/Calibre_(software)]]//
63 +)))
64 +)))
65 +
66 +== Next steps
67 +
68 +* Use the book identifier or title for the epub filename
69 +* Make sure the application works fine with non-terminal pages
70 +* Integrate the code with the XWiki Filter Framework
71 +* Integrate an epub viewer in XWiki
72 +

Get Connected