Working with metadata in EPUB e-books

View as MarkdownMarkdown

Set up your AI agent

Give your coding agent live access to the GroupDocs documentation and API reference through the GroupDocs Docs MCP server — no install, no API key. Learn more

claude mcp add --transport http groupdocs-docs https://docs.groupdocs.com/mcp

Also process documents locally

The GroupDocs.Metadata MCP server lets your agent work with files on your machine; they are never uploaded. It needs the .NET 10 SDK or Docker.

claude mcp add groupdocs-metadata -- dnx GroupDocs.Metadata.Mcp --yes
Folders, licensing and more →

What is EPUB?

EPUB is an e-book file format that uses the “.epub” file extension. EPUB is supported by many e-readers, and compatible software is available for most smartphones, tablets, and computers. 

Note
Please find more information on the format at https://en.wikipedia.org/wiki/EPUB

Reading EPUB format-specific properties

The GroupDocs.Metadata API supports extracting format-specific information from EPUB files.

The following are the steps to read native EPUB metadata.

  1. Load an EPUB file
  2. Get the root metadata package
  3. Extract  the native metadata package using the EpubRootPackage.getEpubPackage method
  4. Read the EPUB metadata properties

advanced_usage.managing_metadata_for_specific_formats.ebook.EpubReadNativeMetadataProperties

try (Metadata metadata = new Metadata(Constants.InputEpub)) {
	EpubRootPackage root = metadata.getRootPackageGeneric();

	System.out.println(root.getEpubPackage().getVersion());
	System.out.println(root.getEpubPackage().getUniqueIdentifier());
	System.out.println(root.getEpubPackage().getImageCover() != null ? root.getEpubPackage().getImageCover().length : 0);
}

Updating EPUB format-specific properties

The GroupDocs.Metadata API also supports updating some metadata properties of an EPUB file. Please see the code snippet below to learn how to do that.

advanced_usage.managing_metadata_for_specific_formats.ebook.EpubUpdateNativeMetadataProperties

try (Metadata metadata = new Metadata(Constants.InputEpub)) {
    EpubRootPackage root = metadata.getRootPackageGeneric();
 
    root.getEpubPackage().setCreator("GroupDocs");
    root.getEpubPackage().setDescription("test e-book");
    root.getEpubPackage().setFormat("EPUB");
    root.getEpubPackage().setDate(new Date().toString());
 
    // ...
 
    metadata.save(Constants.OutputEpub);
}

Reading Dublin Core Metadata

Dublin Core metadata is a set of certain metadata properties that are intended to describe various digital resources. Please find more information on the Dublin Core standard at https://en.wikipedia.org/wiki/Dublin_Core. The code sample below shows how to extract Dublin Core metadata from a EPUB e-book using the GroupDocs.Metadata API.

advanced_usage.managing_metadata_for_specific_formats.ebook.EpubReadDublinCoreProperties

try (Metadata metadata = new Metadata(Constants.InputEpub)) {
    EpubRootPackage root = metadata.getRootPackageGeneric();
 
    System.out.println(root.getDublinCorePackage().getRights());
    System.out.println(root.getDublinCorePackage().getPublisher());
    System.out.println(root.getDublinCorePackage().getTitle());
    System.out.println(root.getDublinCorePackage().getCreator());
    System.out.println(root.getDublinCorePackage().getLanguage());
    System.out.println(root.getDublinCorePackage().getDate());
 
    // ...
}

Please see the the DublinCorePackage class to get more information on supported Dublin Core metadata properties.

Updating Dublin Core Metadata

The GroupDocs.Metadata API also allows updating DublinCore metadata properties in an EPUB file. Please check the code sample below.

advanced_usage.managing_metadata_for_specific_formats.ebook.EpubUpdateDublinCoreProperties

try (Metadata metadata = new Metadata(Constants.InputEpub)) {
 
    EpubRootPackage root = metadata.getRootPackageGeneric();
 
    root.getDublinCorePackage().setProperties(new WithNameSpecification("dc:creator"), new PropertyValue("GroupDocs"));
    root.getDublinCorePackage().setProperties(new WithNameSpecification("dc:description"), new PropertyValue("test e-book"));
    root.getDublinCorePackage().setProperties(new WithNameSpecification("dc:title"), new PropertyValue("test EPUB"));
    root.getDublinCorePackage().setProperties(new WithNameSpecification("dc:date"), new PropertyValue(new Date().toString()));
 
    // ...
 
    metadata.save(Constants.OutputEpub);
}

More resources

GitHub examples

You may easily run the code above and see the feature in action in our GitHub examples:

EPUB metadata management demo App

The EPUB Metadata Editing app is available to view and edit metadata of EPUB e-books, including title, creator, publisher, language, and other Dublin Core properties.