laika.api.format
Members list
Type members
Classlikes
API basis for renderers that produce character output.
API basis for renderers that produce character output.
Attributes
- Companion
- object
- Source
- Formatter.scala
- Supertypes
- Known subtypes
-
class TagFormatter
Attributes
- Companion
- class
- Source
- Formatter.scala
- Supertypes
- Self type
-
Formatter.type
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
- Known subtypes
-
object Markdown.typeobject ReStructuredText.type
Attributes
- Companion
- trait
- Source
- MarkupFormat.scala
- Supertypes
- Self type
-
MarkupFormat.type
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
- Known subtypes
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
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