Packages

c

laika.render.epub

ContainerWriter

class ContainerWriter extends AnyRef

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

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ContainerWriter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ContainerWriter()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def collectInputs[F[_]](result: RenderedTreeRoot[F], config: BookConfig)(implicit arg0: 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.

    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.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. def write[F[_]](result: RenderedTreeRoot[F], output: BinaryOutput[F])(implicit arg0: 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.

    result

    the result of the render operation as a tree

    output

    the output to write the final result to

Inherited from AnyRef

Inherited from Any

Ungrouped