Paul Campbell
b7f607d49c
* Add GitHub Actions for CI * Remove unused CI and release files * Ignore IntelliJ files * pom: add my parent * pom: remove redundant packaging element * pom: update scm repo * pom: upgrade to Java 1.8 * pom: remove maven-release-plugin * pom: remove opencollab distributionManagement * pom: remove releases profile * pom: add kemitix-maven-tiles: maven-plugins, enforcer, compiler-jdk-8, testing * Update readme * Version set to 1.0.2 * github: test build with JDK 8 * github: remove native-image testing
57 lines
2.2 KiB
Markdown
57 lines
2.2 KiB
Markdown
# epub-creator
|
|
|
|
|
|
|
|
|
|
[](
|
|
https://oss.sonatype.org/content/repositories/releases/net/kemitix/epub-creator/)
|
|
[](
|
|
https://search.maven.org/search?q=g:net.kemitix%20a:epub-creator)
|
|
|
|
# Java EPUB3 creator API
|
|
|
|
Create EPUB3 standard ebooks.
|
|
|
|
# Features
|
|
1. Build valid EPUB3 ([Validator](http://validator.idpf.org/))
|
|
2. Add files or text as content
|
|
3. Set TOC inclusion
|
|
4. Set spine inclusion
|
|
5. Add text as content/pages
|
|
|
|
# Build instructions
|
|
|
|
You will need
|
|
|
|
1. Java 8+
|
|
2. [Maven 3+](https://maven.apache.org/download.cgi)
|
|
|
|
```
|
|
mvn clean install
|
|
```
|
|
|
|
|
|
# Code example
|
|
|
|
```java
|
|
try (FileOutputStream file = new FileOutputStream(new File("test.epub"))) {
|
|
|
|
EpubBook book = new EpubBook("en", "Samuel .-__Id1", "Test Book", "Samuel Holtzkampf");
|
|
book.addContent(this.getClass().getResourceAsStream("/epub30-overview.xhtml"),
|
|
"application/xhtml+xml", "xhtml/epub30-overview.xhtml", true, true).setId("Overview");
|
|
book.addContent(this.getClass().getResourceAsStream("/idpflogo_web_125.jpg"),
|
|
"image/jpeg", "img/idpflogo_web_125.jpg", false, false);
|
|
book.addContent(this.getClass().getResourceAsStream("/epub-spec.css"),
|
|
"text/css", "css/epub-spec.css", false, false);
|
|
book.addTextContent("TestHtml", "xhtml/test2.xhtml", "Test one two four!!!!!\nTesting two").setToc(true);
|
|
book.addTextContent("TestHtml", "xhtml/test.xhtml", "Test one two three\nTesting two").setToc(true);
|
|
book.addCoverImage(IOUtils.toByteArray(this.getClass().getResourceAsStream("/P1010832.jpg")),
|
|
"image/jpeg", "images/P1010832.jpg");
|
|
|
|
book.writeToStream(file);
|
|
}
|
|
```
|