ContainerWriter
class ContainerWriter
Creates the EPUB container based on a document tree and the HTML result of a preceding render operation.
class Object
trait Matchable
class Any
Value members
Concrete methods
def collectInputs[F[_]](result: RenderedTreeRoot[F], config: BookConfig)(implicit evidence$1: Sync[F]): Seq[BinaryInput[F]]
Collects all documents that need to be written to the EPUB container.
Collects all documents that need to be written to the EPUB container.
This includes:
- All rendered HTML in the provided result tree.
- All static content in the provided document tree, copied to the same relative path within the EPUB container.
- Metadata and navigation files as required by the EPUB specification, auto-generated from the document tree and the configuration of this instance.
- Value Params
- result
the result of the render operation as a tree
- Returns
a list of all documents that need to be written to the EPUB container.
def write[F[_]](result: RenderedTreeRoot[F], output: BinaryOutput[F])(implicit evidence$2: Sync[F]): F[Unit]
Produces an EPUB container from the specified document tree.
Produces an EPUB container from the specified document tree.
This includes:
- All rendered HTML in the provided result tree.
- All static content in the provided document tree, copied to the same relative path within the EPUB container.
- Metadata and navigation files as required by the EPUB specification, auto-generated from the document tree and the configuration of this instance.
- Value Params
- output
the output to write the final result to
- result
the result of the render operation as a tree