Trait

laika.config

RenderConfigBuilder

Related Doc: package config

Permalink

trait RenderConfigBuilder[Writer] extends OperationConfigBuilder

API for specifying configuration options that apply to all kinds of operations that contain a rendering step (Render and Transform APIs).

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RenderConfigBuilder
  2. OperationConfigBuilder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type ThisType

    Permalink

    The type of the operation being configured by this instance

    The type of the operation being configured by this instance

    Definition Classes
    OperationConfigBuilder

Abstract Value Members

  1. abstract def config: OperationConfig

    Permalink

    The current configuration for this instance.

    The current configuration for this instance.

    Definition Classes
    OperationConfigBuilder
  2. abstract def format: RenderFormat[Writer]

    Permalink
    Attributes
    protected
  3. abstract def withConfig(newConfig: OperationConfig): ThisType

    Permalink

    Returns a new instance with the specified configuration.

    Returns a new instance with the specified configuration.

    This method discards any previously specified options. It is usually meant to be used when copying over the configuration from a fully configured object to an unconfigured one.

    Definition Classes
    OperationConfigBuilder

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. def inParallel(parallelism: Int, threshold: Int): ThisType

    Permalink

    Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the specified level of parallelism.

    Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the specified level of parallelism.

    The recursive structure of document trees will be flattened before parsing and rendering and then get reassembled afterwards, therefore the parallel processing includes all subtrees of the document tree.

    The actual transformation is a three phase process, the first (parsing) and third (rendering) can run in parallel. The second phase in the middle cannot, as this is the document tree model rewrite step where things like cross references or table of contents get processed that need access to more than just the current document.

    parallelism

    the number of batches to be executed in parallel, 1 means sequential execution

    threshold

    the minimum number of operations required for parallel execution

    Definition Classes
    OperationConfigBuilder
  12. def inParallel: ThisType

    Permalink

    Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the default level of parallelism which corresponds to the number of CPUs.

    Instructs the parser and/or renderer to process all inputs and outputs in parallel, with the default level of parallelism which corresponds to the number of CPUs.

    The recursive structure of document trees will be flattened before parsing and rendering and then get reassembled afterwards, therefore the parallel processing includes all subtrees of the document tree.

    The actual transformation is a three phase process, the first (parsing) and third (rendering) can run in parallel. The second phase in the middle cannot, as this is the document tree model rewrite step where things like cross references or table of contents get processed that need access to more than just the current document.

    Definition Classes
    OperationConfigBuilder
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. def rendering(customRenderer: (Writer) ⇒ RenderFunction): ThisType

    Permalink

    Specifies a custom render function that overrides one or more of the default renderers for the output format this instance uses.

    Specifies a custom render function that overrides one or more of the default renderers for the output format this instance uses.

    This method expects a function that returns a partial function as the result. The outer function allows to capture the writer instance to write to and will only be invoked once. The partial function will then be invoked for each element it is defined at.

    Simple example for customizing the HTML output for emphasized text, adding a specific style class:

    Transform from Markdown to HTML rendering { out =>
      { case Emphasized(content) => out << """<em class="big">""" << content << "</em>" }
    } fromFile "hello.md" toFile "hello.html"
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  20. def unformatted: ThisType

    Permalink

    Renders without any formatting (line breaks or indentation).

    Renders without any formatting (line breaks or indentation). Useful when storing the output in a database for example.

  21. def using(bundles: ExtensionBundle*): ThisType

    Permalink

    Returns a new instance with the specified extension bundles installed.

    Returns a new instance with the specified extension bundles installed. Features in the new bundles may override features in already installed bundles.

    Bundles are usually provided by libraries (by Laika itself or a 3rd-party extension library) or as re-usable building blocks by application code.

    Definition Classes
    OperationConfigBuilder
  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def withMessageLevel(level: MessageLevel): ThisType

    Permalink

    Specifies the minimum required level for a system message to get included into the output by this renderer.

Inherited from OperationConfigBuilder

Inherited from AnyRef

Inherited from Any

Ungrouped