The Configuration object
Run some checks against the Configuration. Currently that means verifying that files in the Manifest exist.
The Configuration object
Creates the metadata files, container.xml
, the OPF file and the NCX file.
The Configuration object
Handles the mkmeta
command from cli.js
The name of the Configuration file
Handle the package
command from cli.js
.
The file name for the Configuration file
From the container.xml
file, look for any rootfile
elements, returning
a descriptive object ({@link RootFileData}) for each.
The Document of the container.xml
file
An array of {@link RootFileData} objects
Scans the file system, constructing ManifestItem items for each, and ultimately constructing a Manifest object.
The Configuration object
Returns a Manifest object
Reads the container.xml
file from the EPUB directory.
The path name of the directory
A simple object ({@link ContainerXMLData}) describing the container.xml
data
Reads the OPF file from the EPUB, parsing it to an XML Document.
The directory where the EPUB files are stored
The file name of the OPF file
An object ({@link OPFData}) for the OPF file
Reads the XHTML file, returning an object ({@link XHTMLData}) containing the text which was read, and the parsed XML Document.
The directory for the EPUB data
The file name for the file to read
An object ({@link XHTMLData}) containing data read from the file
Returns an array of ManifestItem items that are in the spine
The Configuration object
An array of ManifestItem objects that are in the spine
For ManifestItem objects that are in the spine, read the title from the matching XHTML file, adding it as the title field.
The Configuration object
Generated using TypeDoc
Package the book described by the configuration.