ContainerWriter

laika.render.epub.ContainerWriter

Creates the EPUB container based on a document tree and the HTML result of a preceding render operation.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def collectInputs[F[_] : Sync](result: RenderedTreeRoot[F], config: BookConfig): 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 parameters

result

the result of the render operation as a tree

Attributes

Returns

a list of all documents that need to be written to the EPUB container.

def write[F[_] : Async](result: RenderedTreeRoot[F], output: BinaryOutput[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 parameters

output

the output to write the final result to

result

the result of the render operation as a tree

Attributes