Package

laika

config

Permalink

package config

Visibility
  1. Public
  2. All

Type Members

  1. case class BundleFilter(strict: Boolean = false, acceptRawContent: Boolean = false) extends (ExtensionBundle) ⇒ Boolean with Product with Serializable

    Permalink

    A filter that might deactivate or activate some of the bundles based on user configuration.

    A filter that might deactivate or activate some of the bundles based on user configuration.

    strict

    indicates that text markup should be interpreted as defined by its specification, without any extensions

    acceptRawContent

    indicates that the users accepts the inclusion of raw content in text markup

  2. case class OperationConfig(bundles: Seq[ExtensionBundle] = Nil, bundleFilter: BundleFilter = BundleFilter(), minMessageLevel: MessageLevel = MessageLevel.Fatal, renderFormatted: Boolean = true, parallelConfig: ParallelConfig = ParallelConfig.sequential) extends RenderConfig with Product with Serializable

    Permalink

    Represents the configuration for an operation based on extension bundles and several flags.

    Represents the configuration for an operation based on extension bundles and several flags.

    Provides convenient access to the result of merging the defined bundles and adding fallback options wherever necessary.

    bundles

    all extension bundles defined by this operation

    bundleFilter

    a filter that might deactivate some of the bundles based on user configuration

    minMessageLevel

    specifies the minimum required level for a system message to get included into the output by a renderer

    renderFormatted

    indicates whether rendering should include any formatting (line breaks or indentation)

  3. trait OperationConfigBuilder extends AnyRef

    Permalink

    Base API for specifying configuration options that apply to all kinds of operations (Parse, Render and Transform).

  4. case class ParallelConfig(parallelism: Int, threshold: Int) extends Product with Serializable

    Permalink

    Configuration for parallel execution of parse and render operations.

    Configuration for parallel execution of parse and render operations.

    parallelism

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

    threshold

    the minimum number of operations required for parallel execution

  5. trait ParseConfigBuilder extends OperationConfigBuilder

    Permalink

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

  6. trait RenderConfig extends AnyRef

    Permalink

    Represents the subset of OperationConfig relevant for renderers.

  7. trait RenderConfigBuilder[Writer] extends OperationConfigBuilder

    Permalink

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

  8. trait TransformConfigBuilder[Writer] extends ParseConfigBuilder with RenderConfigBuilder[Writer]

    Permalink

    API for specifying configuration options that apply to all kinds of operations that contain both, a parsing and a rendering step (only Transform API).

Value Members

  1. object OperationConfig extends Serializable

    Permalink

    Provides OperationConfig instances and a utility for merging bundles.

  2. object ParallelConfig extends Serializable

    Permalink

    Default configurations for parallel and sequential execution.

Ungrouped