laika-docs
1.1.0
API
Generated with
laika-docs/laika/laika.api/laika.api.format/TwoPhaseRenderFormat

TwoPhaseRenderFormat

laika.api.format.TwoPhaseRenderFormat
trait TwoPhaseRenderFormat[FMT, PP]

Render format based on a render phase for an interim result and a post processor.

Examples for such a format are PDF (with XSL-FO as the interim format) or EPUB (with XHTML as the interim format).

Attributes

Source
TwoPhaseRenderFormat.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object EPUB
object PDF

Members list

Value members

Abstract methods

def interimFormat: RenderFormat[FMT]

The render format for the interim result, the first phase of this renderer.

The render format for the interim result, the first phase of this renderer.

Attributes

Source
TwoPhaseRenderFormat.scala
def postProcessor: PP

Post processor that produces the final result based on the interim format.

Post processor that produces the final result based on the interim format.

Attributes

Source
TwoPhaseRenderFormat.scala
def prepareTree(tree: DocumentTreeRoot): Either[Throwable, DocumentTreeRoot]

A hook that allows this processor to modify or enhance the given document tree.

A hook that allows this processor to modify or enhance the given document tree. A common use case is to add navigation information for e-book formats like EPUB or PDF for example.

The modified tree produced by this method will be used for rendering the interim format specified with the format property.

Attributes

Source
TwoPhaseRenderFormat.scala

Concrete methods

def description: String

Short string describing the markup or output format for tooling and logging.

Short string describing the markup or output format for tooling and logging.

Attributes

Source
TwoPhaseRenderFormat.scala
Generated with