laika-core
1.0.1
API
Generated with
laika-core/laika/laika.format/XSLFO

XSLFO

laika.format.XSLFO
object XSLFO extends RenderFormat[TagFormatter]

A renderer for XSL-FO output. May be directly passed to the Render or Transform APIs:

Renderer.of(XSLFO).build.render(document)

Transformer.from(Markdown).to(XSLFO).build.transform(inputString)

This renderer is usually used as an interim format for producing a PDF, where you do not deal with this format directly. But it can alternatively also be used as the final output and then get processed by external tools.

Attributes

Source
XSLFO.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
XSLFO.type

Members list

Type members

Classlikes

object formatterSyntax extends FormatterSyntax

Expands the TagFormatter API with convenient shortcuts specifically tailored for rendering XSL-FO elements.

Expands the TagFormatter API with convenient shortcuts specifically tailored for rendering XSL-FO elements.

Attributes

Source
XSLFO.scala
Supertypes
trait FormatterSyntax
class Object
trait Matchable
class Any
Self type

Inherited classlikes

case class Overrides(value: PartialFunction[(FMT, Element), String]) extends RenderOverrides

Attributes

Inherited from:
RenderFormat
Source
RenderFormat.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Concrete fields

val defaultRenderer: (TagFormatter, Element) => String

The default renderer function for this output format.

The default renderer function for this output format. It may be overridden by extensions for individual nodes of the AST.

The function takes both, a formatter instance and the element to render and returns a String in the target format.

Attributes

Source
XSLFO.scala
override val 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
XSLFO.scala
val fileSuffix: String

The file suffix to use when rendering the output to a file.

The file suffix to use when rendering the output to a file. When transforming entire directories the suffix of the markup file will be automatically replaced by the suffix for the output format.

Attributes

Source
XSLFO.scala
val formatterFactory: Context[TagFormatter] => TagFormatter

The function for creating a new formatter for each render operation, based on the specified context containing the root element, the indentation mechanism and the delegate function for rendering child elements (that may contain user-specified extensions this render format implementation is not aware of).

The function for creating a new formatter for each render operation, based on the specified context containing the root element, the indentation mechanism and the delegate function for rendering child elements (that may contain user-specified extensions this render format implementation is not aware of).

The formatter created by this function (or copies created from it) will be used when invoking the default renderer.

Attributes

Source
XSLFO.scala
Generated with