View Source BUPE.Config (BUPE v0.6.1)

Configuration structure that holds all the available options for EPUB.

Most of these fields are used in the Package Definition document, this document includes bibliographic and structural metadata about an EPUB Publication, and is thus the primary source of information about how to process and display it.

EPUB specification fields

title - Represents an instance of a name given to the EPUB Publication.
creator - Represents the name of a person, organization, etc. responsible for the creation of the content
contributor - Represents the name of a person, organization, etc. that played a secondary role in the creation of the content.
date - Define the publication date. The publication date is not the same as the last modification date. See: Date and Time Formats
modified - The modification date must be expressed in Coordinated Universal Time (UTC) and must be terminated by the Z time zone indicator.
identifier - Contains a single identifier associated with the EPUB Publication, such as a UUID, DOI, ISBN or ISSN. Default: UUID
language - Specifies the language used in the contents. Default: "en"
version - Specifies the EPUB specification version to which the Publication conforms. Default: "3.0"
unique_identifier - Specifies a primary identifier that is unique to one and only one particular EPUB Publication
source - Identifies the source publication from which this EPUB Publication is derived.
type - Indicates that the given Publication is of a specialized type (e.g., annotations packaged in EPUB format or a dictionary). See the EPUB Publication Types Registry document for more information.

For more information about other fields as description, format, coverage, publisher, relation, rights, subject, etc. please see the Package Metadata section of the EPUB specification.

Support configuration

pages - List of XHTML files which will be included in the EPUB document, please keep in mind that the sequence here will set the navigation order in the EPUB document.
styles - List of CSS files which will be included in the EPUB document
scripts - List of JS files which will be included in the EPUB document
images - List of images which will be included in the EPUB document.
cover - Specifies if you want a default cover page, default: true
logo - Image for the cover page

Summary

Types

contributor()

creator()

t()

title()

Types

contributor()

@type contributor() :: String.t()

creator()

@type creator() :: String.t()

t()

@type t() :: %BUPE.Config{
  audio: [map()],
  contributor: contributor(),
  cover: boolean(),
  coverage: String.t(),
  creator: creator(),
  date: String.t(),
  description: String.t(),
  fonts: [map()],
  format: String.t(),
  identifier: String.t(),
  images: [Path.t() | BUPE.Item.t()],
  language: String.t(),
  logo: String.t(),
  modified: String.t(),
  nav: list(),
  pages: [Path.t() | BUPE.Item.t()],
  publisher: String.t(),
  relation: String.t(),
  rights: String.t(),
  scripts: [Path.t() | BUPE.Item.t()],
  source: String.t(),
  styles: [Path.t() | BUPE.Item.t()],
  subject: String.t(),
  title: title(),
  toc: [map()],
  type: String.t(),
  unique_identifier: String.t(),
  version: String.t()
}

title()

@type title() :: String.t()