Type Members

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

   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.  trait CommonBuilderOps extends AnyRef

   Base API for specifying configuration options that apply to all kinds of operations (Parser, Renderer and Transformer).

3.  case class OperationConfig(bundles: Seq[ExtensionBundle] = Nil, bundleFilter: BundleFilter = BundleFilter(), configBuilder: ConfigBuilder = ConfigBuilder.empty, failOnMessages: MessageFilter = MessageFilter.Error, renderMessages: MessageFilter = MessageFilter.None, renderFormatted: Boolean = true) extends RenderConfig with Product with Serializable

   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

   configBuilder

   a builder for assembling values for the base configuration as

   failOnMessages

   the filter to apply to runtime messages that should cause the transformation to fail

   renderMessages

   the filter to apply to runtime messages that should be rendered in the output

   renderFormatted

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

4.  class ParserBuilder extends ParserBuilderOps

   Builder API for Parser instances.

   Builder API for Parser instances.

   Allows to add ExtensionBundles and the strict and withRawContent flags.

5.  trait ParserBuilderOps extends CommonBuilderOps

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

6.  trait RenderConfig extends AnyRef

   Represents the subset of OperationConfig relevant for renderers.

7.  class RendererBuilder[FMT] extends RendererBuilderOps[FMT]

   Builder API for Renderer instances.

   Builder API for Renderer instances.

   Allows to add ExtensionBundles, to override the renderer for specific elements and other options.

   FMT

   the formatter API to use which varies depending on the renderer

8.  trait RendererBuilderOps[FMT] extends CommonBuilderOps

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

9.  class TransformerBuilder[FMT] extends TransformerBuilderOps[FMT]

   Builder API for Transformer instances.

   Builder API for Transformer instances.

   Allows to add ExtensionBundles, to register AST rewrite rules, to override the renderer for specific elements and other options.

   FMT

   the formatter API to use which varies depending on the renderer

10.  trait TransformerBuilderOps[FMT] extends ParserBuilderOps with RendererBuilderOps[FMT]

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

11.  class TwoPhaseRendererBuilder[FMT, PP] extends RendererBuilderOps[FMT]

    Builder API for Renderer instances.

    Builder API for Renderer instances.

    Allows to add ExtensionBundles, to override the renderer for specific elements and other options.

    FMT

    the formatter API to use which varies depending on the renderer

    PP

    the type of the post processor

12.  class TwoPhaseTransformerBuilder[FMT, PP] extends TransformerBuilderOps[FMT]

    Builder API for Transformer instances.

    Builder API for Transformer instances.

    Allows to add ExtensionBundles, to register AST rewrite rules, to override the renderer for specific elements and other options.

    FMT

    the formatter API to use which varies depending on the renderer

    PP

    the type of the post processor