External module "clib/opf"

create_opf

• create_opf(book: Collection): string

• Creation of the of the Package file for a collection, per the EPUB 3.3 Package Document Specification. See also the PackageWrapper documentation.

  The method

  1. Stores the stable files like title and nav in the package;
  2. Collects the dates and editors from the book and adds that to the package;
  3. Collects the manifest item data for each package and adds it to the new package;
  4. Adds the manifest items, the linear spine items, and the collections.
  5. Adds the non-linear spine items.
  6. Sets the wcag conformance if all chapters are conform

  Note that the internal structure of the final book, reflected in the modified manifest items, means putting each chapter into its own subdirectory, named after the chapter’s short name.

  Parameters

  • book: Collection

    the final book data

  Returns string

  • the Package file in textual format