laika.api.format

Members list

Type members

Classlikes

abstract class Formatter

API basis for renderers that produce character output.

API basis for renderers that produce character output.

Attributes

Companion
object
Source
Formatter.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class TagFormatter
object Formatter

Attributes

Companion
class
Source
Formatter.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Formatter.type
trait MarkupFormat

Responsible for creating parser instances for a specific markup format.

Responsible for creating parser instances for a specific markup format. A parser is simply a function of type Input => Document.

Attributes

Companion
object
Source
MarkupFormat.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Markdown.type
object ReStructuredText.type
object MarkupFormat

Attributes

Companion
trait
Source
MarkupFormat.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait RenderFormat[FMT]

Responsible for creating renderer instances for a specific output format.

Responsible for creating renderer instances for a specific output format. A renderer is simply a function of type (Formatter, Element) => String. In addition to the actual renderer function, the factory method also produces an instance of the generic FMT type which is the formatter API to use for custom renderer functions and which is specific to the output format.

Attributes

Source
RenderFormat.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AST.type
object HTML.type
object XSLFO.type
abstract class TagFormatter extends Formatter

Base type for formatters that produce tag-based output formats like XML or HTML.

Base type for formatters that produce tag-based output formats like XML or HTML.

Extends the base Formatter type and adds methods for writing text with special characters as entities and for conveniently writing tags with attributes.

Laika's internal formatters for the supported output formats HTML, XHTML for EPUB and XSL-FO for PDF all share this common API, even though they differ in implementation.

Attributes

Source
TagFormatter.scala
Supertypes
class Formatter
class Object
trait Matchable
class Any
trait TwoPhaseRenderFormat[FMT, PP]

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

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
Supertypes
class Object
trait Matchable
class Any