Epublib

http://www.siegmann.nl/epublib
Admin
Epublib is a Java library for reading, writing, and managing EPUB files programmatically with...
Tokens:2,555
Snippets:27
Trust Score:4
Update:6 months ago
Show doc for...
Tokens:
Raw
### Read EPUB File and Get Title

Source: http://www.siegmann.nl/epublib/example-programs/read-epub-file

Use EpubReader to open an EPUB file and retrieve its title from the metadata. Ensure the EPUB file exists at the specified path.

```java
EpubReader epubReader = new EpubReader();
Book book = epubReader.readEpub(new FileInputStream("mybook.epub"));
// print the first title
List<String> titles = book.getMetadata().getTitles();
System.out.println("book title:" + (titles.isEmpty() ? "book has no title" : titles.get(0)));
```

--------------------------------

### Create a simple EPUB book in Java

Source: http://www.siegmann.nl/epublib/example-programs/epub-sample-simple1

Demonstrates the initialization of a Book object, adding metadata, chapters, and resources, and writing the final file to disk.

```java
package nl.siegmann.epublib.examples; package nl.siegmann.epublib.epub; import java.io.FileOutputStream; import nl.siegmann.epublib.domain.Author;import nl.siegmann.epublib.domain.Book;import nl.siegmann.epublib.domain.Resource;import nl.siegmann.epublib.domain.TOCReference; public class Simple1 {public static void main(String[] args) {try {// Create new BookBook book = new Book(); // Set the titlebook.getMetadata().addTitle("Epublib test book 1"); // Add an Authorbook.getMetadata().addAuthor(new Author("Joe", "Tester")); // Set cover imagebook.getMetadata().setCoverImage(new Resource(Simple1.class.getResourceAsStream("/book1/test_cover.png"), "cover.png")); // Add Chapter 1book.addSection("Introduction", new Resource(Simple1.class.getResourceAsStream("/book1/chapter1.html"), "chapter1.html")); // Add css filebook.getResources().add(new Resource(Simple1.class.getResourceAsStream("/book1/book1.css"), "book1.css")); // Add Chapter 2TOCReference chapter2 = book.addSection("Second Chapter", new Resource(Simple1.class.getResourceAsStream("/book1/chapter2.html"), "chapter2.html")); // Add image used by Chapter 2book.getResources().add(new Resource(Simple1.class.getResourceAsStream("/book1/flowers_320x240.jpg"), "flowers.jpg")); // Add Chapter2, Section 1book.addSection(chapter2, "Chapter 2, section 1", new Resource(Simple1.class.getResourceAsStream("/book1/chapter2_1.html"), "chapter2_1.html")); // Add Chapter 3book.addSection("Conclusion", new Resource(Simple1.class.getResourceAsStream("/book1/chapter3.html"), "chapter3.html")); // Create EpubWriterEpubWriter epubWriter = new EpubWriter(); // Write the Book as EpubepubWriter.write(book, new FileOutputStream("test1_book1.epub"));} catch (Exception e) {e.printStackTrace();}}}
```

--------------------------------

### Read, Modify, and Write EPUB Files

Source: http://www.siegmann.nl/epublib

Demonstrates the basic workflow of reading an existing EPUB, updating its title metadata, and saving the modified book to a new file.

```java
// read epub
EpubReader epubReader = new EpubReader();
Book book = epubReader.readEpub(new FileInputStream("mybook.epub"));
// set title
book.getMetadata().setTitles(new ArrayList<String>() {{ add("an awesome book");}});
// write epub
EpubWriter epubWriter = new EpubWriter();
epubWriter.write(book, new FileOutputStream("mynewbook.epub"));
```

--------------------------------

### Log EPUB metadata and table of contents on Android

Source: http://www.siegmann.nl/epublib/android

Demonstrates how to load an EPUB file from the assets folder and log its metadata, cover image dimensions, and table of contents using an Android Activity.

```java
import java.io.IOException;import java.io.InputStream;import java.util.List; import nl.siegmann.epublib.domain.Book;import nl.siegmann.epublib.domain.TOCReference;import nl.siegmann.epublib.epub.EpubReader;import android.app.Activity;import android.content.res.AssetManager;import android.graphics.Bitmap;import android.graphics.BitmapFactory;import android.os.Bundle;import android.util.Log; /** * Log the info of 'assets/books/testbook.epub'. * * @author paul.siegmann * */public class LogTestBookInfo extends Activity {  /** Called when the activity is first created. */  @Override  public void onCreate(Bundle savedInstanceState) {    super.onCreate(savedInstanceState);    setContentView(R.layout.main);    AssetManager assetManager = getAssets();    try {      // find InputStream for book      InputStream epubInputStream = assetManager          .open("books/testbook.epub");       // Load Book from inputStream      Book book = (new EpubReader()).readEpub(epubInputStream);       // Log the book's authors      Log.i("epublib", "author(s): " + book.getMetadata().getAuthors());       // Log the book's title      Log.i("epublib", "title: " + book.getTitle());       // Log the book's coverimage property      Bitmap coverImage = BitmapFactory.decodeStream(book.getCoverImage()          .getInputStream());      Log.i("epublib", "Coverimage is " + coverImage.getWidth() + " by "          + coverImage.getHeight() + " pixels");       // Log the tale of contents      logTableOfContents(book.getTableOfContents().getTocReferences(), 0);    } catch (IOException e) {      Log.e("epublib", e.getMessage());    }  }   /**   * Recursively Log the Table of Contents   *   * @param tocReferences   * @param depth   */  private void logTableOfContents(List<TOCReference> tocReferences, int depth) {    if (tocReferences == null) {      return;    }    for (TOCReference tocReference : tocReferences) {      StringBuilder tocString = new StringBuilder();      for (int i = 0; i < depth; i++) {        tocString.append("\t");      }      tocString.append(tocReference.getTitle());      Log.i("epublib", tocString.toString());       logTableOfContents(tocReference.getChildren(), depth + 1);    }  }}
```

--------------------------------

### Apply XSL stylesheet to EPUB sections

Source: http://www.siegmann.nl/epublib/example-programs/command-line

Applies a specified XSL stylesheet to every section within the EPUB book.

```bash
java -jar epublib-1.0-SNAPSHOT.one-jar.jar --in inputbook.epub --out result.epub --xsl "my_stylesheet.xsl" --type epub
```

--------------------------------

### Clean up an EPUB file

Source: http://www.siegmann.nl/epublib/example-programs/command-line

Performs cleanup and attempts to fix the cover page. This process occurs automatically whenever an EPUB is written.

```bash
java -jar epublib-1.0-SNAPSHOT.one-jar.jar --in inputbook.epub --out result.epub  --type epub
```

--------------------------------

### Change the title of an EPUB

Source: http://www.siegmann.nl/epublib/example-programs/command-line

Updates the title metadata of the specified EPUB file.

```bash
java -jar epublib-1.0-SNAPSHOT.one-jar.jar --in inputbook.epub --out result.epub --title "new title" --type epub
```
Tokens:
Raw