Formatter

laika.api.format.Formatter
See theFormatter companion class
object Formatter

Attributes

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

Members list

Type members

Classlikes

class Context[FMT]

Provides the context for a single render operation.

Provides the context for a single render operation.

Value parameters

currentElement

the element currently being rendered

indentation

the indentation mechanism to use for rendering

messageFilter

the filter to apply before rendering runtime messages

parents

the stack of parent elements of this formatter in recursive rendering, with the root element being the last in the list

path

the (virtual) path the output will be rendered to

pathTranslator

translates paths of input documents to the corresponding output path

renderChild

a render function to use for rendering the children of an element

styles

the styles the new renderer should apply to the rendered elements

Attributes

Source
Formatter.scala
Supertypes
class Object
trait Matchable
class Any
case class Indentation(currentLevel: Int, numSpaces: Int, dotted: Boolean)

Represents the current indentation level of a formatter instance.

Represents the current indentation level of a formatter instance.

Value parameters

currentLevel

the level of indentation (number of characters)

dotted

indicates whether the indentation happens with a dot pattern or with just whitespace

numSpaces

the number of space characters to add when creating the next level of indentation from this instance

Attributes

Companion
object
Source
Formatter.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Indentation

Default Indentation instances.

Default Indentation instances.

Attributes

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

Value members

Concrete methods

The most basic formatter implementation & API.

The most basic formatter implementation & API.

Use TagFormatter for all outputs with angle brackets (e.g. HTML).

Attributes

Source
Formatter.scala