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.

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)

Linear Supertypes
Serializable, Serializable, Product, Equals, RenderConfig, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OperationConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RenderConfig
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new OperationConfig(bundles: Seq[ExtensionBundle] = Nil, bundleFilter: BundleFilter = BundleFilter(), configBuilder: ConfigBuilder = ConfigBuilder.empty, failOnMessages: MessageFilter = MessageFilter.Error, renderMessages: MessageFilter = MessageFilter.None, renderFormatted: Boolean = true)

    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)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. lazy val baseConfig: Config

    Base configuration merged from all defined extension bundles that serves as a fallback for configuration files in the source directories and/or config headers in markup and template documents.

  6. val bundleFilter: BundleFilter
  7. val bundles: Seq[ExtensionBundle]
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. val configBuilder: ConfigBuilder
  10. lazy val configProvider: ConfigProvider

    Provides the parser for configuration documents and configuration headers in text markup and template documents.

    Provides the parser for configuration documents and configuration headers in text markup and template documents. Always produces an empty configuration if no provider was installed.

  11. lazy val docTypeMatcher: (Path) ⇒ DocumentType

    Specifies the function to use for determining the document type of the input based on its path.

    Specifies the function to use for determining the document type of the input based on its path. The function represents the result of merging the partial functions from all defined bundles and adding a fallback (the Ignored document type) for all unhandled Path instances.

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. val failOnMessages: MessageFilter
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def forRawContent: OperationConfig

    Creates a new instance that is configured to allow raw content embedded in the host markup language.

    Creates a new instance that is configured to allow raw content embedded in the host markup language.

    These are disabled by default as Laika is designed to render to multiple output formats from a single input document. With raw content embedded the markup document is tied to a specific output format.

    Technically it activates all bundle instances which have the acceptRawContent flag set to true.

  16. def forStrictMode: OperationConfig

    Creates a new instance that is configured to interpret text markup as defined by its specification, without any extensions.

    Creates a new instance that is configured to interpret text markup as defined by its specification, without any extensions. Technically this will exclude all bundles that do not have the useInStrictMode flag set.

  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. lazy val markupExtensions: MarkupExtensions

    Provides all extensions for the text markup parser extracted from all defined bundles.

  20. def merge(other: OperationConfig): OperationConfig

    Merges the extension bundles and setting of this configuration with the specified other configuration.

    Merges the extension bundles and setting of this configuration with the specified other configuration. Alternative settings defined in this instance will have precedence.

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. val renderFormatted: Boolean

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

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

    Definition Classes
    OperationConfigRenderConfig
  25. val renderMessages: MessageFilter

    The filter to apply to runtime messages that should get rendered to the output.

    The filter to apply to runtime messages that should get rendered to the output.

    Definition Classes
    OperationConfigRenderConfig
  26. def renderOverridesFor[FMT](format: RenderFormat[FMT]): Overrides

    Provides the overrides for the specified render format.

  27. def rewriteRulesFor(doc: Document): ConfigResult[RewriteRules]

    The combined rewrite rule for the specified document, obtained by merging the rewrite rules defined in all bundles.

    The combined rewrite rule for the specified document, obtained by merging the rewrite rules defined in all bundles. This combined rule gets applied to the document between parse and render operations.

  28. def rewriteRulesFor(root: DocumentTreeRoot): RewriteRulesBuilder

    The combined rewrite rule, obtained by merging the rewrite rules defined in all bundles.

    The combined rewrite rule, obtained by merging the rewrite rules defined in all bundles. This combined rule gets applied to the document between parse and render operations.

  29. lazy val slugBuilder: (String) ⇒ String

    Function that receives the text of a headline, the name of a document or directory or a manually assigned identifier, and builds a slug from it that becomes part of the final URL or identifier (depending on output format).

    Function that receives the text of a headline, the name of a document or directory or a manually assigned identifier, and builds a slug from it that becomes part of the final URL or identifier (depending on output format).

    The result of the function must be:

    - a valid identifier in HTML and XML - a valid path segment in a URL - a valid file name

  30. lazy val styleSheetParser: Parser[Set[StyleDeclaration]]

    Provides the parser for CSS documents, obtained by merging the parsers defined in all extension bundles and adding a fallback that produces an empty style declaration set if all other parsers fail (or none are defined).

  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. lazy val templateParser: Option[Parser[TemplateRoot]]

    Provides the parser for template documents, obtained by merging the parsers defined in all extension bundles (or none if no bundle defines a parser).

    Provides the parser for template documents, obtained by merging the parsers defined in all extension bundles (or none if no bundle defines a parser). This method does not provide a fallback parser as the lack of any defined parser indicates that templates are not supported for this operation. The parse operation should therefore ignore all template documents in the input tree and use a fallback template.

  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  36. def withBundles(bundles: Seq[ExtensionBundle]): OperationConfig

    Returns a new instance with the specified extension bundles added to the bundles defined in this instance.

    Returns a new instance with the specified extension bundles added to the bundles defined in this instance. The new bundles are treated with higher precedence that the already defined bundles and may thus overwrite features.

  37. def withBundlesFor(parser: MarkupFormat): OperationConfig

    Returns a new instance with the extension bundles provided by the specified markup parser added to the bundles defined in this instance.

  38. def withConfigValue[T](key: Key, value: T)(implicit encoder: ConfigEncoder[T]): OperationConfig

    Returns a new instance with the specified configuration value added.

    Returns a new instance with the specified configuration value added.

    The specified value with have higher precedence than any value with the same key registered by extension bundles, but lower precedence than any value with the same key specified in a configuration file for a directory or a configuration header in a markup document.

  39. def withConfigValue[T](key: String, value: T)(implicit encoder: ConfigEncoder[T]): OperationConfig

    Returns a new instance with the specified configuration value added.

    Returns a new instance with the specified configuration value added.

    The specified value with have higher precedence than any value with the same key registered by extension bundles, but lower precedence than any value with the same key specified in a configuration file for a directory or a configuration header in a markup document.

  40. def withConfigValue[T](value: T)(implicit arg0: ConfigEncoder[T], arg1: DefaultKey[T]): OperationConfig

    Returns a new instance with the specified configuration value added.

    Returns a new instance with the specified configuration value added.

    The specified value with have higher precedence than any value with the same key registered by extension bundles, but lower precedence than any value with the same key specified in a configuration file for a directory or a configuration header in a markup document.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RenderConfig

Inherited from AnyRef

Inherited from Any

Ungrouped